Table Of Contents

Previous topic

CollapsiblePane

Next topic

Colour

This Page

phoenix_title CollapsiblePaneEvent

This event class is used for the events generated by CollapsiblePane.

events Events Emitted by this Class

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

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

class_hierarchy Inheritance Diagram

Inheritance diagram for class CollapsiblePaneEvent

Inheritance diagram of CollapsiblePaneEvent


method_summary Methods Summary

__init__ The constructor is not normally used by the user code.
GetCollapsed Returns True if the pane has been collapsed.
SetCollapsed Sets this as a collapsed pane event (if collapsed is True) or as an expanded pane event (if collapsed is False).

property_summary Properties Summary

Collapsed See GetCollapsed and SetCollapsed

api Class API



class CollapsiblePaneEvent(CommandEvent)

This event class is used for the events generated by CollapsiblePane.

Possible constructors:

CollapsiblePaneEvent(generator, id, collapsed)

Methods



__init__(self, generator, id, collapsed)

The constructor is not normally used by the user code.

Parameters:
  • generator (Object) –
  • id (int) –
  • collapsed (bool) –


GetCollapsed(self)

Returns True if the pane has been collapsed.

Return type:bool


SetCollapsed(self, collapsed)

Sets this as a collapsed pane event (if collapsed is True) or as an expanded pane event (if collapsed is False).

Parameters:collapsed (bool) –

Properties



Collapsed

See GetCollapsed and SetCollapsed