*************
wx.SashWindow
*************

Inheritance diagram for `wx.SashWindow`:

|

.. inheritance-diagram:: wx.SashWindow

|

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

`wx.SashWindow` allows any of its edges to have a sash which can be dragged to resize the window. The actual content window will be 
created by the application as a child of `wx.SashWindow`. 

The window (or an ancestor) will be notified of a drag via a `wx.SashEvent <../Events/wx.SashEvent.html>`_ notification.


.. seealso:: `wx.SashEvent <../Events/wx.SashEvent.html>`_, `wx.SashLayoutWindow <wx.SashLayoutWindow.html>`_


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

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


Known Subclasses
^^^^^^^^^^^^^^^^

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


Window Styles
^^^^^^^^^^^^^

==================================================  ==================================================  
Window Style                                        Description
==================================================  ==================================================  
``wx.SW_3D``                                        Draws a 3D effect sash and border.
``wx.SW_3DSASH``                                    Draws a 3D effect sash.
``wx.SW_3DBORDER``                                  Draws a 3D effect border.
``wx.SW_BORDER``                                    Draws a thin black border.
==================================================  ==================================================  


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

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.EVT_SASH_DRAGGED(id, func)                       Process a ``wx.wxEVT_SASH_DRAGGED`` event, when the user has finished dragging a sash.
wx.EVT_SASH_DRAGGED_RANGE(id1, id2, func)           Process a ``wx.wxEVT_SASH_DRAGGED_RANGE`` event, when the user has finished dragging a sash. The event handler is called when windows with ids in the given range have their sashes dragged.
==================================================  ==================================================  

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

* `__init__ <#__init__>`_ 
* `GetDefaultBorderSize <#GetDefaultBorderSize>`_ 
* `GetEdgeMargin <#GetEdgeMargin>`_ 
* `GetExtraBorderSize <#GetExtraBorderSize>`_ 
* `GetMaximumSizeX <#GetMaximumSizeX>`_ 
* `GetMaximumSizeY <#GetMaximumSizeY>`_ 
* `GetMinimumSizeX <#GetMinimumSizeX>`_ 
* `GetMinimumSizeY <#GetMinimumSizeY>`_ 
* `GetSashVisible <#GetSashVisible>`_ 
* `HasBorder <#HasBorder>`_ 
* `SashHitTest <#SashHitTest>`_ 
* `SetDefaultBorderSize <#SetDefaultBorderSize>`_ 
* `SetExtraBorderSize <#SetExtraBorderSize>`_ 
* `SetMaximumSizeX <#SetMaximumSizeX>`_ 
* `SetMaximumSizeY <#SetMaximumSizeY>`_ 
* `SetMinimumSizeX <#SetMinimumSizeX>`_ 
* `SetMinimumSizeY <#SetMinimumSizeY>`_ 
* `SetSashBorder <#SetSashBorder>`_ 
* `SetSashVisible <#SetSashVisible>`_ 
* `SizeWindows <#SizeWindows>`_ 

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

* `DefaultBorderSize <#DefaultBorderSize>`_ 
* `ExtraBorderSize <#ExtraBorderSize>`_ 
* `MaximumSizeX <#MaximumSizeX>`_ 
* `MaximumSizeY <#MaximumSizeY>`_ 
* `MinimumSizeX <#MinimumSizeX>`_ 
* `MinimumSizeY <#MinimumSizeY>`_ 

Class API
=========

Methods
^^^^^^^


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

   Constructs a sash 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.SashWindow <wx.SashWindow.html>`_
 

--------

.. method:: GetDefaultBorderSize()

   `No docstrings available for this method.` 

--------


.. method:: GetEdgeMargin(edge)

   |
   
   **Parameters:**

   * `edge` (int)

   |

   **Returns:**

   `int` 

--------

.. method:: GetExtraBorderSize()

   `No docstrings available for this method.` 

--------


.. method:: GetMaximumSizeX()

   Gets the maximum window size in the x direction.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetMaximumSizeY()

   Gets the maximum window size in the y direction.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetMinimumSizeX()

   Gets the minimum window size in the x direction.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetMinimumSizeY()

   Gets the minimum window size in the y direction.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetSashVisible(edge)

   Returns ``True`` if a sash is visible on the given edge, ``False`` otherwise.

   **Parameters:**

   * `edge` (int): Edge. One of ``wx.SASH_TOP``, ``wx.SASH_RIGHT``, ``wx.SASH_BOTTOM``, ``wx.SASH_LEFT``.

   |  

   **Returns:**

   `bool` 


.. seealso:: `SetSashVisible <#SetSashVisible>`_
  

