A collapsible pane is a container with an embedded button-like control which can be used by the user to collapse or expand the pane’s contents.
Once constructed you should use the GetPane function to access the pane and add your controls inside it (i.e. use the returned pointer from GetPane as parent for the controls which must go in the pane, not the CollapsiblePane itself!).
Note that because of its nature of control which can dynamically (and drastically) change its size at run-time under user-input, when putting CollapsiblePane inside a Sizer you should be careful to add it with a proportion value of zero; this is because otherwise all other windows with non-null proportion values will automatically resize each time the user expands or collapse the pane window usually resulting in a weird, flickering effect.
Usage sample:
collpane = wx.CollapsiblePane(self, wx.ID_ANY, "Details:")
# add the pane with a zero proportion value to the 'sz' sizer which contains it
sz.Add(collpane, 0, wx.GROW|.ALL, 5)
# now add a test label in the collapsible pane using a sizer to layout it:
win = collpane.GetPane()
paneSz = wx.BoxSizer(wx.VERTICAL)
paneSz.Add(wx.StaticText(win, wx.ID_ANY, "test!"), 1, wx.GROW|.ALL, 2)
win.SetSizer(paneSz)
paneSz.SetSizeHints(win)
It is only available if USE_COLLPANE is set to 1 (the default).
This class supports the following styles:
Handlers bound for the following event types will receive one of the CollapsiblePaneEvent NavigationKeyEvent parameters.
See also
__init__ | Default constructor. |
Collapse | Collapses or expands the pane window. |
Create | |
Expand | Same as calling Collapse(false). |
GetPane | Returns a pointer to the pane window. |
IsCollapsed | Returns True if the pane window is currently hidden. |
IsExpanded | Returns True if the pane window is currently shown. |
A collapsible pane is a container with an embedded button-like control which can be used by the user to collapse or expand the pane’s contents.
Possible constructors:
CollapsiblePane()
CollapsiblePane(parent, id=ID_ANY, label='',
pos=DefaultPosition, size=DefaultSize, style=CP_DEFAULT_STYLE,
validator=DefaultValidator, name=CollapsiblePaneNameStr)
Overloaded Implementations:
__init__ (self)
Default constructor.
__init__ (self, parent, id=ID_ANY, label=’‘, pos=DefaultPosition, size=DefaultSize, style=CP_DEFAULT_STYLE, validator=DefaultValidator, name=CollapsiblePaneNameStr)
Initializes the object and calls Create with all the parameters.
Parameters: |
---|
Collapses or expands the pane window.
Parameters: | collapse (bool) – |
---|
Parameters: |
|
---|---|
Return type: | bool |
Returns: | True if the control was successfully created or False if creation failed. |
Same as calling Collapse(false).
Returns a pointer to the pane window.
Add controls to the returned Window to make them collapsible.
Return type: | Window |
---|
Returns True if the pane window is currently hidden.
Return type: | bool |
---|
Returns True if the pane window is currently shown.
Return type: | bool |
---|