Context Menu interface: Vst::IContextMenu. More...

#include "ivstcontextmenu.h"

Inheritance diagram for Steinberg::Vst::IContextMenu:

Public Types
typedef IContextMenuItem	Item

Public Member Functions
virtual int32 PLUGIN_API	getItemCount ()=0
	Gets the number of menu items.

virtual tresult PLUGIN_API	getItem (int32 index, Item &item, IContextMenuTarget **target)=0
	Gets a menu item and its target (target could be not assigned).

virtual tresult PLUGIN_API	addItem (const Item &item, IContextMenuTarget *target)=0
	Adds a menu item and its target.

virtual tresult PLUGIN_API	removeItem (const Item &item, IContextMenuTarget *target)=0
	Removes a menu item.

virtual tresult PLUGIN_API	popup (UCoord x, UCoord y)=0
	Pop-ups the menu.

Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
	Query for a pointer to the specified interface.

virtual uint32 PLUGIN_API	addRef ()=0
	Adds a reference and returns the new reference count.

virtual uint32 PLUGIN_API	release ()=0
	Releases a reference and returns the new reference count.

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.

Definition at line 187 of file ivstcontextmenu.h.

Member Typedef Documentation

◆ Item

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

Definition at line 190 of file ivstcontextmenu.h.

Member Function Documentation

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

Member Data Documentation

◆ iid

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

static

Definition at line 208 of file ivstcontextmenu.h.

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

juce_audio_processors/format_types/VST3_SDK/pluginterfaces/vst/ivstcontextmenu.h

Public Types

Public Member Functions