wx.adv.SashWindow

wx.adv.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.adv.SashWindow.

The window (or an ancestor) will be notified of a drag via a wx.adv.SashEvent notification.

^^

Window Styles

This class supports the following styles:

• wx.adv.SW_3D: Draws a 3D effect sash and border.

• wx.adv.SW_3DSASH: Draws a 3D effect sash.

• wx.adv.SW_3DBORDER: Draws a 3D effect border.

• wx.adv.SW_BORDER: Draws a thin black border. ^^

^^

Events Emitted by this Class

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

• EVT_SASH_DRAGGED: Process a wxEVT_SASH_DRAGGED event, when the user has finished dragging a sash.

• EVT_SASH_DRAGGED_RANGE: Process a 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. ^^

See also

wx.adv.SashEvent, wx.adv.SashLayoutWindow, Events and Event Handling

Class Hierarchy

Inheritance diagram for class SashWindow:

Known Subclasses

wx.adv.SashLayoutWindow

Methods Summary

__init__	Default constructor.
GetClassDefaultAttributes
GetDefaultBorderSize	Gets the default sash border size.
GetEdgeMargin	Get border size.
GetExtraBorderSize	Gets the addition border size between child and sash window.
GetMaximumSizeX	Gets the maximum window size in the x direction.
GetMaximumSizeY	Gets the maximum window size in the y direction.
GetMinimumSizeX	Gets the minimum window size in the x direction.
GetMinimumSizeY	Gets the minimum window size in the y direction.
GetSashVisible	Returns True if a sash is visible on the given edge, False otherwise.
SashHitTest	Tests for x, y over sash.
SetDefaultBorderSize	Sets the default sash border size.
SetExtraBorderSize	Sets the additional border size between child and sash window.
SetMaximumSizeX	Sets the maximum window size in the x direction.
SetMaximumSizeY	Sets the maximum window size in the y direction.
SetMinimumSizeX	Sets the minimum window size in the x direction.
SetMinimumSizeY	Sets the minimum window size in the y direction.
SetSashVisible	Call this function to make a sash visible or invisible on a particular edge.
SizeWindows	Resizes subwindows.

Properties Summary

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

Class API

class wx.adv.SashWindow(Window)

Possible constructors:

SashWindow()

SashWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
           style=CLIP_CHILDREN|SW_3D, name="sashWindow")

SashWindow allows any of its edges to have a sash which can be dragged to resize the window.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

---

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=CLIP_CHILDREN|SW_3D, name=”sashWindow”)

Constructs a sash window, which can be a child of a frame, dialog or any other non-control window.

Parameters:

• parent (wx.Window) – Pointer to a parent window.

• id (wx.WindowID) – Window identifier. If -1, will automatically create an identifier.

• pos (wx.Point) – Window position. DefaultPosition is (-1, -1) which indicates that SashWindows should generate a default position for the window. If using the wx.adv.SashWindow class directly, supply an actual position.

• size (wx.Size) – Window size. DefaultSize is (-1, -1) which indicates that SashWindows should generate a default size for the window.

• style (long) – Window style. For window styles, please see wx.adv.SashWindow.

• name (string) – Window name.

---

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:

variant (WindowVariant) –

Return type:

VisualAttributes

---

GetDefaultBorderSize(self)

Gets the default sash border size.

Return type:

int

---

GetEdgeMargin(self, edge)

Get border size.

Parameters:

edge (SashEdgePosition) –

Return type:

int

---

GetExtraBorderSize(self)

Gets the addition border size between child and sash window.

Return type:

int

---

GetMaximumSizeX(self)

Gets the maximum window size in the x direction.

Return type:

int

---

GetMaximumSizeY(self)

Gets the maximum window size in the y direction.

Return type:

int

---

GetMinimumSizeX(self)

Gets the minimum window size in the x direction.

Return type:

int

---

GetMinimumSizeY(self)

Gets the minimum window size in the y direction.

Return type:

int

---

GetSashVisible(self, edge)

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

Parameters:

edge (SashEdgePosition) – Edge. One of wx.adv.SASH_TOP, wx.adv.SASH_RIGHT, wx.adv.SASH_BOTTOM, wx.adv.SASH_LEFT.

Return type:

bool

See also

SetSashVisible

---

SashHitTest(self, x, y, tolerance=2)

Tests for x, y over sash.

Parameters:

• x (int) –

• y (int) –

• tolerance (int) –

Return type:

wx.adv.SashEdgePosition

---

SetDefaultBorderSize(self, width)

Sets the default sash border size.

Parameters:

width (int) –

---

SetExtraBorderSize(self, width)

Sets the additional border size between child and sash window.

Parameters:

width (int) –

---

SetMaximumSizeX(self, min)

Sets the maximum window size in the x direction.

Parameters:

min (int) –

---

SetMaximumSizeY(self, min)

Sets the maximum window size in the y direction.

Parameters:

min (int) –

---

SetMinimumSizeX(self, min)

Sets the minimum window size in the x direction.

Parameters:

min (int) –

---

SetMinimumSizeY(self, min)

Sets the minimum window size in the y direction.

Parameters:

min (int) –

---

SetSashVisible(self, edge, visible)

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

Parameters:

• edge (SashEdgePosition) – Edge to change. One of wx.adv.SASH_TOP, wx.adv.SASH_RIGHT, wx.adv.SASH_BOTTOM, wx.adv.SASH_LEFT.

• visible (bool) – True to make the sash visible, False to make it invisible.

See also

GetSashVisible

---

SizeWindows(self)

Resizes subwindows.

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