--------

.. method:: HasBorder(edge)

   Returns ``True`` if the sash has a border, ``False`` otherwise. 

   **Parameters:**

   * `edge` (int): Edge. One of ``wx.SASH_TOP``, ``wx.SASH_RIGHT``, ``wx.SASH_BOTTOM``, ``wx.SASH_LEFT``.

   |  

   **Returns:**

   `bool` 


.. warning:: This function is obsolete since the sash border property is unused.

.. seealso:: `SetSashBorder <#SetSashBorder>`_
  

--------

.. method:: SashHitTest(x, y, tolerance=2)

   |
   
   **Parameters:**

   * `x` (int)
   * `y` (int)
   * `tolerance` (int)

   |

   **Returns:**

   `int` 

--------

.. method:: SetDefaultBorderSize(width)

   |
   
   **Parameters:**

   * `width` (int)

--------

.. method:: SetExtraBorderSize(width)

   |
   
   **Parameters:**

   * `width` (int)

--------

.. method:: SetMaximumSizeX(max)

   Sets the maximum window size in the x direction.

   **Parameters:**

   * `max` (int) 

--------

.. method:: SetMaximumSizeY(max)

   Sets the maximum window size in the y direction.

   **Parameters:**

   * `max` (int) 

--------

.. method:: SetMinimumSizeX(min)

   Sets the minimum window size in the x direction.

   **Parameters:**

   * `min` (int) 

--------

.. method:: SetMinimumSizeY(min)

   Sets the minimum window size in the y direction.

   **Parameters:**

   * `min` (int) 

--------

.. method:: SetSashBorder(edge, hasBorder)

   Call this function to give the sash a border, or remove the border. 

   **Parameters:**

   * `edge` (int): Edge to change. One of ``wx.SASH_TOP``, ``wx.SASH_RIGHT``, ``wx.SASH_BOTTOM``, ``wx.SASH_LEFT``.
   * `hasBorder` (bool): ``True`` to give the sash a border visible, ``False`` to remove it.


.. warning:: This function is obsolete since the sash border property is unused.


--------

.. method:: SetSashVisible(edge, visible)

   Call this function to make a sash visible or invisible on a particular edge.

   **Parameters:**

   * `edge` (int): Edge to change. One of ``wx.SASH_TOP``, ``wx.SASH_RIGHT``, ``wx.SASH_BOTTOM``, ``wx.SASH_LEFT``.
   * `visible` (bool): ``True`` to make the sash visible, ``False`` to make it invisible.


.. seealso:: `GetSashVisible <#GetSashVisible>`_
  

--------

.. method:: SizeWindows()

   `No docstrings available for this method.` 

--------


Properties
^^^^^^^^^^


.. attribute:: DefaultBorderSize

   See `GetDefaultBorderSize <#GetDefaultBorderSize>`_ and `SetDefaultBorderSize <#SetDefaultBorderSize>`_

.. attribute:: ExtraBorderSize

   See `GetExtraBorderSize <#GetExtraBorderSize>`_ and `SetExtraBorderSize <#SetExtraBorderSize>`_

.. attribute:: MaximumSizeX

   See `GetMaximumSizeX <#GetMaximumSizeX>`_ and `SetMaximumSizeX <#SetMaximumSizeX>`_

.. attribute:: MaximumSizeY

   See `GetMaximumSizeY <#GetMaximumSizeY>`_ and `SetMaximumSizeY <#SetMaximumSizeY>`_

.. attribute:: MinimumSizeX

   See `GetMinimumSizeX <#GetMinimumSizeX>`_ and `SetMinimumSizeX <#SetMinimumSizeX>`_

.. attribute:: MinimumSizeY

   See `GetMinimumSizeY <#GetMinimumSizeY>`_ and `SetMinimumSizeY <#SetMinimumSizeY>`_