wx.SplitterWindow¶

This class manages up to two subwindows.

The current view can be split into two programmatically (perhaps from a menu command), and unsplit either programmatically or via the wx.SplitterWindow user interface.

Window Styles¶

This class supports the following styles:

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

• wx.SP_THIN_SASH: Draws a thin sash.

• wx.SP_3DSASH: Draws a 3D effect sash (part of default style).

• wx.SP_3DBORDER: Synonym for wx.SP_BORDER.

• wx.SP_BORDER: Draws a standard border.

• wx.SP_NOBORDER: No border (default).

• wx.SP_NO_XP_THEME: Under Windows, switches off the attempt to draw the splitter using Windows theming, so the borders and sash will take on the pre-XP look.

• wx.SP_PERMIT_UNSPLIT: Always allow to unsplit, even with the minimum pane size other than zero.

• wx.SP_LIVE_UPDATE: Don’t draw wx.XOR line but resize the child windows immediately.

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.

Class Hierarchy¶

Inheritance diagram for class SplitterWindow:

Methods Summary¶

 __init__ Default constructor. Create Creation function, for two-step construction. GetClassDefaultAttributes GetDefaultSashSize Returns the default sash size in pixels. GetMinimumPaneSize Returns the current minimum pane size (defaults to zero). GetSashGravity Returns the current sash gravity. GetSashPosition Returns the current sash position. GetSashSize Returns the default sash size in pixels or 0 if it is invisible. GetSplitMode Gets the split mode. GetWindow1 Returns the left/top or only pane. GetWindow2 Returns the right/bottom pane. Initialize Initializes the splitter window to have one pane. IsSashInvisible Returns True if the sash is invisible even when the window is split, False otherwise. IsSplit Returns True if the window is split, False otherwise. ReplaceWindow This function replaces one of the windows managed by the wx.SplitterWindow with another one. SetMinimumPaneSize Sets the minimum pane size. SetSashGravity Sets the sash gravity. SetSashInvisible Sets whether the sash should be invisible, even when the window is split. SetSashPosition Sets the sash position. SetSplitMode Sets the split mode. SplitHorizontally Initializes the top and bottom panes of the splitter window. SplitVertically Initializes the left and right panes of the splitter window. Unsplit Unsplits the window. UpdateSize Causes any pending sizing of the sash and child panes to take place immediately.

Class API¶

class wx.SplitterWindow(Window)

Possible constructors:

SplitterWindow()

SplitterWindow(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
style=SP_3D, name="splitterWindow")


This class manages up to two subwindows.

Methods¶

__init__(self, *args, **kw)

__init__ (self)

Default constructor.

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=SP_3D, name=”splitterWindow”)

Constructor for creating the window.

Parameters
• parent (wx.Window) – The parent of the splitter window.

• id (wx.WindowID) – The window identifier.

• pos (wx.Point) – The window position.

• size (wx.Size) – The window size.

• style (long) – The window style. See wx.SplitterWindow.

• name (string) – The window name.

Note

After using this constructor, you must create either one or two subwindows with the splitter window as parent, and then call one of wx.Initialize , SplitVertically and SplitHorizontally in order to set the pane(s). You can create two windows, with one hidden when not being shown; or you can create and delete the second pane on demand.

Create(self, parent, id=ID_ANY, point=DefaultPosition, size=DefaultSize, style=SP_3D, name="splitter")

Creation function, for two-step construction.

See wx.SplitterWindow for details.

Parameters
• parent (wx.Window) –

• id (wx.WindowID) –

• point (wx.Point) –

• size (wx.Size) –

• style (long) –

• name (string) –

Return type

bool

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

wx.VisualAttributes

GetDefaultSashSize(self)

Returns the default sash size in pixels.

The size of the sash is its width for a vertically split window and its height for a horizontally split one. Its other direction is the same as the client size of the window in the corresponding direction.

The default sash size is platform-dependent because it conforms to the current platform look-and-feel and cannot be changed.

Return type

int

New in version 2.9.4.

GetMinimumPaneSize(self)

Returns the current minimum pane size (defaults to zero).

Return type

int

GetSashGravity(self)

Returns the current sash gravity.

Return type

float

GetSashPosition(self)

Returns the current sash position.

Return type

int

GetSashSize(self)

Returns the default sash size in pixels or 0 if it is invisible.

Return type

int

GetSplitMode(self)

Gets the split mode.

Return type

wx.SplitMode

GetWindow1(self)

Returns the left/top or only pane.

Return type

wx.Window

GetWindow2(self)

Returns the right/bottom pane.

Return type

wx.Window

Initialize(self, window)

Initializes the splitter window to have one pane.

The child window is shown if it is currently hidden.

Parameters

window (wx.Window) – The pane for the unsplit window.

Note

This should be called if you wish to initially view only a single pane in the splitter window.

IsSashInvisible(self)

Returns True if the sash is invisible even when the window is split, False otherwise.

Return type

bool

New in version 2.9.4.

Note

This is a shortcut for HasFlag(wxSP_NOSASH)

IsSplit(self)

