Table Of Contents

Previous topic

CaptionBar

Next topic

CaptionBarStyle

This Page

phoenix_title CaptionBarEvent

This event will be sent when a EVT_CAPTIONBAR is mapped in the parent. It is to notify the parent that the bar is now in collapsed or expanded state. The parent should re-arrange the associated windows accordingly


class_hierarchy Inheritance Diagram

Inheritance diagram for class CaptionBarEvent

Inheritance diagram of CaptionBarEvent


super_classes Known Superclasses

PyCommandEvent


method_summary Methods Summary

__init__ Default class constructor.
GetBar Returns the selected CaptionBar.
GetFoldStatus Returns whether the bar is expanded or collapsed. True means
GetTag Returns the tag assigned to the selected CaptionBar.
SetBar Sets the bar associated with this event.
SetTag Assigns a tag to the selected CaptionBar.

api Class API



class CaptionBarEvent(PyCommandEvent)

This event will be sent when a EVT_CAPTIONBAR is mapped in the parent. It is to notify the parent that the bar is now in collapsed or expanded state. The parent should re-arrange the associated windows accordingly


Methods



__init__(self, evtType)

Default class constructor.

Parameters:evtType – the event type.


GetBar(self)

Returns the selected CaptionBar.



GetFoldStatus(self)

Returns whether the bar is expanded or collapsed. True means expanded.



GetTag(self)

Returns the tag assigned to the selected CaptionBar.



SetBar(self, bar)

Sets the bar associated with this event.

Parameters:bar – an instance of CaptionBar.

Note

Should not be used by any other than the originator of the event.



SetTag(self, tag)

Assigns a tag to the selected CaptionBar.

Parameters:tag – an instance of FoldPanelBar.