View related to an edit controller. More...
#include "vsteditcontroller.h"
Inheritance diagram for Steinberg::Vst::EditorView:
Public Member Functions | |
| EditorView (EditController *controller, ViewRect *size=nullptr) | |
| EditController * | getController () const |
| Gets its controller part. | |
| void | attachedToParent () SMTG_OVERRIDE |
| Calls when this view will be attached to its parent view. | |
| void | removedFromParent () SMTG_OVERRIDE |
| Calls when this view will be removed from its parent view. | |
 Public Member Functions inherited from Steinberg::CPluginView | |
| CPluginView (const ViewRect *rect=nullptr) | |
| const ViewRect & | getRect () const |
| Returns its current frame rectangle. | |
| void | setRect (const ViewRect &r) |
| Sets a new frame rectangle. | |
| bool | isAttached () const |
| Checks if this view is attached to its parent view. | |
| tresult PLUGIN_API | isPlatformTypeSupported (FIDString type) SMTG_OVERRIDE |
| Is Platform UI Type supported. | |
| tresult PLUGIN_API | attached (void *parent, FIDString type) SMTG_OVERRIDE |
| The parent window of the view has been created, the (platform) representation of the view should now be created as well. | |
| tresult PLUGIN_API | removed () SMTG_OVERRIDE |
| The parent window of the view is about to be destroyed. | |
| tresult PLUGIN_API | onWheel (float) SMTG_OVERRIDE |
| Handling of mouse wheel. | |
| tresult PLUGIN_API | onKeyDown (char16, int16, int16) SMTG_OVERRIDE |
| Handling of keyboard events : Key Down. | |
| tresult PLUGIN_API | onKeyUp (char16, int16, int16) SMTG_OVERRIDE |
| Handling of keyboard events : Key Up. | |
| tresult PLUGIN_API | getSize (ViewRect *size) SMTG_OVERRIDE |
| Returns the size of the platform representation of the view. | |
| tresult PLUGIN_API | onSize (ViewRect *newSize) SMTG_OVERRIDE |
| Resizes the platform representation of the view to the given rect. | |
| tresult PLUGIN_API | onFocus (TBool) SMTG_OVERRIDE |
| Focus changed message. | |
| tresult PLUGIN_API | setFrame (IPlugFrame *frame) SMTG_OVERRIDE |
| Sets IPlugFrame object to allow the plug-in to inform the host about resizing. | |
| tresult PLUGIN_API | canResize () SMTG_OVERRIDE |
| Is view sizable by user. | |
| tresult PLUGIN_API | checkSizeConstraint (ViewRect *) SMTG_OVERRIDE |
| On live resize this is called to check if the view can be resized to the given rect, if not adjust the rect to the allowed size. | |
| Public Member Functions inherited from Steinberg::FObject | |
| FObject ()=default | |
| default constructor... | |
| FObject (const FObject &) | |
| FObject & | operator= (const FObject &) |
| overloads operator "=" as the reference assignment | |
| virtual | ~FObject () |
| destructor... | |
| virtual FClassID | isA () const |
| a local alternative to getFClassID () | |
| virtual bool | isA (FClassID s) const |
| evaluates if the passed ID is of the FObject type | |
| virtual bool | isTypeOf (FClassID s, bool=true) const |
| evaluates if the passed ID is of the FObject type | |
| int32 | getRefCount () |
| returns the current interface reference count | |
| FUnknown * | unknownCast () |
| get FUnknown interface from object | |
| tresult PLUGIN_API | queryInterface (const TUID _iid, void **obj) SMTG_OVERRIDE |
| please refer to FUnknown::queryInterface () | |
| uint32 PLUGIN_API | addRef () SMTG_OVERRIDE |
| please refer to FUnknown::addref () | |
| uint32 PLUGIN_API | release () SMTG_OVERRIDE |
| please refer to FUnknown::release () | |
| void PLUGIN_API | update (FUnknown *, int32) SMTG_OVERRIDE |
| empty virtual method that should be overridden by derived classes for data updates upon changes | |
| virtual void | addDependent (IDependent *dep) |
| adds dependency to the object | |
| virtual void | removeDependent (IDependent *dep) |
| removes dependency from the object | |
| virtual void | changed (int32 msg=kChanged) |
| Inform all dependents, that the object has changed. | |
| virtual void | deferUpdate (int32 msg=kChanged) |
| Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates). | |
| virtual void | updateDone (int32) |
| empty virtual method that should be overridden by derived classes | |
| virtual bool | isEqualInstance (FUnknown *d) |
Protected Attributes | |
| IPtr< EditController > | controller |
| Protected Attributes inherited from Steinberg::CPluginView | |
| ViewRect | rect |
| void * | systemWindow |
| IPtr< IPlugFrame > | plugFrame |
| Protected Attributes inherited from Steinberg::FObject | |
| int32 | refCount |
| COM-model local reference count. | |
Additional Inherited Members | |
| Public Types inherited from Steinberg::IDependent | |
| enum | ChangeMessage { kWillChange , kChanged , kDestroyed , kWillDestroy , kStdChangeMessageLast } |
| Static Public Member Functions inherited from Steinberg::FObject | |
| static FClassID | getFClassID () |
| return Class ID as an ASCII string (statically) | |
| static void | setUpdateHandler (IUpdateHandler *handler) |
| set method for the local attribute | |
| static IUpdateHandler * | getUpdateHandler () |
| get method for the local attribute | |
| static bool | classIDsEqual (FClassID ci1, FClassID ci2) |
| compares (evaluates) 2 class IDs | |
| static FObject * | unknownToObject (FUnknown *unknown) |
| pointer conversion from FUnknown to FObject | |
| Static Public Attributes inherited from Steinberg::FObject | |
| static const FUID | iid |
| Special UID that is used to cast an FUnknown pointer to a FObject. | |
| Static Public Attributes inherited from Steinberg::IDependent | |
| static const FUID | iid |
| Static Public Attributes inherited from Steinberg::FUnknown | |
| static const FUID | iid |
| Static Public Attributes inherited from Steinberg::IPlugView | |
| static const FUID | iid |
| Static Protected Attributes inherited from Steinberg::FObject | |
| static IUpdateHandler * | gUpdateHandler |
Detailed Description
View related to an edit controller.
Definition at line 140 of file vsteditcontroller.h.
Constructor & Destructor Documentation
◆ EditorView()
| Steinberg::Vst::EditorView::EditorView | ( | EditController * | controller, |
| ViewRect * | size = nullptr |
||
| ) |
Definition at line 279 of file vsteditcontroller.cpp.
◆ ~EditorView()
|
override |
Definition at line 285 of file vsteditcontroller.cpp.
Member Function Documentation
◆ attachedToParent()
|
virtual |
Calls when this view will be attached to its parent view.
Reimplemented from Steinberg::CPluginView.
Definition at line 295 of file vsteditcontroller.cpp.
◆ getController()
| EditController * Steinberg::Vst::EditorView::getController | ( | ) | const |
Gets its controller part.
Definition at line 148 of file vsteditcontroller.h.
◆ removedFromParent()
|
virtual |
Calls when this view will be removed from its parent view.
Reimplemented from Steinberg::CPluginView.
Definition at line 304 of file vsteditcontroller.cpp.
Member Data Documentation
◆ controller
|
protected |
Definition at line 156 of file vsteditcontroller.h.
The documentation for this class was generated from the following files:
- juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vsteditcontroller.h
- juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vsteditcontroller.cpp