***********************
wx.QueryLayoutInfoEvent
***********************

Inheritance diagram for `wx.QueryLayoutInfoEvent`:

|

.. inheritance-diagram:: wx.QueryLayoutInfoEvent

|

Description
===========

This event is sent when `wx.LayoutAlgorithm <../Widgets/wx.LayoutAlgorithm.html>`_ 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.LayoutAlgorithm`.


.. seealso:: `wx.CalculateLayoutEvent <wx.CalculateLayoutEvent.html>`_, `wx.SashLayoutWindow <../Widgets/wx.SashLayoutWindow.html>`_, 
   `wx.LayoutAlgorithm <../Widgets/wx.LayoutAlgorithm.html>`_.


Derived From
^^^^^^^^^^^^^

* `wx.Event <wx.Event.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 


Event Handling
^^^^^^^^^^^^^^

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.EVT_QUERY_LAYOUT_INFO(func)                      Process a ``wx.wxEVT_QUERY_LAYOUT_INFO`` event, to get size, orientation and alignment from a window.  
==================================================  ==================================================  


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetAlignment <#GetAlignment>`_ 
* `GetFlags <#GetFlags>`_ 
* `GetOrientation <#GetOrientation>`_ 
* `GetRequestedLength <#GetRequestedLength>`_ 
* `GetSize <#GetSize>`_ 
* `SetAlignment <#SetAlignment>`_ 
* `SetFlags <#SetFlags>`_ 
* `SetOrientation <#SetOrientation>`_ 
* `SetRequestedLength <#SetRequestedLength>`_ 
* `SetSize <#SetSize>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Alignment <#Alignment>`_ 
* `Flags <#Flags>`_ 
* `Orientation <#Orientation>`_ 
* `RequestedLength <#RequestedLength>`_ 
* `Size <#Size>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(id=0)

   Constructor.

   **Parameters:**

   * `id` (int)

   |

   **Returns:**

   `wx.QueryLayoutInfoEvent <wx.QueryLayoutInfoEvent.html>`_
 

--------

.. method:: GetAlignment()

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

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

   |  

   **Returns:**

   `int` 

--------

.. method:: GetFlags()

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

   |  

   **Returns:**

   `int` 

--------

.. method:: GetOrientation()

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

   |  

   **Returns:**

   `int` 

--------

.. method:: GetRequestedLength()

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

   |  

   **Returns:**

   `int` 

--------

.. method:: GetSize()

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

   |  

   **Returns:**

   `wx.Size <../Widgets/wx.Size.html>`_
 

--------

.. method:: SetAlignment(alignment)

   Call this to specify the alignment of the window (which side of the remaining parent client area the window sticks to). 

   **Parameters:**

   * `alignment` (int): One of ``wx.LAYOUT_TOP``, ``wx.LAYOUT_LEFT``, ``wx.LAYOUT_RIGHT``, ``wx.LAYOUT_BOTTOM``.


--------

.. method:: SetFlags(flags)

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

   **Parameters:**

   * `flags` (int) 

--------

.. method:: SetOrientation(orientation)

   Call this to specify the orientation of the window.

   **Parameters:**

   * `orientation` (int): May be one of ``wx.LAYOUT_HORIZONTAL``, ``wx.LAYOUT_VERTICAL``.


--------

.. method:: SetRequestedLength(length)

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

   **Parameters:**

   * `length` (int) 

--------

.. method:: SetSize(size)

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

   **Parameters:**

   * `size` (`wx.Size <../Widgets/wx.Size.html>`_) 

--------

Properties
^^^^^^^^^^


.. attribute:: Alignment

   See `GetAlignment <#GetAlignment>`_ and `SetAlignment <#SetAlignment>`_

.. attribute:: Flags

   See `GetFlags <#GetFlags>`_ and `SetFlags <#SetFlags>`_

.. attribute:: Orientation

   See `GetOrientation <#GetOrientation>`_ and `SetOrientation <#SetOrientation>`_

.. attribute:: RequestedLength

   See `GetRequestedLength <#GetRequestedLength>`_ and `SetRequestedLength <#SetRequestedLength>`_

.. attribute:: Size

   See `GetSize <#GetSize>`_ and `SetSize <#SetSize>`_