Navigation

Phoenix Logo

phoenix_title 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 Class Hierarchy

Inheritance diagram for class PyCollapsiblePane:


appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


super_classes Known Superclasses

wx.Panel


method_summary Methods Summary

__init__ Default class constructor.
Collapse Collapses or expands the pane window.
DoGetBestSize Gets the size which best suits the window: for a control, it would be the
Expand Same as Collapse (False).
GetAGWWindowStyleFlag Returns the PyCollapsiblePane window style.
GetBorder Returns the PyCollapsiblePane border in pixels (platform dependent).
GetBtnLabel Returns the button label.
GetButton Returns the button associated with PyCollapsiblePane.
GetButtonFont Returns the button font.
GetExpanderDimensions Returns the expander dimensions, a tuple of integers representing the
GetLabel Returns the button label.
GetPane Returns a reference to the pane window. Use the returned wx.Window as
HasAGWFlag Returns whether a flag is present in the PyCollapsiblePane style.
IsCollapsed Returns True if the pane window is currently hidden.
IsExpanded Returns True if the pane window is currently shown.
Layout Layout the PyCollapsiblePane.
OnButton Handles the wx.EVT_BUTTON event for PyCollapsiblePane.
OnDrawGTKExpander Overridable method to draw the GTK-style expander.
OnDrawGTKStyle Handles the wx.EVT_PAINT event for PyCollapsiblePane.
OnDrawGTKText Overridable method to draw the PyCollapsiblePane text in the expander.
OnSize Handles the wx.EVT_SIZE event for PyCollapsiblePane.
OnStateChange Handles the status changes (collapsing/expanding).
SetAGWWindowStyleFlag Sets the PyCollapsiblePane window style flags.
SetButton Assign a new button to PyCollapsiblePane.
SetButtonFont Sets the button font.
SetExpanderDimensions Sets the expander width and height.
SetLabel Sets the button label.

api Class API


class 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.


Methods


__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.

Parameters:
  • 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
    CP_NO_TLW_RESIZE 0x2 By default PyCollapsiblePane resizes the top level window containing it when its own size changes. This allows to easily implement dialogs containing an optionally shown part, for example, and so is the default behaviour but can be inconvenient in some specific cases – use this flag to disable this automatic parent resizing then.
    CP_GTK_EXPANDER 0x4 Uses a GTK expander instead of a button.
    CP_USE_STATICBOX 0x8 Uses a StaticBox around PyCollapsiblePane.
    CP_LINE_ABOVE 0x10 Draws a line above PyCollapsiblePane.
  • validator – the validator associated to the PyCollapsiblePane;
  • name – the widget name.

Collapse(self, collapse=True)

Collapses or expands the pane window.

Parameters: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.


Expand(self)

Same as Collapse (False).


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.

Parameters: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.

Parameters:event – a CommandEvent event to be processed.

OnDrawGTKExpander(self, dc)

Overridable method to draw the GTK-style expander.

Parameters:dc – an instance of wx.DC.

OnDrawGTKStyle(self, event)

Handles the wx.EVT_PAINT event for PyCollapsiblePane.

Parameters: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.

Parameters:dc – an instance of wx.DC.

OnSize(self, event)

Handles the wx.EVT_SIZE event for PyCollapsiblePane.

Parameters:event – a wx.SizeEvent event to be processed.

OnStateChange(self, sz)

Handles the status changes (collapsing/expanding).

Parameters:sz – an instance of wx.Size.

SetAGWWindowStyleFlag(self, agwStyle)

Sets the PyCollapsiblePane window style flags.

Parameters:agwStyle – the AGW-specific window style. This can be a combination of the following bits:

Window Styles Hex Value Description
CP_NO_TLW_RESIZE 0x2 By default PyCollapsiblePane resizes the top level window containing it when its own size changes. This allows to easily implement dialogs containing an optionally shown part, for example, and so is the default behaviour but can be inconvenient in some specific cases – use this flag to disable this automatic parent resizing then.
CP_GTK_EXPANDER 0x4 Uses a GTK expander instead of a button.
CP_USE_STATICBOX 0x8 Uses a StaticBox around PyCollapsiblePane.
CP_LINE_ABOVE 0x10 Draws a line above PyCollapsiblePane.

SetButton(self, button)

Assign a new button to PyCollapsiblePane.

Parameters:button – can be the standard Button or any of the generic implementations which live in lib.buttons.

SetButtonFont(self, font)

Sets the button font.

Parameters:font – a valid wx.Font object.

SetExpanderDimensions(self, width, height)

Sets the expander width and height.

Parameters:
  • 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.

Parameters:label – the new button label.

Note

Overridden from Panel.