Context Menu Interface. More...
#include <ivstcontextmenu.h>
Data Structures | |
| struct | Item |
| Item is a entry element of the context menu. More... | |
Public Member Functions | |
| virtual int32 | getItemCount ()=0 |
| Gets the number of menu items. | |
| virtual tresult | getItem (int32 index, Item &item, IContextMenuTarget **target)=0 |
| Gets a menu item and its target (target could be not assigned). | |
| virtual tresult | addItem (const Item &item, IContextMenuTarget *target)=0 |
| Adds a menu item and its target. | |
| virtual tresult | removeItem (const Item &item, IContextMenuTarget *target)=0 |
| Removes a menu item. | |
| virtual tresult | popup (UCoord x, UCoord y)=0 |
| Pop-ups the menu. | |
Static Public Attributes | |
| static const FUID | iid |
Context Menu Interface.
A context menu is composed of Item (entry). A Item is defined by a name, a tag, a flag and a associated target (called when this item will be selected/executed). With IContextMenu the Plug-in can retrieve a Item, add a Item, remove a Item and pop-up the menu.
See IComponentHandler3 for more.
| virtual int32 getItemCount | ( | ) | [pure virtual] |
Gets the number of menu items.
| virtual tresult getItem | ( | int32 | index, | |
| Item & | item, | |||
| IContextMenuTarget ** | target | |||
| ) | [pure virtual] |
Gets a menu item and its target (target could be not assigned).
| virtual tresult addItem | ( | const Item & | item, | |
| IContextMenuTarget * | target | |||
| ) | [pure virtual] |
Adds a menu item and its target.
| virtual tresult removeItem | ( | const Item & | item, | |
| IContextMenuTarget * | target | |||
| ) | [pure virtual] |
Removes a menu item.
Pop-ups the menu.
Coordinates are relative to the top-left position of the Plug-ins view.