
wx.lib.agw.pycollapsiblepane.PyCollapsiblePane¶PyCollapsiblePane is a container with an embedded button-like control which
can be used by the user to collapse or expand the pane’s contents.
Class Hierarchy¶
Inheritance diagram for class PyCollapsiblePane:

Control Appearance¶
wxMSW¶
wxMAC¶
wxGTK¶
Known Superclasses¶
Methods Summary¶Default class constructor. |
|
Collapses or expands the pane window. |
|
Gets the size which best suits the window: for a control, it would be the |
|
Same as |
|
Returns the |
|
Returns the |
|
Returns the button label. |
|
Returns the button associated with |
|
Returns the button font. |
|
Returns the expander dimensions, a tuple of integers representing the |
|
Returns the button label. |
|
Returns a reference to the pane window. Use the returned |
|
Returns whether a flag is present in the |
|
Returns |
|
Returns |
|
Layout the |
|
Handles the |
|
Overridable method to draw the GTK-style expander. |
|
Handles the |
|
Overridable method to draw the |
|
Handles the |
|
Handles the status changes (collapsing/expanding). |
|
Sets the |
|
Assign a new button to |
|
Sets the button font. |
|
Sets the expander width and height. |
|
Sets the button label. |
Class API¶PyCollapsiblePane(wx.Panel)¶PyCollapsiblePane is a container with an embedded button-like control which
can be used by the user to collapse or expand the pane’s contents.
__init__(self, parent, id=wx.ID_ANY, label="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, agwStyle=wx.CP_DEFAULT_STYLE, validator=wx.DefaultValidator, name="PyCollapsiblePane")¶Default class constructor.
parent – the PyCollapsiblePane parent. Must not be None;
id – window identifier. A value of -1 indicates a default value;
label – The initial label shown in the button which allows the user to expand or collapse the pane window.
pos – the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform;
size – the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform;
style – the underlying Panel window style;
agwStyle –
the AGW-specifi window style. This can be a combination of the following bits:
Window Styles |
Hex Value |
Description |
|---|---|---|
|
0x2 |
By default |
|
0x4 |
Uses a GTK expander instead of a button. |
|
0x8 |
Uses a |
|
0x10 |
Draws a line above |
validator – the validator associated to the PyCollapsiblePane;
name – the widget name.
Collapse(self, collapse=True)¶Collapses or expands the pane window.
collapse – True to collapse the pane window, False to expand it.
DoGetBestSize(self)¶Gets the size which best suits the window: for a control, it would be the minimal size which doesn’t truncate the control, for a panel - the same size as it would have after a call to Fit().
Note
Overridden from Panel.
GetAGWWindowStyleFlag(self)¶Returns the PyCollapsiblePane window style.
See also
SetAGWWindowStyleFlag for a list of possible window style flags.
GetBorder(self)¶Returns the PyCollapsiblePane border in pixels (platform dependent).
GetBtnLabel(self)¶Returns the button label.
GetButton(self)¶Returns the button associated with PyCollapsiblePane.
GetButtonFont(self)¶Returns the button font.
GetExpanderDimensions(self)¶Returns the expander dimensions, a tuple of integers representing the width and height of the expander, in pixels.
GetLabel(self)¶Returns the button label.
Note
Overridden from Panel.
GetPane(self)¶Returns a reference to the pane window. Use the returned wx.Window as
the parent of widgets to make them part of the collapsible area.
HasAGWFlag(self, flag)¶Returns whether a flag is present in the PyCollapsiblePane style.
flag – one of the possible PyCollapsiblePane window styles.
See also
SetAGWWindowStyleFlag for a list of possible window style flags.
IsCollapsed(self)¶Returns True if the pane window is currently hidden.
IsExpanded(self)¶Returns True if the pane window is currently shown.
Layout(self)¶Layout the PyCollapsiblePane.
OnButton(self, event)¶Handles the wx.EVT_BUTTON event for PyCollapsiblePane.
event – a CommandEvent event to be processed.
OnDrawGTKExpander(self, dc)¶Overridable method to draw the GTK-style expander.
dc – an instance of wx.DC.
OnDrawGTKStyle(self, event)¶Handles the wx.EVT_PAINT event for PyCollapsiblePane.
event – a PaintEvent event to be processed.
Note
This is a drawing routine to paint the GTK-style expander.
OnDrawGTKText(self, dc)¶Overridable method to draw the PyCollapsiblePane text in the expander.
dc – an instance of wx.DC.
OnSize(self, event)¶Handles the wx.EVT_SIZE event for PyCollapsiblePane.
event – a wx.SizeEvent event to be processed.
OnStateChange(self, sz)¶Handles the status changes (collapsing/expanding).
sz – an instance of wx.Size.
SetAGWWindowStyleFlag(self, agwStyle)¶Sets the PyCollapsiblePane window style flags.
agwStyle –
the AGW-specific window style. This can be a combination of the following bits:
Window Styles |
Hex Value |
Description |
|---|---|---|
|
0x2 |
By default |
|
0x4 |
Uses a GTK expander instead of a button. |
|
0x8 |
Uses a |
|
0x10 |
Draws a line above |
SetButton(self, button)¶Assign a new button to PyCollapsiblePane.
button – can be the standard Button or any of the generic
implementations which live in lib.buttons.
SetExpanderDimensions(self, width, height)¶Sets the expander width and height.
width – an integer specifying the expander width in pixels;
height – an integer specifying the expander height in pixels.
SetLabel(self, label)¶Sets the button label.
label – the new button label.
Note
Overridden from Panel.