***********************
wx.CalculateLayoutEvent
***********************

Inheritance diagram for `wx.CalculateLayoutEvent`:

|

.. inheritance-diagram:: wx.CalculateLayoutEvent

|

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

This event is sent by `wx.LayoutAlgorithm <../Widgets/wx.LayoutAlgorithm.html>`_  to calculate the amount of the remaining client area that the window should occupy.

.. seealso:: `wx.QueryLayoutInfoEvent <wx.QueryLayoutInfoEvent.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_CALCULATE_LAYOUT(func)                       Process a ``wx.wxEVT_CALCULATE_LAYOUT`` event, which asks the window to take a 'bite' out of a rectangle provided by the algorithm. 
==================================================  ==================================================  


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

* `__init__ <#__init__>`_ 
* `GetFlags <#GetFlags>`_ 
* `GetRect <#GetRect>`_ 
* `SetFlags <#SetFlags>`_ 
* `SetRect <#SetRect>`_ 

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

* `Flags <#Flags>`_ 
* `Rect <#Rect>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(id=0)

   Constructor.

   **Parameters:**

   * `id` (int)

   |

   **Returns:**

   `wx.CalculateLayoutEvent <wx.CalculateLayoutEvent.html>`_
 

--------

.. method:: GetFlags()

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

   |

   **Returns:**

   `int` 

--------

.. method:: GetRect()

   Before the event handler is entered, returns the remaining parent client area that the window could occupy. 

   When the event handler returns, this should contain the remaining parent client rectangle, after the event handler has subtracted the area that its window occupies.

   |

   **Returns:**

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

--------

.. method:: SetFlags(flags)

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

   **Parameters:**

   * `flags` (int) 


--------

.. method:: SetRect(rect)

   Call this to specify the new remaining parent client area, after the space occupied by the window has been subtracted.

   **Parameters:**

   * `rect` (`wx.Rect <../Widgets/wx.Rect.html>`_) 


--------

Properties
^^^^^^^^^^


.. attribute:: Flags

   See `GetFlags <#GetFlags>`_ and `SetFlags <#SetFlags>`_
   
   
.. attribute:: Rect

   See `GetRect <#GetRect>`_ and `SetRect <#SetRect>`_