wx._windows.SplitterWindow
wx.SplitterWindow manages up to two subwindows or panes, with an
optional vertical or horizontal split which can be used with the mouse
or programmatically.
Create(args, kwargs)
Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -> bool
Create the GUI part of the SplitterWindow for the 2-phase create.
GetBorderSize(args, kwargs)
GetBorderSize(self) -> int
Gets the border size
GetClassDefaultAttributes
GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
Get the default attributes for this class. This is useful if you want
to use the same font or colour in your own control as in a standard
control -- which is a much better idea than hard coding specific
colours or fonts which might look completely out of place on the
user's system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
ignore under other platforms. Under Mac, it will change the size of
the returned font. See `wx.Window.SetWindowVariant` for more about
this.
GetMinimumPaneSize(args, kwargs)
GetMinimumPaneSize(self) -> int
Gets the minimum pane size in pixels.
GetNeedUpdating(args, kwargs)
GetNeedUpdating(self) -> bool
GetSashGravity(args, kwargs)
GetSashGravity(self) -> double
Gets the sash gravity.
:see: `SetSashGravity`
GetSashPosition(args, kwargs)
GetSashPosition(self) -> int
Returns the surrent sash position.
GetSashSize(args, kwargs)
GetSashSize(self) -> int
Gets the sash size
GetSplitMode(args, kwargs)
GetSplitMode(self) -> int
Gets the split mode
GetWindow1(args, kwargs)
GetWindow1(self) -> Window
Gets the only or left/top pane.
GetWindow2(args, kwargs)
GetWindow2(self) -> Window
Gets the right/bottom pane.
Initialize(args, kwargs)
Initialize(self, Window window)
Initializes the splitter window to have one pane. This should be
called if you wish to initially view only a single pane in the
splitter window. The child window is shown if it is currently hidden.
IsSplit(args, kwargs)
IsSplit(self) -> bool
Is the window split?
ReplaceWindow(args, kwargs)
ReplaceWindow(self, Window winOld, Window winNew) -> bool
This function replaces one of the windows managed by the
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. It is valid to call this
function whether the splitter has two windows or only one.
Both parameters should be non-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 Destroy
the replaced window and you may wish to do it yourself.
SashHitTest(args, kwargs)
SashHitTest(self, int x, int y, int tolerance=5) -> bool
Tests for x, y over the sash
SetBorderSize(args, kwargs)
SetBorderSize(self, int width)
Sets the border size. Currently a NOP.
SetMinimumPaneSize(args, kwargs)
SetMinimumPaneSize(self, int min)
Sets the minimum pane size in pixels.
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.
SetNeedUpdating(args, kwargs)
SetNeedUpdating(self, bool needUpdating)
SetSashGravity(args, kwargs)
SetSashGravity(self, double gravity)
Set the sash gravity. Gravity is a floating-point factor between 0.0
and 1.0 which controls position of sash while resizing the
`wx.SplitterWindow`. The gravity specifies how much the left/top
window will grow while resizing.
SetSashPosition(args, kwargs)
SetSashPosition(self, int position, bool redraw=True)
Sets the sash position, in pixels. If redraw is Ttrue then the panes
are resized and the sash and border are redrawn.
SetSashSize(args, kwargs)
SetSashSize(self, int width)
Sets the sash size.
SetSplitMode(args, kwargs)
SetSplitMode(self, int mode)
Sets the split mode. The mode can be wx.SPLIT_VERTICAL or
wx.SPLIT_HORIZONTAL. This only sets the internal variable; does not
update the display.
SizeWindows(args, kwargs)
SizeWindows(self)
Resizes subwindows
SplitHorizontally(args, kwargs)
SplitHorizontally(self, Window window1, Window window2, int sashPosition=0) -> bool
Initializes the top and bottom panes of the splitter window. The
child windows are shown if they are currently hidden.
SplitVertically(args, kwargs)
SplitVertically(self, Window window1, Window window2, int sashPosition=0) -> bool
Initializes the left and right panes of the splitter window. The
child windows are shown if they are currently hidden.
Unsplit(args, kwargs)
Unsplit(self, Window toRemove=None) -> bool
Unsplits the window. Pass the pane to remove, or None to remove the
right or bottom pane. Returns True if successful, False otherwise (the
window was not split).
This function will not actually delete the pane being
removed; it sends EVT_SPLITTER_UNSPLIT which can be handled
for the desired behaviour. By default, the pane being
removed is only hidden.
UpdateSize(args, kwargs)
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.
[constructor]
Usage: classname(arguments)
[member '__doc__']
Documentation for this class
[member '__module__']
The module that this class belongs to
[operator 'repr']
Usage: repr(a)