Navigation

phoenix_title wx.SplitterEvent

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.

^^

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.SplitterEvent parameter.

  • EVT_SPLITTER_SASH_POS_CHANGING: The sash position is in the process of being changed. May be used to 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 wxEVT_SPLITTER_SASH_POS_CHANGING event.

  • EVT_SPLITTER_SASH_POS_CHANGED: The sash position was changed. May be used to modify the sash position before it is set, or to prevent the change from taking place. Processes a wxEVT_SPLITTER_SASH_POS_CHANGED event.

  • EVT_SPLITTER_UNSPLIT: The splitter has been just unsplit. Processes a wxEVT_SPLITTER_UNSPLIT event.

  • EVT_SPLITTER_DCLICK: 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). Processes a wxEVT_SPLITTER_DOUBLECLICKED event. ^^

See also

wx.SplitterWindow, Events and Event Handling


class_hierarchy Class Hierarchy

Inheritance diagram for class SplitterEvent:

method_summary Methods Summary

__init__

Constructor.

GetOldSize

Returns the old size before the update.

GetSashPosition

Returns the new sash position.

GetWindowBeingRemoved

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

GetX

Returns the x coordinate of the double-click point.

GetY

Returns the y coordinate of the double-click point.

SetSashPosition

In the case of wxEVT_SPLITTER_SASH_POS_CHANGED events, sets the new sash position.

SetSize

Sets the size values of the window size.

property_summary Properties Summary

OldSize

See GetOldSize

SashPosition

See GetSashPosition and SetSashPosition

WindowBeingRemoved

See GetWindowBeingRemoved

X

See GetX

Y

See GetY

api Class API

class wx.SplitterEvent(NotifyEvent)

Possible constructors:

SplitterEvent(eventType=wxEVT_NULL, splitter=None)

This class represents the events generated by a splitter control.


Methods

__init__(self, eventType=wxEVT_NULL, splitter=None)

Constructor.

Used internally by wxWidgets only.

Parameters:

GetOldSize(self)

Returns the old size before the update.

The size value is already adjusted to the orientation of the sash. So for a vertical sash it’s the width and for a horizontal sash it’s the height.

May only be called while processing wxEVT_SPLITTER_SASH_POS_CHANGING , wxEVT_SPLITTER_SASH_POS_RESIZE and wxEVT_SPLITTER_SASH_POS_CHANGED events. May only be called while processing wxEVT_SPLITTER_SASH_POS_CHANGING , wxEVT_SPLITTER_SASH_POS_RESIZE and wxEVT_SPLITTER_SASH_POS_CHANGED events.

Return type:

int

New in version 4.1/wxWidgets-3.1.6: Returns the new size which is set after the update. The size value is already adjusted to the orientation of the sash. So for a vertical sash it’s the width and for a horizontal sash it’s the height.

New in version 4.1/wxWidgets-3.1.6.


GetSashPosition(self)

Returns the new sash position.

May only be called while processing wxEVT_SPLITTER_SASH_POS_CHANGING , wxEVT_SPLITTER_SASH_POS_RESIZE and wxEVT_SPLITTER_SASH_POS_CHANGED events.

Return type:

int


GetWindowBeingRemoved(self)

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

May only be called while processing wxEVT_SPLITTER_UNSPLIT events.

Return type:

wx.Window


GetX(self)

Returns the x coordinate of the double-click point.

May only be called while processing wxEVT_SPLITTER_DOUBLECLICKED events.

Return type:

int


GetY(self)

Returns the y coordinate of the double-click point.

May only be called while processing wxEVT_SPLITTER_DOUBLECLICKED events.

Return type:

int


SetSashPosition(self, pos)

In the case of wxEVT_SPLITTER_SASH_POS_CHANGED events, sets the new sash position.

In the case of wxEVT_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 wxEVT_SPLITTER_SASH_POS_CHANGING , wxEVT_SPLITTER_SASH_POS_RESIZE and wxEVT_SPLITTER_SASH_POS_CHANGED events.

Parameters:

pos (int) – New sash position.


SetSize(self, oldSize, newSize)

Sets the size values of the window size.

This size is adjusted to the sash orientation. For a vertical sash it should be the width and for a horizontal sash it’s the height.

May only be called while processing wxEVT_SPLITTER_SASH_POS_CHANGING , wxEVT_SPLITTER_SASH_POS_RESIZE and wxEVT_SPLITTER_SASH_POS_CHANGED events.

Parameters:

  • oldSize (int) –

  • newSize (int) –

New in version 4.1/wxWidgets-3.1.6.


Properties

OldSize

See GetOldSize


SashPosition

See GetSashPosition and SetSashPosition


WindowBeingRemoved

See GetWindowBeingRemoved


X

See GetX


Y

See GetY