VST 3 Interfaces  VST 3.6.14
SDK for developing VST Plug-in
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages

Edit controller component interface extension. More...

#include <ivsteditcontroller.h>

+ Inheritance diagram for IEditController2:

Public Member Functions

virtual tresult setKnobMode (KnobMode mode)=0
 Host could set the Knob Mode for the Plug-in. More...
 
virtual tresult openHelp (TBool onlyCheck)=0
 Host could ask to open the Plug-in help (could be: opening a PDF document or link to a web page). More...
 
virtual tresult openAboutBox (TBool onlyCheck)=0
 Host could ask to open the Plug-in about box. More...
 
- Public Member Functions inherited from FUnknown
virtual tresult queryInterface (const TUID _iid, void **obj)=0
 
virtual uint32 addRef ()=0
 
virtual uint32 release ()=0
 

Static Public Attributes

static const FUID iid
 
- Static Public Attributes inherited from FUnknown
static const FUID iid
 

Detailed Description

Edit controller component interface extension.

Extension to inform the Plug-in about the host Knob Mode, and to open the Plug-in about box or help documentation.

See also
IEditController

Member Function Documentation

virtual tresult setKnobMode ( KnobMode  mode)
pure virtual

Host could set the Knob Mode for the Plug-in.

Return kResultFalse means not supported mode.

See also
KnobModes.

Implemented in EditController.

virtual tresult openHelp ( TBool  onlyCheck)
pure virtual

Host could ask to open the Plug-in help (could be: opening a PDF document or link to a web page).

The host could call it with onlyCheck set to true for testing support of open Help. Return kResultFalse means not supported function.

Implemented in EditController.

virtual tresult openAboutBox ( TBool  onlyCheck)
pure virtual

Host could ask to open the Plug-in about box.

The host could call it with onlyCheck set to true for testing support of open AboutBox. Return kResultFalse means not supported function.

Implemented in EditController.

Member Data Documentation

const FUID iid
static
Empty

Copyright ©2019 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.