Navigation

Phoenix Logo

phoenix_title wx.adv.QueryLayoutInfoEvent

This event is sent when wx.adv.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 wx.adv.LayoutAlgorithm.

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.adv.QueryLayoutInfoEvent parameter.

  • EVT_QUERY_LAYOUT_INFO: Process a wxEVT_QUERY_LAYOUT_INFO event, to get size, orientation and alignment from a window.

See also

wx.adv.CalculateLayoutEvent, wx.adv.SashLayoutWindow, wx.adv.LayoutAlgorithm.


class_hierarchy Class Hierarchy

Inheritance diagram for class QueryLayoutInfoEvent:


method_summary Methods Summary

__init__ Constructor.
GetAlignment Specifies the alignment of the window (which side of the remaining parent client area the window sticks to).
GetFlags Returns the flags associated with this event.
GetOrientation Returns the orientation that the event handler specified to the event object.
GetRequestedLength Returns the requested length of the window in the direction of the window orientation.
GetSize Returns the size that the event handler specified to the event object as being the requested size of the window.
SetAlignment Call this to specify the alignment of the window (which side of the remaining parent client area the window sticks to).
SetFlags Sets the flags associated with this event.
SetOrientation Call this to specify the orientation of the window.
SetRequestedLength Sets the requested length of the window in the direction of the window orientation.
SetSize Call this to let the calling code know what the size of the window is.

api Class API


class wx.adv.QueryLayoutInfoEvent(Event)

Possible constructors:

QueryLayoutInfoEvent(id=0)

This event is sent when LayoutAlgorithm wishes to get the size, orientation and alignment of a window.


Methods


__init__(self, id=0)

Constructor.

Parameters:id (wx.WindowID) –

GetAlignment(self)

Specifies the alignment of the window (which side of the remaining parent client area the window sticks to).

One of wx.adv.LAYOUT_TOP, wx.adv.LAYOUT_LEFT, wx.adv.LAYOUT_RIGHT, wx.adv.LAYOUT_BOTTOM.

Return type: wx.adv.LayoutAlignment

GetFlags(self)

Returns the flags associated with this event.

Not currently used.

Return type:int

GetOrientation(self)

Returns the orientation that the event handler specified to the event object.

May be one of wx.adv.LAYOUT_HORIZONTAL, wx.adv.LAYOUT_VERTICAL.

Return type: wx.adv.LayoutOrientation

GetRequestedLength(self)

Returns the requested length of the window in the direction of the window orientation.

This information is not yet used.

Return type:int

GetSize(self)

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

Return type:Size

SetAlignment(self, 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 wx.adv.LAYOUT_TOP, wx.adv.LAYOUT_LEFT, wx.adv.LAYOUT_RIGHT, wx.adv.LAYOUT_BOTTOM.

Parameters:alignment (LayoutAlignment) –

SetFlags(self, flags)

Sets the flags associated with this event.

Not currently used.

Parameters:flags (int) –

SetOrientation(self, orientation)

Call this to specify the orientation of the window.

May be one of wx.adv.LAYOUT_HORIZONTAL, wx.adv.LAYOUT_VERTICAL.

Parameters:orientation (LayoutOrientation) –

SetRequestedLength(self, length)

Sets the requested length of the window in the direction of the window orientation.

This information is not yet used.

Parameters:length (int) –

SetSize(self, size)

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

Parameters:size (wx.Size) –

Properties


Alignment

See GetAlignment and SetAlignment


Flags

See GetFlags and SetFlags


Orientation

See GetOrientation and SetOrientation


RequestedLength

See GetRequestedLength and SetRequestedLength


Size

See GetSize and SetSize