****************
wx.SplitterEvent
****************

Inheritance diagram for `wx.SplitterEvent`:

|

.. inheritance-diagram:: wx.SplitterEvent

|

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

This class represents the events generated by a splitter control. Also there is only one event class, the data associated to the different 
events is not the same and so not all accessor functions may be called for each event. The documentation mentions the kind of event(s) for 
which the given accessor function makes sense: calling it for other types of events will result in assert failure (in debug mode) and will return meaningless results.


.. seealso:: `wx.SplitterWindow <../Widgets/wx.SplitterWindow.html>`_


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

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


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

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.EVT_SPLITTER_SASH_POS_CHANGING(id, func)         The sash position is in the process of being changed. You may prevent this change from happening by calling `Veto <wx.NotifyEvent.html#Veto>`_ or you may also modify the position of the tracking bar to properly reflect the position that would be set if the drag were to be completed at this point. Processes a ``wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING`` event.  
wx.EVT_SPLITTER_SASH_POS_CHANGED(id, func)          The sash position was changed. This event is generated after the user releases the mouse after dragging the splitter. Processes a ``wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED`` event.  
wx.EVT_SPLITTER_UNSPLIT(id, func)                   The splitter has been just unsplit. Processes a ``wx.wxEVT_COMMAND_SPLITTER_UNSPLIT`` event. This event can't be vetoed.  
wx.EVT_SPLITTER_DCLICK(id, func)                    The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). This won't happen if you veto this event. Processes a ``wx.wxEVT_COMMAND_SPLITTER_DOUBLECLICKED`` event.  
==================================================  ==================================================  


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

* `__init__ <#__init__>`_ 
* `GetSashPosition <#GetSashPosition>`_ 
* `GetWindowBeingRemoved <#GetWindowBeingRemoved>`_ 
* `GetX <#GetX>`_ 
* `GetY <#GetY>`_ 
* `SetSashPosition <#SetSashPosition>`_ 

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

* `SashPosition <#SashPosition>`_ 
* `WindowBeingRemoved <#WindowBeingRemoved>`_ 
* `X <#X>`_ 
* `Y <#Y>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(type=wx.wxEVT_NULL, splitter=None)

   This class represents the events generated by a splitter control.
   
   **Parameters:**

   * `type` (eventtype)
   * `splitter` (`wx.SplitterWindow <../Widgets/wx.SplitterWindow.html>`_)

   |

   **Returns:**

   `wx.SplitterEvent <wx.SplitterEvent.html>`_
 

--------

.. method:: GetSashPosition()

   Returns the new sash position.

   May only be called while processing ``wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING`` and ``wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED`` events.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetWindowBeingRemoved()

   Returns a pointer to the window being removed when a splitter window is unsplit.

   May only be called while processing ``wx.wxEVT_COMMAND_SPLITTER_UNSPLIT`` events.

   |  

   **Returns:**

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

--------

.. method:: GetX()

   Returns the `x` coordinate of the double-click point.

   May only be called while processing ``wx.wxEVT_COMMAND_SPLITTER_DOUBLECLICKED`` events.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetY()

   Returns the `y` coordinate of the double-click point.

   May only be called while processing ``wx.wxEVT_COMMAND_SPLITTER_DOUBLECLICKED`` events.

   |  

   **Returns:**

   `int` 

--------

.. method:: SetSashPosition(pos)

   In the case of ``wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED`` events, sets the new sash position. In the case of ``wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING`` 
   events, sets the new tracking bar position so visual feedback during dragging will represent that change that will actually take place. 

   Set to -1 from the event handler code to prevent repositioning.

   May only be called while processing ``wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING`` and ``wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED`` events.

   **Parameters:**

   * `pos` (int): New sash position.

--------

Properties
^^^^^^^^^^


.. attribute:: SashPosition

   See `GetSashPosition <#GetSashPosition>`_ and `SetSashPosition <#SetSashPosition>`_

.. attribute:: WindowBeingRemoved

   See `GetWindowBeingRemoved <#GetWindowBeingRemoved>`_

.. attribute:: X

   See `GetX <#GetX>`_

.. attribute:: Y

   See `GetY <#GetY>`_