wx.SashWindow

Inheritance diagram for 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 notification.

Known Subclasses

wx.SashLayoutWindow

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.

Class API

Methods

__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:


Returns:

wx.SashWindow


GetDefaultBorderSize()
No docstrings available for this method.

GetEdgeMargin(edge)

Parameters:

  • edge (int)

Returns:

int


GetExtraBorderSize()
No docstrings available for this method.

GetMaximumSizeX()

Gets the maximum window size in the x direction.


Returns:

int


GetMaximumSizeY()

Gets the maximum window size in the y direction.


Returns:

int


GetMinimumSizeX()

Gets the minimum window size in the x direction.


Returns:

int


GetMinimumSizeY()

Gets the minimum window size in the y direction.


Returns:

int


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

See also

SetSashVisible


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.

See also

SetSashBorder


SashHitTest(x, y, tolerance=2)

Parameters:

  • x (int)
  • y (int)
  • tolerance (int)

Returns:

int


SetDefaultBorderSize(width)

Parameters:

  • width (int)

SetExtraBorderSize(width)

Parameters:

  • width (int)

SetMaximumSizeX(max)

Sets the maximum window size in the x direction.

Parameters:

  • max (int)

SetMaximumSizeY(max)

Sets the maximum window size in the y direction.

Parameters:

  • max (int)

SetMinimumSizeX(min)

Sets the minimum window size in the x direction.

Parameters:

  • min (int)

SetMinimumSizeY(min)

Sets the minimum window size in the y direction.

Parameters:

  • min (int)

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.


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.

See also

GetSashVisible


SizeWindows()
No docstrings available for this method.

Properties

DefaultBorderSize
See GetDefaultBorderSize and SetDefaultBorderSize
ExtraBorderSize
See GetExtraBorderSize and SetExtraBorderSize
MaximumSizeX
See GetMaximumSizeX and SetMaximumSizeX
MaximumSizeY
See GetMaximumSizeY and SetMaximumSizeY
MinimumSizeX
See GetMinimumSizeX and SetMinimumSizeX
MinimumSizeY
See GetMinimumSizeY and SetMinimumSizeY