*******************
wx.SashLayoutWindow
*******************

Inheritance diagram for `wx.SashLayoutWindow`:

|

.. inheritance-diagram:: wx.SashLayoutWindow

|

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

`wx.SashLayoutWindow` responds to `OnCalculateLayout` events generated by `wx.LayoutAlgorithm <wx.LayoutAlgorithm.html>`_. It allows the application 
to use simple accessors to specify how the window should be laid out, rather than having to respond to events. The fact that the class derives from 
`wx.SashWindow <wx.SashWindow.html>`_ allows sashes to be used if required, to allow the windows to be user-resizable.

The documentation for `wx.LayoutAlgorithm <wx.LayoutAlgorithm.html>`_ explains the purpose of this class in more detail.


.. seealso:: `wx.LayoutAlgorithm <wx.LayoutAlgorithm.html>`_, `wx.SashWindow <wx.SashWindow.html>`_


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

* `wx.SashWindow <wx.SashWindow.html>`_ 
* `wx.Window <wx.Window.html>`_ 
* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


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

This class handles the ``wx.EVT_QUERY_LAYOUT_INFO`` and ``wx.EVT_CALCULATE_LAYOUT`` events for you. However, if you use sashes, see `wx.SashWindow <wx.SashWindow.html>`_ 
for relevant event information.


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

* `__init__ <#__init__>`_ 
* `GetAlignment <#GetAlignment>`_ 
* `GetOrientation <#GetOrientation>`_ 
* `SetAlignment <#SetAlignment>`_ 
* `SetDefaultSize <#SetDefaultSize>`_ 
* `SetOrientation <#SetOrientation>`_ 

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

* `Alignment <#Alignment>`_ 
* `Orientation <#Orientation>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, id=-1, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLIP_CHILDREN|wx.SW_3D, name=wx.SashLayoutNameStr)

   Constructs a sash layout window, which can be a child of a frame, dialog or any other non-control window.

   **Parameters:**

   * `parent` (`wx.Window <wx.Window.html>`_)
   * `id` (int)
   * `pos` (`wx.Point <wx.Point.html>`_)
   * `size` (`wx.Size <wx.Size.html>`_)
   * `style` (long)
   * `name` (string)

   |

   **Returns:**

   `wx.SashLayoutWindow <wx.SashLayoutWindow.html>`_
 

--------

.. method:: GetAlignment()

   Returns the alignment of the window: one of ``wx.LAYOUT_TOP``, ``wx.LAYOUT_LEFT``, ``wx.LAYOUT_RIGHT``, ``wx.LAYOUT_BOTTOM``.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetOrientation()

   Returns the orientation of the window: one of ``wx.LAYOUT_HORIZONTAL``, ``wx.LAYOUT_VERTICAL``.

   |  

   **Returns:**

   `int` 

--------

.. method:: SetAlignment(alignment)

   Sets the alignment of the window (which edge of the available parent client area the window is attached to). `alignment` is one of 
   ``wx.LAYOUT_TOP``, ``wx.LAYOUT_LEFT``, ``wx.LAYOUT_RIGHT``, ``wx.LAYOUT_BOTTOM``.

   **Parameters:**

   * `alignment` (int) 

--------

.. method:: SetDefaultSize(size)

   Sets the default dimensions of the window. The dimension other than the orientation will be fixed to this value, and the orientation 
   dimension will be ignored and the window stretched to fit the available space.

   **Parameters:**

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

--------

.. method:: SetOrientation(orientation)

   Sets the orientation of the window (the direction the window will stretch in, to fill the available parent client area). `orientation` 
   is one of ``wx.LAYOUT_HORIZONTAL``, ``wx.LAYOUT_VERTICAL``.

   **Parameters:**

   * `orientation` (int) 

--------

Properties
^^^^^^^^^^


.. attribute:: Alignment

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

.. attribute:: Orientation

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