ags_vst_icontext_menu.cpp File Reference

#include <ags/vst3-capi/pluginterfaces/vst/ags_vst_icontext_menu.h>
#include <pluginterfaces/vst/ivstcontextmenu.h>

Include dependency graph for ags_vst_icontext_menu.cpp:

Functions
const AgsVstTUID *	ags_vst_icomponent_handler3_get_iid ()
AgsVstIContextMenu *	ags_vst_icomponent_handler3_create_context_menu (AgsVstIComponentHandler3 *icomponent_handler3, AgsVstIPlugView *plug_view, AgsVstParamID *param_id)
const AgsVstTUID *	ags_vst_icontext_menu_target_get_iid ()
AgsVstTResult	ags_vst_icontext_menu_target_execute_menu_item (AgsVstIContextMenuTarget *icontext_menu_target, gint32 tag)
const AgsVstTUID *	ags_vst_icontext_menu_get_iid ()
gint32	ags_vst_icontext_menu_get_item_count (AgsVstIContextMenu *icontext_menu)
AgsVstTResult	ags_vst_icontext_menu_get_item (AgsVstIContextMenu *icontext_menu, gint32 index, AgsVstItem *item, AgsVstIContextMenuTarget **target)
AgsVstTResult	ags_vst_icontext_menu_add_item (AgsVstIContextMenu *icontext_menu, AgsVstItem *item, AgsVstIContextMenuTarget *target)
AgsVstTResult	ags_vst_icontext_menu_remove_item (AgsVstIContextMenu *icontext_menu, AgsVstItem *item, AgsVstIContextMenuTarget *target)
AgsVstTResult	ags_vst_icontext_menu_popup (AgsVstIContextMenu *icontext_menu, AgsVstUCoord x, AgsVstUCoord y)

Function Documentation

ags_vst_icomponent_handler3_create_context_menu()

AgsVstIContextMenu * ags_vst_icomponent_handler3_create_context_menu	(	AgsVstIComponentHandler3 *	icomponent_handler3,
		AgsVstIPlugView *	plug_view,
		AgsVstParamID *	param_id
	)

Create context menu.

Parameters

icomponent_handler3	the icomponent handler
plug_view	the plug-view
param_id	the parameter identifier

Returns

the AgsVstIContextMenu

Since

5.0.0

ags_vst_icomponent_handler3_get_iid()

const AgsVstTUID * ags_vst_icomponent_handler3_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstFUID

Since

5.0.0

ags_vst_icontext_menu_add_item()

AgsVstTResult ags_vst_icontext_menu_add_item	(	AgsVstIContextMenu *	icontext_menu,
		AgsVstItem *	item,
		AgsVstIContextMenuTarget *	target
	)

Add item.

Parameters

icontext_menu	the icontext menu
item	the item
target	the context menu target

Returns

the return value

Since

5.0.0

ags_vst_icontext_menu_get_iid()

const AgsVstTUID * ags_vst_icontext_menu_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstFUID

Since

5.0.0

ags_vst_icontext_menu_get_item()

AgsVstTResult ags_vst_icontext_menu_get_item	(	AgsVstIContextMenu *	icontext_menu,
		gint32	index,
		AgsVstItem *	item,
		AgsVstIContextMenuTarget **	target
	)

Get item count.

Parameters

icontext_menu	the icontext menu
index	the index
item	the item
target	the context menu target

Returns

the return value

Since

5.0.0

ags_vst_icontext_menu_get_item_count()

gint32 ags_vst_icontext_menu_get_item_count

(

AgsVstIContextMenu *

icontext_menu

)

Get item count.

Parameters

icontext_menu

the icontext menu

Returns

the item count

Since

5.0.0

ags_vst_icontext_menu_popup()

AgsVstTResult ags_vst_icontext_menu_popup	(	AgsVstIContextMenu *	icontext_menu,
		AgsVstUCoord	x,
		AgsVstUCoord	y
	)

Popup.

Parameters

icontext_menu	the icontext menu
x	the x-coordinate
y	the y-coordinate

Returns

the return value

Since

5.0.0

ags_vst_icontext_menu_remove_item()

AgsVstTResult ags_vst_icontext_menu_remove_item	(	AgsVstIContextMenu *	icontext_menu,
		AgsVstItem *	item,
		AgsVstIContextMenuTarget *	target
	)

Remove item.

Parameters

icontext_menu	the icontext menu
item	the item
target	the context menu target

Returns

the return value

Since

5.0.0

ags_vst_icontext_menu_target_execute_menu_item()

AgsVstTResult ags_vst_icontext_menu_target_execute_menu_item	(	AgsVstIContextMenuTarget *	icontext_menu_target,
		gint32	tag
	)

ags_vst_icontext_menu_target_get_iid()

const AgsVstTUID * ags_vst_icontext_menu_target_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstFUID

Since

5.0.0