wxQueryLayoutInfoEvent

This event is sent when wxLayoutAlgorithm 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 wxLayoutAlgorithm.

Derived from

wxEvent
wxObject

Include files

<wx/laywin.h>

Event table macros

EVT_QUERY_LAYOUT_INFO(func)

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

Data structures

enum wxLayoutOrientation {
    wxLAYOUT_HORIZONTAL,
    wxLAYOUT_VERTICAL
};

enum wxLayoutAlignment {
    wxLAYOUT_NONE,
    wxLAYOUT_TOP,
    wxLAYOUT_LEFT,
    wxLAYOUT_RIGHT,
    wxLAYOUT_BOTTOM,
};

See also

wxCalculateLayoutEvent, wxSashLayoutWindow, wxLayoutAlgorithm.

Members

wxQueryLayoutInfoEvent::wxQueryLayoutInfoEvent
wxQueryLayoutInfoEvent::GetAlignment
wxQueryLayoutInfoEvent::GetFlags
wxQueryLayoutInfoEvent::GetOrientation
wxQueryLayoutInfoEvent::GetRequestedLength
wxQueryLayoutInfoEvent::GetSize
wxQueryLayoutInfoEvent::SetAlignment
wxQueryLayoutInfoEvent::SetFlags
wxQueryLayoutInfoEvent::SetOrientation
wxQueryLayoutInfoEvent::SetRequestedLength
wxQueryLayoutInfoEvent::SetSize

wxQueryLayoutInfoEvent::wxQueryLayoutInfoEvent

wxQueryLayoutInfoEvent(wxWindowID id = 0)

Constructor.

wxQueryLayoutInfoEvent::GetAlignment

void GetAlignment() const

Specifies the alignment of the window (which side of the remaining parent client area the window sticks to). One of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.

wxQueryLayoutInfoEvent::GetFlags

int GetFlags() const

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

wxQueryLayoutInfoEvent::GetOrientation

wxLayoutOrientation GetOrientation() const

Returns the orientation that the event handler specified to the event object. May be one of wxLAYOUT_HORIZONTAL, wxLAYOUT_VERTICAL.

wxQueryLayoutInfoEvent::GetRequestedLength

int GetRequestedLength() const

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

wxQueryLayoutInfoEvent::GetSize

wxSize GetSize() const

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

wxQueryLayoutInfoEvent::SetAlignment

void SetAlignment(wxLayoutAlignment 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 wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.

wxQueryLayoutInfoEvent::SetFlags

void SetFlags(int flags)

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

wxQueryLayoutInfoEvent::SetOrientation

void SetOrientation(wxLayoutOrientation orientation)

Call this to specify the orientation of the window. May be one of wxLAYOUT_HORIZONTAL, wxLAYOUT_VERTICAL.

wxQueryLayoutInfoEvent::SetRequestedLength

void SetRequestedLength(int length)

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

wxQueryLayoutInfoEvent::SetSize

void SetSize(const wxSize& size)

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