phoenix_title wx.CollapsiblePane

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 wx.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 wx.CollapsiblePane inside a wx.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 | wx.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 | wx.ALL, 2)
win.SetSizer(paneSz)
paneSz.SetSizeHints(win)

It is only available if USE_COLLPANE is set to 1 (the default).

styles Window Styles

This class supports the following styles:

  • wx.CP_DEFAULT_STYLE: The default style. It includes wx.TAB_TRAVERSAL and wx.BORDER_NONE.

  • wx.CP_NO_TLW_RESIZE: By default wx.CollapsiblePane resizes the top level window containing it when its own size changes. This allows easily implementing dialogs containing an optionally shown part, for example, and so is the default behaviour but can be inconvenient in some specific cases –

events Events Emitted by this Class

Handlers bound for the following event types will receive one of the wx.CollapsiblePaneEvent wx.NavigationKeyEvent parameters.

  • EVT_COLLAPSIBLEPANE_CHANGED: The user expanded or collapsed the collapsible pane.

  • EVT_NAVIGATION_KEY: Process a navigation key event.


class_hierarchy Class Hierarchy

Inheritance diagram for class CollapsiblePane:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__

Default constructor.

Collapse

Collapses or expands the pane window.

Create

Expand

Same as calling Collapse(false).

GetClassDefaultAttributes

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.


property_summary Properties Summary

Pane

See GetPane


api Class API

class wx.CollapsiblePane(Control)

Possible constructors:

CollapsiblePane()

CollapsiblePane(parent, id=ID_ANY, label="",
                pos=DefaultPosition, size=DefaultSize, style=CP_DEFAULT_STYLE,
                validator=DefaultValidator, name=CollapsiblePaneNameStr)

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.


Methods

__init__(self, *args, **kw)

overload 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





Collapse(self, collapse=True)

Collapses or expands the pane window.

Parameters

collapse (bool) –



Create(self, parent, id=ID_ANY, label="", pos=DefaultPosition, size=DefaultSize, style=CP_DEFAULT_STYLE, validator=DefaultValidator, name=CollapsiblePaneNameStr)
Parameters
  • parent (wx.Window) – Parent window, must not be not None.

  • id (wx.WindowID) – The identifier for the control.

  • label (string) – The initial label shown in the button which allows the user to expand or collapse the pane window.

  • pos (wx.Point) – Initial position.

  • size (wx.Size) – Initial size.

  • style (long) – The window style, see CP_ flags.

  • validator (wx.Validator) – Validator which can be used for additional date checks.

  • name (string) – Control name.

Return type

bool

Returns

True if the control was successfully created or False if creation failed.



Expand(self)

Same as calling Collapse(false).



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

wx.VisualAttributes



GetPane(self)

Returns a pointer to the pane window.

Add controls to the returned wx.Window to make them collapsible.

Return type

wx.Window



IsCollapsed(self)

Returns True if the pane window is currently hidden.

Return type

bool



IsExpanded(self)

Returns True if the pane window is currently shown.

Return type

bool


Properties

Pane

See GetPane