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¶

Inheritance diagram for class RibbonButtonBarEvent:

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.

Properties Summary¶

`Bar`	See `GetBar` and `SetBar`
`Button`	See `GetButton` and `SetButton`

Class API¶

class wx.ribbon.RibbonButtonBarEvent(CommandEvent)¶

Possible constructors:

RibbonButtonBarEvent(command_type: EventType=wxEVT_NULL, win_id: int=0,
                     bar: Optional[RibbonButtonBar]=None, button:
                     Optional[RibbonButtonBarButtonBase]=None) -> None

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

Methods¶

__init__(self, command_type: EventType=wxEVT_NULL, win_id: int=0, bar: Optional[RibbonButtonBar]=None, button: Optional[RibbonButtonBarButtonBase]=None)¶

Constructor.

Parameters:

command_type (wx.EventType) –
win_id (int) –
bar (wx.ribbon.RibbonButtonBar) –
button (RibbonButtonBarButtonBase) –

Return type:

None

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 : Menu)¶

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

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

SetBar(self, bar : RibbonButtonBar)¶

Sets the button bar relating to this event.

Parameters:: bar (wx.ribbon.RibbonButtonBar) –
Return type:: None

SetButton(self, bar : RibbonButtonBarButtonBase)¶

Sets the button relating to this event.

Parameters:: bar (RibbonButtonBarButtonBase) –
Return type:: None