#include <aeffeditor.h>
Public Member Functions | |
AEffEditor (AudioEffect *effect=0) | |
virtual | ~AEffEditor () |
virtual AudioEffect * | getEffect () |
Returns associated effect instance. | |
virtual bool | getRect (ERect **rect) |
Query editor size as ERect. | |
virtual bool | open (void *ptr) |
Open editor, pointer to parent windows is platform-dependent (HWND on Windows, WindowRef on Mac). | |
virtual void | close () |
Close editor (detach from parent window). | |
virtual bool | isOpen () |
Returns true if editor is currently open. | |
virtual void | idle () |
Idle call supplied by Host application. | |
virtual bool | onKeyDown (VstKeyCode &keyCode) |
Receive key down event. Return true only if key was really used! | |
virtual bool | onKeyUp (VstKeyCode &keyCode) |
Receive key up event. Return true only if key was really used! | |
virtual bool | onWheel (float distance) |
Handle mouse wheel event, distance is positive or negative to indicate wheel direction. | |
virtual bool | setKnobMode (VstInt32 val) |
Set knob mode (if supported by Host). See CKnobMode in VSTGUI. | |
Protected Attributes | |
AudioEffect * | effect |
associated effect instance | |
void * | systemWindow |
platform-dependent parent window (HWND or WindowRef) |
AEffEditor::AEffEditor | ( | AudioEffect * | effect = 0 |
) | [inline] |
effect | Editor class constructor. Requires pointer to associated effect instance. |
virtual AEffEditor::~AEffEditor | ( | ) | [inline, virtual] |
virtual void AEffEditor::close | ( | ) | [inline, virtual] |
Close editor (detach from parent window).
virtual AudioEffect* AEffEditor::getEffect | ( | ) | [inline, virtual] |
Returns associated effect instance.
virtual void AEffEditor::idle | ( | ) | [inline, virtual] |
Idle call supplied by Host application.
virtual bool AEffEditor::isOpen | ( | ) | [inline, virtual] |
Returns true if editor is currently open.
virtual bool AEffEditor::onKeyDown | ( | VstKeyCode & | keyCode | ) | [inline, virtual] |
Receive key down event. Return true only if key was really used!
virtual bool AEffEditor::onKeyUp | ( | VstKeyCode & | keyCode | ) | [inline, virtual] |
Receive key up event. Return true only if key was really used!
virtual bool AEffEditor::onWheel | ( | float | distance | ) | [inline, virtual] |
Handle mouse wheel event, distance is positive or negative to indicate wheel direction.
virtual bool AEffEditor::open | ( | void * | ptr | ) | [inline, virtual] |
Open editor, pointer to parent windows is platform-dependent (HWND on Windows, WindowRef on Mac).
virtual bool AEffEditor::setKnobMode | ( | VstInt32 | val | ) | [inline, virtual] |
Set knob mode (if supported by Host). See CKnobMode in VSTGUI.
AudioEffect* AEffEditor::effect [protected] |
associated effect instance
void* AEffEditor::systemWindow [protected] |
platform-dependent parent window (HWND or WindowRef)