RibbonToolBarEvent

Handles events related to RibbonToolBar.

Inheritance Diagram

Inheritance diagram for class RibbonToolBarEvent

Known Superclasses

PyCommandEvent

Methods Summary

__init__	Default class constructor.
GetBar	Returns an instance of RibbonToolBar.
PopupMenu	Pops up the given menu and returns control when the user has dismissed the menu.
SetBar	Sets the current RibbonToolBar for this event.

Class API

---

class RibbonToolBarEvent(PyCommandEvent)

Handles events related to RibbonToolBar.

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 RibbonToolBar.

---

GetBar(self)

Returns an instance of RibbonToolBar.

---

PopupMenu(self, menu)

Pops up the given menu and returns control when the user has dismissed the menu.

If a menu item is selected, the corresponding menu event is generated and will be processed as usual.

Parameters:menu – the menu to pop up, an instance of Menu.

Note

Just before the menu is popped up, Menu.UpdateUI is called to ensure that the menu items are in the correct state. The menu does not get deleted by the window.

---

SetBar(self, bar)

Sets the current RibbonToolBar for this event.

Parameters:bar – an instance of RibbonToolBar.