wxRuby Documentation Home

# Wx::QueryLayoutInfoEvent

This event is sent when LayoutAlgorithm wishes to get
the size, orientation and alignment of a window. More precisely, the event is sent
by the OnCalculateLayout handler which is itself invoked by LayoutAlgorithm.

## Derived from

Event

Object

## Event table macros

evt_query_layout_info() { | event | … } | Process a EVT_QUERY_LAYOUT_INFO event,to get size, orientation and alignment from a window.

## Data structures

enum LayoutOrientation { LAYOUT_HORIZONTAL, LAYOUT_VERTICAL }; enum LayoutAlignment { LAYOUT_NONE, LAYOUT_TOP, LAYOUT_LEFT, LAYOUT_RIGHT, LAYOUT_BOTTOM, };

## See also

CalculateLayoutEvent, SashLayoutWindow, LayoutAlgorithm.

## Methods

- QueryLayoutInfoEvent.new
- QueryLayoutInfoEvent#get_alignment
- QueryLayoutInfoEvent#get_flags
- QueryLayoutInfoEvent#get_orientation
- QueryLayoutInfoEvent#get_requested_length
- QueryLayoutInfoEvent#get_size
- QueryLayoutInfoEvent#set_alignment
- QueryLayoutInfoEvent#set_flags
- QueryLayoutInfoEvent#set_orientation
- QueryLayoutInfoEvent#set_requested_length
- QueryLayoutInfoEvent#set_size

### QueryLayoutInfoEvent.new

QueryLayoutInfoEvent.new(%(arg-type)Integer% id = 0)

Constructor.

### QueryLayoutInfoEvent#get_alignment

get_alignment()

Specifies the alignment of the window (which side of the remaining parent client area
the window sticks to). One of LAYOUT_TOP, LAYOUT_LEFT, LAYOUT_RIGHT, LAYOUT_BOTTOM.

### QueryLayoutInfoEvent#get_flags

Integer get_flags()

Returns the flags associated with this event. Not currently used.

### QueryLayoutInfoEvent#get_orientation

LayoutOrientation get_orientation()

Returns the orientation that the event handler specified to the event object. May be one of LAYOUT_HORIZONTAL,
LAYOUT_VERTICAL.

### QueryLayoutInfoEvent#get_requested_length

Integer get_requested_length()

Returns the requested length of the window in the direction of the window orientation. This information
is not yet used.

### QueryLayoutInfoEvent#get_size

Size get_size()

Returns the size that the event handler specified to the event object as being the requested size of the window.

### QueryLayoutInfoEvent#set_alignment

set_alignment(%(arg-type)LayoutAlignment% alignment)

Call this to specify the alignment of the window (which side of the remaining parent client area
the window sticks to). May be one of LAYOUT_TOP, LAYOUT_LEFT, LAYOUT_RIGHT, LAYOUT_BOTTOM.

### QueryLayoutInfoEvent#set_flags

set_flags(%(arg-type)Integer% flags)

Sets the flags associated with this event. Not currently used.

### QueryLayoutInfoEvent#set_orientation

set_orientation(%(arg-type)LayoutOrientation% orientation)

Call this to specify the orientation of the window. May be one of LAYOUT_HORIZONTAL,
LAYOUT_VERTICAL.

### QueryLayoutInfoEvent#set_requested_length

set_requested_length(%(arg-type)Integer% length)

Sets the requested length of the window in the direction of the window orientation. This information
is not yet used.

### QueryLayoutInfoEvent#set_size

set_size(%(arg-type)Size% size)

Call this to let the calling code know what the size of the window is.

[This page automatically generated from the Textile source at 2023-06-09 00:45:27 +0000]