phoenix_title wx.lib.agw.ribbon.buttonbar.RibbonButtonBarEvent

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

See also

RibbonButtonBar for available event types.


class_hierarchy Class Hierarchy

Inheritance diagram for class RibbonButtonBarEvent:

super_classes Known Superclasses

wx.PyCommandEvent


method_summary Methods Summary

__init__

Default class constructor.

GetBar

Returns the bar which contains 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.


api Class API

class RibbonButtonBarEvent(wx.PyCommandEvent)

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

See also

RibbonButtonBar for available event types.


Methods

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

Default class constructor.

Parameters:
  • command_type (integer) – the event type;

  • win_id (integer) – the event identifier;

  • bar – an instance of RibbonButtonBar.



GetBar(self)

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

Returns:

An instance of RibbonButtonBar.



PopupMenu(self, menu)

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

Parameters:

menu – an instance of wx.Menu.



SetBar(self, bar)

Sets the button bar relating to this event.

Parameters:

bar – an instance of RibbonButtonBar.