Phoenix Logo

phoenix_title wx.ribbon.RibbonButtonBarEvent

Event used to indicate various actions relating to a button on a wx.ribbon.RibbonButtonBar.

For toggle buttons, IsChecked can be used to test the state of the button.

See wx.ribbon.RibbonButtonBar for available event types.


class_hierarchy Class Hierarchy

Inheritance diagram for class RibbonButtonBarEvent:

method_summary Methods Summary

__init__ Constructor.
GetBar Returns the bar which contains the button which the event relates to.
GetButton Returns the button which the event relates to.
PopupMenu Display a popup menu as a result of this (dropdown clicked) event.
SetBar Sets the button bar relating to this event.
SetButton Sets the button relating to this event.

property_summary Properties Summary

Bar See GetBar and SetBar
Button See GetButton and SetButton

api Class API



class wx.ribbon.RibbonButtonBarEvent(CommandEvent)

Possible constructors:

RibbonButtonBarEvent(command_type=wxEVT_NULL, win_id=0, bar=None,
                     button=None)

Event used to indicate various actions relating to a button on a RibbonButtonBar.


Methods



__init__(self, command_type=wxEVT_NULL, win_id=0, bar=None, button=None)

Constructor.

Parameters:


GetBar(self)

Returns the bar which contains the button which the event relates to.

Return type: wx.ribbon.RibbonButtonBar


GetButton(self)

Returns the button which the event relates to.

Return type:RibbonButtonBarButtonBase

New in version 2.9.5.



PopupMenu(self, menu)

Display a popup menu as a result of this (dropdown clicked) event.

Parameters:menu (wx.Menu) –
Return type:bool


SetBar(self, bar)

Sets the button bar relating to this event.

Parameters:bar (wx.ribbon.RibbonButtonBar) –


SetButton(self, bar)

Sets the button relating to this event.

Parameters:bar (RibbonButtonBarButtonBase) –

New in version 2.9.5.


Properties



Bar

See GetBar and SetBar



Button

See GetButton and SetButton