AGW Logo

agw_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

hierarchy Inheritance Diagram

Inheritance diagram for: CaptionBarEvent

Inheritance diagram of CaptionBarEvent


method_summary Methods Summary

__init__Default class constructor.
GetBarReturns the selected CaptionBar.
GetFoldStatusReturns whether the bar is expanded or collapsed.
GetTagReturns the tag assigned to the selected CaptionBar.
SetBarSets the bar associated with this event.
SetTagAssigns a tag to the selected CaptionBar.

API Class API

class CaptionBarEvent(wx.PyCommandEvent)[source]

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



__init__(evtType)[source]

Default class constructor.

Parameters:evtType – the event type.


GetBar()[source]

Returns the selected CaptionBar.



GetFoldStatus()[source]

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



GetTag()[source]

Returns the tag assigned to the selected CaptionBar.



SetBar(bar)[source]

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(tag)[source]

Assigns a tag to the selected CaptionBar.

Parameters:tag – an instance of FoldPanelBar.
Tree

Table Of Contents

Previous topic

CaptionBar

Next topic

CaptionBarStyle