Returns True if the window is split, False otherwise.

Return type

bool

ReplaceWindow(self, winOld, winNew)

This function replaces one of the windows managed by the wx.SplitterWindow with another one.

It is in general better to use it instead of calling Unsplit and then resplitting the window back because it will provoke much less flicker (if any). It is valid to call this function whether the splitter has two windows or only one.

Both parameters should be not None and winOld must specify one of the windows managed by the splitter. If the parameters are incorrect or the window couldn’t be replaced, False is returned. Otherwise the function will return True, but please notice that it will not delete the replaced window and you may wish to do it yourself.

Parameters
Return type

bool

SetMinimumPaneSize(self, paneSize)

Sets the minimum pane size.

Parameters

paneSize (int) – Minimum pane size in pixels.

Note

The default minimum pane size is zero, which means that either pane can be reduced to zero by dragging the sash, thus removing one of the panes. To prevent this behaviour (and veto out-of-range sash dragging), set a minimum size, for example 20 pixels. If the wx.SP_PERMIT_UNSPLIT style is used when a splitter window is created, the window may be unsplit even if minimum size is non-zero.

SetSashGravity(self, gravity)

Sets the sash gravity.

Parameters

gravity (float) – The sash gravity. Value between 0.0 and 1.0.

Notice that when sash gravity for a newly created splitter window, it is often necessary to explicitly set the splitter size using SetSize to ensure that is big enough for its initial sash position. Otherwise, i.e. if the window is created with the default tiny size and only resized to its correct size later, the initial sash position will be affected by the gravity and typically result in sash being at the rightmost position for the gravity of 1. See the example code creating wx.SplitterWindow in the splitter sample for more details.

Note

Gravity is real factor which controls position of sash while resizing wx.SplitterWindow. Gravity tells wx.SplitterWindow how much will left/top window grow while resizing. Example values:

• 0.0: only the bottom/right window is automatically resized

• 0.5: both windows grow by equal size

• 1.0: only left/top window grows Gravity should be a real value between 0.0 and 1.0. Default value of sash gravity is 0.0. That value is compatible with previous (before gravity was introduced) behaviour of wx.SplitterWindow.

SetSashInvisible(self, invisible=True)

Sets whether the sash should be invisible, even when the window is split.

When the sash is invisible, it doesn’t appear on the screen at all and, in particular, doesn’t allow the user to resize the windows.

Parameters

invisible (bool) – If True, the sash is always invisible, else it is shown when the window is split.

New in version 2.9.4.

Note

Only sets the internal variable; does not update the display.

SetSashPosition(self, position, redraw=True)

Sets the sash position.

Parameters
• position (int) – The sash position in pixels.

• redraw (bool) – If True, resizes the panes and redraws the sash and border.

Note

Does not currently check for an out-of-range value.

SetSplitMode(self, mode)

Sets the split mode.

Parameters

mode (int) – Can be wx.SPLIT_VERTICAL or wx.SPLIT_HORIZONTAL.

Note

Only sets the internal variable; does not update the display.

SplitHorizontally(self, window1, window2, sashPosition=0)

Initializes the top and bottom panes of the splitter window.

The child windows are shown if they are currently hidden.

Parameters
• window1 (wx.Window) – The top pane.

• window2 (wx.Window) – The bottom pane.

• sashPosition (int) – The initial position of the sash. If this value is positive, it specifies the size of the upper pane. If it is negative, its absolute value gives the size of the lower pane. Finally, specify 0 (default) to choose the default position (half of the total window height).

Return type

bool

Returns

True if successful, False otherwise (the window was already split).

Note

This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using IsSplit .

SplitVertically(self, window1, window2, sashPosition=0)

Initializes the left and right panes of the splitter window.

The child windows are shown if they are currently hidden.

Parameters
• window1 (wx.Window) – The left pane.

• window2 (wx.Window) – The right pane.

• sashPosition (int) – The initial position of the sash. If this value is positive, it specifies the size of the left pane. If it is negative, it is absolute value gives the size of the right pane. Finally, specify 0 (default) to choose the default position (half of the total window width).

Return type

bool

Returns

True if successful, False otherwise (the window was already split).

Note

This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using IsSplit .

Unsplit(self, toRemove=None)

Unsplits the window.

Parameters

toRemove (wx.Window) – The pane to remove, or None to remove the right or bottom pane.

Return type

bool

Returns

True if successful, False otherwise (the window was not split).

Note

This call will not actually delete the pane being removed; it calls OnUnsplit which can be overridden for the desired behaviour. By default, the pane being removed is hidden.

UpdateSize(self)

Causes any pending sizing of the sash and child panes to take place immediately.

Such resizing normally takes place in idle time, in order to wait for layout to be completed. However, this can cause unacceptable flicker as the panes are resized after the window has been shown. To work around this, you can perform window layout (for example by sending a size event to the parent window), and then call this function, before showing the top-level window.

Properties¶

DefaultSashSize

MinimumPaneSize

SashGravity

SashInvisible

SashPosition

SashSize

SplitMode

Window1

Window2