wx.SashEvent

Inheritance diagram for wx.SashEvent:



Description

A sash event is sent when the sash of a wx.SashWindow has been dragged by the user.

See also

wx.SashWindow

Remarks

When a sash belonging to a sash window is dragged by the user, and then released, this event is sent to the window, where it may be processed by an event table entry in a derived class, a plug-in event handler or an ancestor class.

Note

Note that the wx.SashWindow doesn’t change the window’s size itself. It relies on the application’s event handler to do that. This is because the application may have to handle other consequences of the resize, or it may wish to veto it altogether. The event handler should look at the drag rectangle: see GetDragRect to see what the new size of the window would be if the resize were to be applied. It should also call GetDragStatus to see whether the drag was OK or out of the current allowed range.

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.

Properties Summary

Class API

Methods

__init__(id=0, edge=wx.SASH_NONE)

Constructor.

Parameters:

  • id (int)
  • edge (int)

Returns:

wx.SashEvent


GetDragRect()

Returns the rectangle representing the new size the window would be if the resize was applied. It is up to the application to set the window size if required.


Returns:

wx.Rect


GetDragStatus()

Returns the status of the sash: one of wx.SASH_STATUS_OK, wx.SASH_STATUS_OUT_OF_RANGE.

If the drag caused the notional bounding box of the window to flip over, for example, the drag will be out of range.


Returns:

int


GetEdge()

Returns the dragged edge. The return value is one of wx.SASH_TOP, wx.SASH_RIGHT, wx.SASH_BOTTOM, wx.SASH_LEFT.


Returns:

int


SetDragRect(rect)

Parameters:


SetDragStatus(status)

Parameters:

  • status (int)

SetEdge(edge)

Parameters:

  • edge (int)

Properties

DragRect
See GetDragRect and SetDragRect
DragStatus
See GetDragStatus and SetDragStatus
Edge
See GetEdge and SetEdge