phoenix_title wx.CollapsibleHeaderCtrl

Header control above a collapsible pane.

The collapsible header usually consists of a small indicator of the collapsed state and the label text beside it. This class is used by the generic implementation of wx.CollapsiblePane but maybe used in more complex layouts for other uses.

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.CommandEvent parameter.

  • EVT_COLLAPSIBLEHEADER_CHANGED: User changed the collapsed state.

New in version 4.1/wxWidgets-3.1.0.


class_hierarchy Class Hierarchy

Inheritance diagram for class CollapsibleHeaderCtrl:

method_summary Methods Summary

__init__

Create

Create the control initialized using the default constructor.

GetClassDefaultAttributes

IsCollapsed

Returns true if the control is collapsed.

SetCollapsed

Set collapsed state of the header.


api Class API

class wx.CollapsibleHeaderCtrl(Control)

Possible constructors:

CollapsibleHeaderCtrl()

CollapsibleHeaderCtrl(parent, id=ID_ANY, label="", pos=DefaultPosition,
                      size=DefaultSize, style=BORDER_NONE, validator=DefaultValidator,
                      name=CollapsibleHeaderCtrlNameStr)

Header control above a collapsible pane.


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)



__init__ (self, parent, id=ID_ANY, label=””, pos=DefaultPosition, size=DefaultSize, style=BORDER_NONE, validator=DefaultValidator, name=CollapsibleHeaderCtrlNameStr)

Constructor fully creating the control.

The arguments have the usual meanings and only parent is typically required.

Parameters





Create(self, parent, id=ID_ANY, label="", pos=DefaultPosition, size=DefaultSize, style=BORDER_NONE, validator=DefaultValidator, name=CollapsibleHeaderCtrlNameStr)

Create the control initialized using the default constructor.

This method can be used to finish the control creation if it hadn’t been done already by using the non-default constructor.

Parameters
Return type

bool



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

wx.VisualAttributes



IsCollapsed(self)

Returns true if the control is collapsed.

Return type

bool

See also

SetCollapsed



SetCollapsed(self, collapsed=True)

Set collapsed state of the header.

Parameters

collapsed (bool) –