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

Plug-In view default implementation. More...

#include <pluginview.h>

+ Inheritance diagram for CPluginView:

Public Member Functions

 CPluginView (const ViewRect *rect=nullptr)
 
virtual ~CPluginView ()
 
const ViewRectgetRect () const
 Returns its current frame rectangle. More...
 
void setRect (const ViewRect &r)
 Sets a new frame rectangle. More...
 
bool isAttached () const
 Checks if this view is attached to its parent view. More...
 
virtual void attachedToParent ()
 Calls when this view will be attached to its parent view. More...
 
virtual void removedFromParent ()
 Calls when this view will be removed from its parent view. More...
 
tresult isPlatformTypeSupported (FIDString type) SMTG_OVERRIDE
 
tresult attached (void *parent, FIDString type) SMTG_OVERRIDE
 
tresult removed () SMTG_OVERRIDE
 
tresult onWheel (float) SMTG_OVERRIDE
 
tresult onKeyDown (char16, int16, int16) SMTG_OVERRIDE
 
tresult onKeyUp (char16, int16, int16) SMTG_OVERRIDE
 
tresult getSize (ViewRect *size) SMTG_OVERRIDE
 
tresult onSize (ViewRect *newSize) SMTG_OVERRIDE
 
tresult onFocus (TBool) SMTG_OVERRIDE
 
tresult setFrame (IPlugFrame *frame) SMTG_OVERRIDE
 
tresult canResize () SMTG_OVERRIDE
 
tresult checkSizeConstraint (ViewRect *) SMTG_OVERRIDE
 
- Public Member Functions inherited from FUnknown
virtual tresult queryInterface (const TUID _iid, void **obj)=0
 
virtual uint32 addRef ()=0
 
virtual uint32 release ()=0
 

Public Attributes

OBJ_METHODS(CPluginView,
FObject) DEFINE_INTERFACES
DEF_INTERFACE(IPlugView)
END_DEFINE_INTERFACES(FObject)
REFCOUNT_METHODS(FObject)
protected void * 
systemWindow
 
IPlugFrameplugFrame
 

Additional Inherited Members

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

Detailed Description

Plug-In view default implementation.

Can be used as base class for an IPlugView implementation.

Constructor & Destructor Documentation

CPluginView ( const ViewRect rect = nullptr)
virtual ~CPluginView ( )
virtual

Member Function Documentation

const ViewRect& getRect ( ) const
inline

Returns its current frame rectangle.

void setRect ( const ViewRect r)
inline

Sets a new frame rectangle.

bool isAttached ( ) const
inline

Checks if this view is attached to its parent view.

virtual void attachedToParent ( )
inlinevirtual

Calls when this view will be attached to its parent view.

Reimplemented in EditorView.

virtual void removedFromParent ( )
inlinevirtual

Calls when this view will be removed from its parent view.

Reimplemented in EditorView.

tresult isPlatformTypeSupported ( FIDString  type)
virtual

Implements IPlugView.

tresult attached ( void *  parent,
FIDString  type 
)
virtual

Implements IPlugView.

tresult removed ( )
virtual

Implements IPlugView.

tresult onWheel ( float  )
inlinevirtual

Implements IPlugView.

tresult onKeyDown ( char16  ,
int16  ,
int16   
)
inlinevirtual

Implements IPlugView.

tresult onKeyUp ( char16  ,
int16  ,
int16   
)
inlinevirtual

Implements IPlugView.

tresult getSize ( ViewRect size)
virtual

Implements IPlugView.

tresult onSize ( ViewRect newSize)
virtual

Implements IPlugView.

tresult onFocus ( TBool  )
inlinevirtual

Implements IPlugView.

tresult setFrame ( IPlugFrame frame)
inlinevirtual

Implements IPlugView.

tresult canResize ( )
inlinevirtual

Implements IPlugView.

tresult checkSizeConstraint ( ViewRect )
inlinevirtual

Implements IPlugView.

Member Data Documentation

OBJ_METHODS (CPluginView, FObject) DEFINE_INTERFACES DEF_INTERFACE (IPlugView) END_DEFINE_INTERFACES (FObject) REFCOUNT_METHODS(FObject) protected void* systemWindow
IPlugFrame* plugFrame
Empty

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