A collapsable panel is a container with an embedded button-like control which can be used by the user to collapse or expand the pane's contents.
Note that because of its nature of control which can dynamically (and drastically) change its size at run-time under user-input, when putting wxCollapsiblePane inside a wxSizer 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 would automatically get resized each time the user expands or collaps the pane window.
It is only available if wxUSE_COLLPANE is set to 1 (the default).
Derived from
wxControl
wxWindow
wxEvtHandler
wxObject
Include files
<wx/collpane.h>
Window styles
wxCP_DEFAULT_STYLE | The default style: 0. |
Event handling
EVT_COLLAPSIBLEPANE_CHANGED(id, func) | The user showed or hidden the collapsible pane. |
See also
Members
wxCollapsiblePane::wxCollapsiblePane
wxCollapsiblePane::Create
wxCollapsiblePane::IsCollapsed
wxCollapsiblePane::IsExpanded
wxCollapsiblePane::Collapse
wxCollapsiblePane::Expand
wxCollapsiblePane(wxWindow *parent, wxWindowID id, const wxString& label, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxCP_DEFAULT_STYLE, const wxValidator& validator = wxDefaultValidator, const wxString& name = "collapsiblePane")
Initializes the object and calls Create with all the parameters.
bool Create(wxWindow *parent, wxWindowID id, const wxString& label, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxCP_DEFAULT_STYLE, const wxValidator& validator = wxDefaultValidator, const wxString& name = "colourpickerctrl")
Parameters
parent
id
label
pos
size
style
validator
name
Return value
true if the control was successfully created or false if creation failed.
bool IsCollapsed() const
Returns true if the pane window is currently hidden.
bool IsExpanded() const
Returns true if the pane window is currently shown.
void Collapse(bool collapse = true)
Collapses or expands the pane window.
void Expand()
Same as Collapse(false).