Steinberg::Vst::IContextMenu Class Reference

#include <ivstcontextmenu.h>

Inheritance diagram for Steinberg::Vst::IContextMenu:

Public Types
typedef IContextMenuItem	Item

Public Member Functions
virtual int32 PLUGIN_API	getItemCount ()=0
virtual tresult PLUGIN_API	getItem (int32 index, Item &item, IContextMenuTarget **target)=0
virtual tresult PLUGIN_API	addItem (const Item &item, IContextMenuTarget *target)=0
virtual tresult PLUGIN_API	removeItem (const Item &item, IContextMenuTarget *target)=0
virtual tresult PLUGIN_API	popup (UCoord x, UCoord y)=0
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
virtual uint32 PLUGIN_API	addRef ()=0
virtual uint32 PLUGIN_API	release ()=0

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Detailed Description

Context Menu interface: Vst::IContextMenu

• [host imp]
• [create with IComponentHandler3::createContextMenu(..)]
• [released: 3.5.0]
• [optional]

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 also

IComponentHandler3 for more information.

Member Typedef Documentation

Item

typedef IContextMenuItem Steinberg::Vst::IContextMenu::Item

Member Function Documentation

addItem()

virtual tresult PLUGIN_API Steinberg::Vst::IContextMenu::addItem ( const Item & item, IContextMenuTarget * target )

pure virtual

Adds a menu item and its target.

getItem()

virtual tresult PLUGIN_API Steinberg::Vst::IContextMenu::getItem ( int32 index, Item & item, IContextMenuTarget ** target )

pure virtual

Gets a menu item and its target (target could be not assigned).

getItemCount()

virtual int32 PLUGIN_API Steinberg::Vst::IContextMenu::getItemCount ( )

pure virtual

Gets the number of menu items.

popup()

virtual tresult PLUGIN_API Steinberg::Vst::IContextMenu::popup ( UCoord x, UCoord y )

pure virtual

Pop-ups the menu. Coordinates are relative to the top-left position of the plug-ins view.

removeItem()

virtual tresult PLUGIN_API Steinberg::Vst::IContextMenu::removeItem ( const Item & item, IContextMenuTarget * target )

pure virtual

Removes a menu item.

Member Data Documentation

iid

const FUID Steinberg::Vst::IContextMenu::iid

static

---

The documentation for this class was generated from the following file:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/pluginterfaces/vst/ivstcontextmenu.h