Inheritance diagram for 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.
See also
| Window Style | Description |
|---|---|
| wx.SP_3D | Draws a 3D effect border and sash. |
| wx.SP_3DSASH | Draws a 3D effect sash. |
| 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 XP, switches off the attempt to draw the splitter using Windows XP 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 XOR line but resize the child windows immediately |
| Event Name | Description |
|---|---|
| wx.EVT_SPLITTER_SASH_POS_CHANGING(id, func) | 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 wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event. |
| wx.EVT_SPLITTER_SASH_POS_CHANGED(id, func) | 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 wx.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event. |
| wx.EVT_SPLITTER_UNSPLIT(id, func) | The splitter has been just unsplit. Processes a wx.wxEVT_COMMAND_SPLITTER_UNSPLIT event. |
| wx.EVT_SPLITTER_DCLICK(id, func) | 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 wx.wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event. |
Constructor. Creates and shows a wx.SplitterWindow.
Parameters:
Returns:
Note
After using this constructor, you must create either one or two subwindows with the splitter window as parent, and then call one of Initialize, SplitVertically or SplitHorizontally in order to set the pane(s).
Gets the border size
Returns:
int
Returns the current minimum pane size (defaults to zero).
Returns:
int
See also
Returns the current sash gravity.
Returns:
double
See also
Returns the current sash position.
Returns:
int
See also
Gets the sash size
Returns:
int
Gets the split mode.
Returns:
int
See also
Initializes the splitter window to have one pane. The child window is shown if it is currently hidden.
Parameters:
Note
This should be called if you wish to initially view only a single pane in the splitter window.
See also
Returns True if the window is split, False otherwise.
Returns:
bool
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:
Returns:
bool
See also
Tests for x, y over the sash
Parameters:
Returns:
bool
Sets the border size. Currently a NOP.
Parameters:
Sets the minimum pane size.
Parameters:
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.
See also
Parameters:
Sets the sash gravity.
Example values:
| Sash Gravity | Effect |
|---|---|
| 0.0 | Only the bottom or right window is automaticaly resized. |
| 0.5 | Both windows grow equally. |
| 1.0 | Only left/top window grows. |
The default value of sash gravity is 0.0. That value is compatible with the previous (before gravity was introduced) behaviour of the wx.SplitterWindow.
Parameters:
See also
Sets the sash position.
Parameters:
Note
This method does not currently check for an out-of-range value.
See also
Sets the sash size. Normally, the sash size is determined according to the metrics of each platform, but the application can override this, for example to show a thin sash that the user is not expected to drag.
If size is greater than -1, the custom sash size will be used.
Parameters:
Sets the split mode.
Parameters:
Note
Only sets the internal variable; does not update the display.
See also
Initializes the top and bottom panes of the splitter window. The child windows are shown if they are currently hidden.
Parameters:
Returns:
bool
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.
See also
Initializes the left and right panes of the splitter window. The child windows are shown if they are currently hidden.
Parameters:
Returns:
bool
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.
See also
Unsplits the window.
Parameters:
Returns:
bool
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.
See also
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.
