VSTGUI  4.4
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
CFrame Class Reference

The CFrame is the parent container of all views. More...

+ Inheritance diagram for CFrame:

Classes

struct  CollectInvalidRects
 

Public Member Functions

 CFrame (const CRect &size, void *pSystemWindow, VSTGUIEditorInterface *pEditor)
 
 CFrame (const CRect &size, VSTGUIEditorInterface *pEditor)
 
void onStartLocalEventLoop ()
 
bool handleNextSystemEvents ()
 
void invalid ()
 mark whole view as invalid More...
 
void invalidRect (const CRect &rect)
 mark rect as invalid More...
 
IPlatformFrame * getPlatformFrame () const
 
bool removeView (CView *pView, bool withForget=true)
 remove a child view More...
 
bool removeAll (bool withForget=true)
 remove all child views More...
 
CViewgetViewAt (const CPoint &where, const GetViewOptions &options=GetViewOptions(GetViewOptions::kNone)) const
 get the view at point where More...
 
CViewContainergetContainerAt (const CPoint &where, const GetViewOptions &options=GetViewOptions(GetViewOptions::kDeep)) const
 get the container at point where More...
 
virtual bool attached (CView *parent)
 view is attached to a parent view More...
 
void draw (CDrawContext *pContext)
 called if the view should draw itself More...
 
void drawRect (CDrawContext *pContext, const CRect &updateRect)
 called if the view should draw itself More...
 
CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons)
 called when a mouse down event occurs More...
 
CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons)
 called when a mouse up event occurs More...
 
CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons)
 called when a mouse move event occurs More...
 
CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons)
 called when the mouse leaves this view More...
 
bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view More...
 
bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view More...
 
int32_t onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus More...
 
int32_t onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus More...
 
DragResult doDrag (IDataPackage *source, const CPoint &offset, CBitmap *dragBitmap)
 start a drag operation. See CDropSource to create the source data package More...
 
void setViewSize (const CRect &rect, bool invalid=true)
 set views size More...
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor More...
 
virtual bool isTypeOf (IdStringPtr s) const
 
virtual CBaseObjectnewCopy () const
 
Focus Drawing Methods [new in 4.0]

If focus drawing is enabled, the focus view will get a focus ring around it defined with the focus width and the focus color.

Views can define their own shape with the IFocusDrawing interface.

virtual void setFocusDrawingEnabled (bool state)
 enable focus drawing More...
 
virtual bool focusDrawingEnabled () const
 is focus drawing enabled More...
 
virtual void setFocusColor (const CColor &color)
 set focus draw color More...
 
virtual CColor getFocusColor () const
 get focus draw color More...
 
virtual void setFocusWidth (CCoord width)
 set focus draw width More...
 
virtual CCoord getFocusWidth () const
 get focus draw width More...
 
- Public Member Functions inherited from CViewContainer
 CViewContainer (const CRect &size)
 
 CViewContainer (const CRect &size, CFrame *pParent, CBitmap *pBackground=0)
 
 CViewContainer (const CViewContainer &viewContainer)
 
virtual bool invalidateDirtyViews ()
 
virtual CRect getVisibleSize (const CRect &rect) const
 
void setTransform (const CGraphicsTransform &t)
 
const CGraphicsTransformgetTransform () const
 
void registerViewContainerListener (IViewContainerListener *listener)
 
void unregisterViewContainerListener (IViewContainerListener *listener)
 
virtual CMouseEventResult onMouseCancel ()
 called when mouse tracking should be canceled More...
 
virtual bool hitTest (const CPoint &where, const CButtonState &buttons=-1)
 check if where hits this view More...
 
virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)
 translates a local coordinate to a global one using parent transforms More...
 
virtual bool onDrop (IDataPackage *drag, const CPoint &where)
 called if a drag is dropped onto this view More...
 
virtual void onDragEnter (IDataPackage *drag, const CPoint &where)
 called if a drag is entering this view More...
 
virtual void onDragLeave (IDataPackage *drag, const CPoint &where)
 called if a drag is leaving this view More...
 
virtual void onDragMove (IDataPackage *drag, const CPoint &where)
 called if a drag is moved inside this view More...
 
virtual void looseFocus ()
 called if view should loose focus More...
 
virtual void takeFocus ()
 called if view should take focus More...
 
virtual bool isDirty () const
 check if view is dirty More...
 
virtual void parentSizeChanged ()
 notification that one of the views parent has changed its size More...
 
virtual bool sizeToFit ()
 resize view to optimal size More...
 
virtual bool removed (CView *parent)
 view is removed from parent view More...
 
virtual CPointframeToLocal (CPoint &point) const
 conversion from frame coordinates to local view coordinates More...
 
virtual CPointlocalToFrame (CPoint &point) const
 conversion from local view coordinates to frame coordinates More...
 
virtual bool addView (CView *pView)
 add a child view More...
 
virtual bool addView (CView *pView, const CRect &mouseableArea, bool mouseEnabled=true)
 add a child view More...
 
virtual bool addView (CView *pView, CView *pBefore)
 add a child view before another view More...
 
virtual bool isChild (CView *pView) const
 check if pView is a child view of this container More...
 
virtual bool isChild (CView *pView, bool deep) const
 check if pView is a child view of this container More...
 
virtual bool hasChildren () const
 check if container has child views More...
 
virtual uint32_t getNbViews () const
 get the number of child views More...
 
virtual CViewgetView (uint32_t index) const
 get the child view at index More...
 
virtual bool getViewsAt (const CPoint &where, ViewList &views, const GetViewOptions &options=GetViewOptions(GetViewOptions::kDeep)) const
 get all views at point where, top->down More...
 
virtual bool changeViewZOrder (CView *view, uint32_t newIndex)
 change view z order position More...
 
virtual void setAutosizingEnabled (bool state)
 enable or disable autosizing subviews. Per default this is enabled. More...
 
bool getAutosizingEnabled () const
 
template<class ViewClass , class ContainerClass >
uint32_t getChildViewsOfType (ContainerClass &result, bool deep=false) const
 get child views of type ViewClass. More...
 
virtual void setBackgroundColor (const CColor &color)
 set the background color (will only be drawn if this container is not set to transparent and does not have a background bitmap) More...
 
virtual CColor getBackgroundColor () const
 get the background color More...
 
virtual void setBackgroundOffset (const CPoint &p)
 set the offset of the background bitmap More...
 
virtual const CPointgetBackgroundOffset () const
 get the offset of the background bitmap More...
 
virtual void drawBackgroundRect (CDrawContext *pContext, const CRect &_updateRect)
 draw the background More...
 
virtual void setBackgroundColorDrawStyle (CDrawStyle style)
 
CDrawStyle getBackgroundColorDrawStyle () const
 
- Public Member Functions inherited from CView
 CView (const CRect &size)
 
 CView (const CView &view)
 
void setSubviewState (bool state)
 
bool isSubview () const
 
CGraphicsTransform getGlobalTransform () const
 
template<typename T >
T & translateToGlobal (T &t) const
 
template<typename T >
translateToGlobal (const T &t) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
T & translateToLocal (T &t) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
translateToLocal (const T &t) const
 translates a global coordinate to a local one using parent transforms More...
 
void beforeDelete ()
 
virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 called when the mouse enters this view More...
 
void setHitTestPath (CGraphicsPath *path)
 
virtual void setMouseEnabled (bool bEnable=true)
 turn on/off mouse usage for this view More...
 
virtual bool getMouseEnabled () const
 get the state of wheather this view uses the mouse or not More...
 
virtual void setMouseableArea (const CRect &rect)
 set the area in which the view reacts to the mouse More...
 
virtual CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse More...
 
virtual const CRectgetMouseableArea () const
 read only access to the mouseable area More...
 
CCoord getHeight () const
 get the height of the view More...
 
CCoord getWidth () const
 get the width of the view More...
 
const CRectgetViewSize () const
 read only access to view size More...
 
virtual CRect getVisibleViewSize () const
 returns the visible size of the view More...
 
virtual void setAutosizeFlags (int32_t flags)
 set autosize flags More...
 
virtual int32_t getAutosizeFlags () const
 get autosize flags More...
 
virtual bool wantsFocus () const
 check if view supports focus More...
 
virtual void setWantsFocus (bool state)
 set focus support on/off More...
 
bool getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
 get the size of an attribute More...
 
bool getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
 get an attribute More...
 
bool setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
 set an attribute More...
 
bool removeAttribute (const CViewAttributeID id)
 remove an attribute More...
 
virtual void setBackground (CBitmap *background)
 set the background image of this view More...
 
CBitmapgetBackground () const
 get the background image of this view More...
 
virtual void setDisabledBackground (CBitmap *background)
 set background image used when the mouse is not enabled More...
 
CBitmapgetDisabledBackground () const
 get background image used when the mouse is not enabled More...
 
CBitmapgetDrawBackground () const
 
virtual void setTransparency (bool val)
 set views transparent state More...
 
virtual bool getTransparency () const
 get views transparent state More...
 
virtual void setAlphaValue (float alpha)
 set alpha value which will be applied when drawing this view More...
 
float getAlphaValue () const
 get alpha value More...
 
bool isAttached () const
 is view attached to a parentView More...
 
CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () const
 get frame More...
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=0)
 
void removeAnimation (IdStringPtr name)
 
void removeAllAnimations ()
 
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
virtual bool checkUpdate (const CRect &updateRect) const
 
virtual void setDirty (bool val=true)
 set the view to dirty so that it is redrawn in the next idle. Thread Safe ! More...
 
virtual void setVisible (bool state)
 set visibility state More...
 
bool isVisible () const
 get visibility state More...
 
virtual void onIdle ()
 called on idle when view wants idle More...
 
void setWantsIdle (bool state)
 enable/disable onIdle() callback More...
 
bool wantsIdle () const
 returns if the view wants idle callback or not More...
 
- Public Member Functions inherited from CBaseObject
 CBaseObject ()
 
virtual ~CBaseObject ()
 
virtual void forget ()
 decrease refcount and delete object if refcount == 0 More...
 
virtual void remember ()
 increase refcount More...
 
virtual int32_t getNbReference () const
 get refcount More...
 

Protected Types

typedef std::list< CView * > ViewList
 
typedef std::list
< IKeyboardHook * > 
KeyboardHookList
 
typedef std::list
< IMouseObserver * > 
MouseObserverList
 
typedef std::list
< IScaleFactorChangedListener * > 
ScaleFactorChangedListenerList
 
- Protected Types inherited from CViewContainer
enum  { kAutosizeSubviews = 1 << (CView::kLastCViewFlag + 1) }
 
- Protected Types inherited from CView
enum  {
  kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3,
  kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kIsSubview = 1 << 7,
  kLastCViewFlag = 7
}
 

Protected Member Functions

 ~CFrame ()
 
void checkMouseViews (const CPoint &where, const CButtonState &buttons)
 
void clearMouseViews (const CPoint &where, const CButtonState &buttons, bool callMouseExit=true)
 
void removeFromMouseViews (CView *view)
 
int32_t keyboardHooksOnKeyDown (const VstKeyCode &key)
 
int32_t keyboardHooksOnKeyUp (const VstKeyCode &key)
 
void callMouseObserverMouseEntered (CView *view)
 
void callMouseObserverMouseExited (CView *view)
 
CMouseEventResult callMouseObserverMouseDown (const CPoint &where, const CButtonState &buttons)
 
CMouseEventResult callMouseObserverMouseMoved (const CPoint &where, const CButtonState &buttons)
 
bool platformDrawRect (CDrawContext *context, const CRect &rect)
 
CMouseEventResult platformOnMouseDown (CPoint &where, const CButtonState &buttons)
 
CMouseEventResult platformOnMouseMoved (CPoint &where, const CButtonState &buttons)
 
CMouseEventResult platformOnMouseUp (CPoint &where, const CButtonState &buttons)
 
CMouseEventResult platformOnMouseExited (CPoint &where, const CButtonState &buttons)
 
bool platformOnMouseWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons)
 
bool platformOnDrop (IDataPackage *drag, const CPoint &where)
 
void platformOnDragEnter (IDataPackage *drag, const CPoint &where)
 
void platformOnDragLeave (IDataPackage *drag, const CPoint &where)
 
void platformOnDragMove (IDataPackage *drag, const CPoint &where)
 
bool platformOnKeyDown (VstKeyCode &keyCode)
 
bool platformOnKeyUp (VstKeyCode &keyCode)
 
void platformOnActivate (bool state)
 
void platformScaleFactorChanged ()
 
void setCollectInvalidRects (CollectInvalidRects *collectInvalidRects)
 
- Protected Member Functions inherited from CViewContainer
 ~CViewContainer ()
 
virtual bool checkUpdateRect (CView *view, const CRect &rect)
 
virtual bool hitTestSubViews (const CPoint &where, const CButtonState buttons=-1)
 
- Protected Member Functions inherited from CView
 ~CView ()
 
CGraphicsPathgetHitTestPath () const
 

Protected Attributes

VSTGUIEditorInterfacepEditor
 
IViewAddedRemovedObserverpViewAddedRemovedObserver
 
CTooltipSupportpTooltips
 
Animation::AnimatorpAnimator
 
CViewpModalView
 
CViewpFocusView
 
CViewpActiveFocusView
 
ViewList pMouseViews
 
bool bActive
 
KeyboardHookListpKeyboardHooks
 
MouseObserverListpMouseObservers
 
ScaleFactorChangedListenerListpScaleFactorChangedListenerList
 
IPlatformFrame * platformFrame
 
CollectInvalidRectscollectInvalidRects
 
- Protected Attributes inherited from CViewContainer
CDrawStyle backgroundColorDrawStyle
 
CColor backgroundColor
 
CPoint backgroundOffset
 
CRect lastDrawnFocus
 
CViewcurrentDragView
 
CViewmouseDownView
 
- Protected Attributes inherited from CView
CRect size
 
CRect mouseableArea
 
CFramepParentFrame
 
CViewpParentView
 
int32_t viewFlags
 
int32_t autosizeFlags
 
float alphaValue
 

CFrame Methods

static int32_t kDefaultKnobMode = kCircularMode
 default knob mode if host does not provide one More...
 
virtual bool open (void *pSystemWindow, PlatformType systemWindowType=kDefaultNative)
 
virtual void close ()
 closes the frame and calls forget More...
 
bool setZoom (double zoomFactor)
 set zoom factor More...
 
virtual void idle ()
 
virtual void doIdleStuff ()
 
virtual uint32_t getTicks () const
 get the current time (in ms) More...
 
virtual int32_t getKnobMode () const
 get hosts knob mode More...
 
virtual bool setPosition (CCoord x, CCoord y)
 repositions the frame More...
 
virtual bool getPosition (CCoord &x, CCoord &y) const
 get global position of frame More...
 
virtual bool setSize (CCoord width, CCoord height)
 set size of frame (and the platform representation) More...
 
virtual bool getSize (CRect *pSize) const
 get size relative to parent More...
 
virtual bool getSize (CRect &pSize) const
 
virtual bool setModalView (CView *pView)
 
virtual CViewgetModalView () const
 
virtual void beginEdit (int32_t index)
 
virtual void endEdit (int32_t index)
 
virtual bool getCurrentMouseLocation (CPoint &where) const
 get current mouse location More...
 
virtual CButtonState getCurrentMouseButtons () const
 get current mouse buttons and key modifiers More...
 
virtual void setCursor (CCursorType type)
 set mouse cursor More...
 
virtual void setFocusView (CView *pView)
 
virtual CViewgetFocusView () const
 
virtual bool advanceNextFocusView (CView *oldFocus, bool reverse=false)
 
virtual void onViewAdded (CView *pView)
 
virtual void onViewRemoved (CView *pView)
 
virtual void onActivate (bool state)
 called when the platform view/window is activated/deactivated More...
 
CDrawContextcreateDrawContext ()
 
virtual void invalidate (const CRect &rect)
 
void scrollRect (const CRect &src, const CPoint &distance)
 scroll src rect by distance More...
 
void enableTooltips (bool state)
 enable or disable tooltips More...
 
Animation::AnimatorgetAnimator ()
 get animator for this frame More...
 
IDataPackagegetClipboard ()
 get the clipboard data. data is owned by the caller More...
 
void setClipboard (IDataPackage *data)
 set the clipboard data. More...
 
virtual IViewAddedRemovedObservergetViewAddedRemovedObserver () const
 
virtual void setViewAddedRemovedObserver (IViewAddedRemovedObserver *observer)
 
void registerKeyboardHook (IKeyboardHook *hook)
 register a keyboard hook More...
 
void unregisterKeyboardHook (IKeyboardHook *hook)
 unregister a keyboard hook More...
 
void registerMouseObserver (IMouseObserver *observer)
 register a mouse observer More...
 
void unregisterMouseObserver (IMouseObserver *observer)
 unregister a mouse observer More...
 
void registerScaleFactorChangedListeneer (IScaleFactorChangedListener *listener)
 
void unregisterScaleFactorChangedListeneer (IScaleFactorChangedListener *listener)
 

Additional Inherited Members

- Public Types inherited from CViewContainer
typedef std::list
< SharedPointer< CView > > 
ViewList
 
typedef ViewList::const_iterator ChildViewConstIterator
 
typedef
ViewList::const_reverse_iterator 
ChildViewConstReverseIterator
 
- Static Public Attributes inherited from CView
static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false. More...
 
static uint32_t idleRate
 global idle rate in Hz, defaults to 30 Hz More...
 

Detailed Description

The CFrame is the parent container of all views.

It creates a platform dependend view object.

On Mac OS X it is a HIView or NSView.
On Windows it's a WS_CHILD Window.

Member Typedef Documentation

typedef std::list<IKeyboardHook*> KeyboardHookList
protected
typedef std::list<IMouseObserver*> MouseObserverList
protected
typedef std::list<CView*> ViewList
protected

Constructor & Destructor Documentation

CFrame ( const CRect inSize,
void *  inSystemWindow,
VSTGUIEditorInterface inEditor 
)
Deprecated:
, use the other constructor and CFrame::open
Parameters
inSizesize of frame
inSystemWindowparent platform window
inEditoreditor
CFrame ( const CRect size,
VSTGUIEditorInterface pEditor 
)
~CFrame ( )
protected

Member Function Documentation

bool advanceNextFocusView ( CView oldFocus,
bool  reverse = false 
)
virtual

Reimplemented from CViewContainer.

bool attached ( CView parent)
virtual

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

Reimplemented from CViewContainer.

void beginEdit ( int32_t  index)
virtual
CMouseEventResult callMouseObserverMouseDown ( const CPoint where,
const CButtonState buttons 
)
protected
void callMouseObserverMouseEntered ( CView view)
protected
void callMouseObserverMouseExited ( CView view)
protected
CMouseEventResult callMouseObserverMouseMoved ( const CPoint where,
const CButtonState buttons 
)
protected
void checkMouseViews ( const CPoint where,
const CButtonState buttons 
)
protected
void clearMouseViews ( const CPoint where,
const CButtonState buttons,
bool  callMouseExit = true 
)
protected
void close ( )
virtual

closes the frame and calls forget

CDrawContext * createDrawContext ( )
Deprecated:
and currently not implemented
DragResult doDrag ( IDataPackage source,
const CPoint offset,
CBitmap dragBitmap 
)
virtual

start a drag operation. See CDropSource to create the source data package

a drag can only be started from within onMouseDown

Parameters
sourcesource drop
offsetbitmap offset
dragBitmapbitmap to drag
Returns
0 on failure, negative if source was moved and positive if source was copied

Reimplemented from CView.

void doIdleStuff ( )
virtual
void draw ( CDrawContext pContext)
virtual

called if the view should draw itself

Parameters
pContextdraw context in which to draw

Reimplemented from CViewContainer.

void drawRect ( CDrawContext pContext,
const CRect updateRect 
)
virtual

called if the view should draw itself

Reimplemented from CViewContainer.

void enableTooltips ( bool  state)

enable or disable tooltips

void endEdit ( int32_t  index)
virtual
bool focusDrawingEnabled ( ) const
virtual

is focus drawing enabled

Animation::Animator * getAnimator ( )

get animator for this frame

IDataPackage * getClipboard ( )

get the clipboard data. data is owned by the caller

CViewContainer * getContainerAt ( const CPoint where,
const GetViewOptions options = GetViewOptions(GetViewOptions::kDeep) 
) const
virtual

get the container at point where

Reimplemented from CViewContainer.

CButtonState getCurrentMouseButtons ( ) const
virtual

get current mouse buttons and key modifiers

Returns
mouse and modifier state
bool getCurrentMouseLocation ( CPoint where) const
virtual

get current mouse location

Parameters
wherelocation of mouse
Returns
true on success
virtual VSTGUIEditorInterface* getEditor ( ) const
inlinevirtual

get editor

Reimplemented from CView.

CColor getFocusColor ( ) const
virtual

get focus draw color

virtual CView* getFocusView ( ) const
inlinevirtual
CCoord getFocusWidth ( ) const
virtual

get focus draw width

int32_t getKnobMode ( ) const
virtual

get hosts knob mode

virtual CView* getModalView ( ) const
inlinevirtual
IPlatformFrame* getPlatformFrame ( ) const
inline
bool getPosition ( CCoord x,
CCoord y 
) const
virtual

get global position of frame

Parameters
xx coordinate
yy coordinate
Returns
true on success
bool getSize ( CRect pRect) const
virtual

get size relative to parent

Parameters
pRectsize
Returns
true on success
bool getSize ( CRect pSize) const
virtual
uint32_t getTicks ( ) const
virtual

get the current time (in ms)

Returns
tick count in milliseconds
virtual IViewAddedRemovedObserver* getViewAddedRemovedObserver ( ) const
inlinevirtual
CView * getViewAt ( const CPoint where,
const GetViewOptions options = GetViewOptions(GetViewOptions::kNone) 
) const
virtual

get the view at point where

Reimplemented from CViewContainer.

bool handleNextSystemEvents ( )
void idle ( )
virtual
void invalid ( )
inlinevirtual

mark whole view as invalid

Reimplemented from CViewContainer.

void invalidate ( const CRect rect)
virtual
void invalidRect ( const CRect rect)
virtual

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented from CViewContainer.

virtual bool isTypeOf ( IdStringPtr  s) const
inlinevirtual

Reimplemented from CViewContainer.

int32_t keyboardHooksOnKeyDown ( const VstKeyCode key)
protected
int32_t keyboardHooksOnKeyUp ( const VstKeyCode key)
protected
virtual CBaseObject* newCopy ( ) const
inlinevirtual

Reimplemented from CViewContainer.

void onActivate ( bool  state)
virtual

called when the platform view/window is activated/deactivated

int32_t onKeyDown ( VstKeyCode keyCode)
virtual

called if a key down event occurs and this view has focus

Parameters
keyCodekey code of pressed key
Returns
-1 if not handled and 1 if handled

Reimplemented from CView.

int32_t onKeyUp ( VstKeyCode keyCode)
virtual

called if a key up event occurs and this view has focus

Parameters
keyCodekey code of pressed key
Returns
-1 if not handled and 1 if handled

Reimplemented from CView.

CMouseEventResult onMouseDown ( CPoint where,
const CButtonState buttons 
)
virtual

called when a mouse down event occurs

Parameters
wheremouse location of mouse down
buttonsbutton and modifier state
Returns
event result. see CMouseEventResult

Reimplemented from CViewContainer.

CMouseEventResult onMouseExited ( CPoint where,
const CButtonState buttons 
)
virtual

called when the mouse leaves this view

Reimplemented from CView.

CMouseEventResult onMouseMoved ( CPoint where,
const CButtonState buttons 
)
virtual

called when a mouse move event occurs

Parameters
wheremouse location of mouse move
buttonsbutton and modifier state
Returns
event result. see CMouseEventResult

Reimplemented from CViewContainer.

CMouseEventResult onMouseUp ( CPoint where,
const CButtonState buttons 
)
virtual

called when a mouse up event occurs

Parameters
wheremouse location of mouse up
buttonsbutton and modifier state
Returns
event result. see CMouseEventResult

Reimplemented from CViewContainer.

void onStartLocalEventLoop ( )
void onViewAdded ( CView pView)
virtual
Parameters
pViewview which was added
void onViewRemoved ( CView pView)
virtual
Parameters
pViewview which was removed
bool onWheel ( const CPoint where,
const float &  distance,
const CButtonState buttons 
)
virtual

called if a mouse wheel event is happening over this view

Parameters
wherelocation
distancewheel distance
buttonsbutton and modifier state
Returns
true if handled

Reimplemented from CViewContainer.

bool onWheel ( const CPoint where,
const CMouseWheelAxis axis,
const float &  distance,
const CButtonState buttons 
)
virtual

called if a mouse wheel event is happening over this view

Parameters
wherelocation
axismouse wheel axis
distancewheel distance
buttonsbutton and modifier state
Returns
true if handled

Reimplemented from CViewContainer.

bool open ( void *  pSystemWindow,
PlatformType  systemWindowType = kDefaultNative 
)
virtual
bool platformDrawRect ( CDrawContext context,
const CRect rect 
)
protected
void platformOnActivate ( bool  state)
protected
void platformOnDragEnter ( IDataPackage drag,
const CPoint where 
)
protected
void platformOnDragLeave ( IDataPackage drag,
const CPoint where 
)
protected
void platformOnDragMove ( IDataPackage drag,
const CPoint where 
)
protected
bool platformOnDrop ( IDataPackage drag,
const CPoint where 
)
protected
bool platformOnKeyDown ( VstKeyCode keyCode)
protected
bool platformOnKeyUp ( VstKeyCode keyCode)
protected
CMouseEventResult platformOnMouseDown ( CPoint where,
const CButtonState buttons 
)
protected
CMouseEventResult platformOnMouseExited ( CPoint where,
const CButtonState buttons 
)
protected
CMouseEventResult platformOnMouseMoved ( CPoint where,
const CButtonState buttons 
)
protected
CMouseEventResult platformOnMouseUp ( CPoint where,
const CButtonState buttons 
)
protected
bool platformOnMouseWheel ( const CPoint where,
const CMouseWheelAxis axis,
const float &  distance,
const CButtonState buttons 
)
protected
void platformScaleFactorChanged ( )
protected
void registerKeyboardHook ( IKeyboardHook hook)

register a keyboard hook

void registerMouseObserver ( IMouseObserver observer)

register a mouse observer

void registerScaleFactorChangedListeneer ( IScaleFactorChangedListener listener)
bool removeAll ( bool  withForget = true)
virtual

remove all child views

Reimplemented from CViewContainer.

void removeFromMouseViews ( CView view)
protected
bool removeView ( CView pView,
bool  withForget = true 
)
virtual

remove a child view

Reimplemented from CViewContainer.

void scrollRect ( const CRect src,
const CPoint distance 
)

scroll src rect by distance

Parameters
srcrect which to scroll
distancepoint of distance
void setClipboard ( IDataPackage data)

set the clipboard data.

void setCollectInvalidRects ( CollectInvalidRects collectInvalidRects)
protected
void setCursor ( CCursorType  type)
virtual

set mouse cursor

Parameters
typecursor type see CCursorType
void setFocusColor ( const CColor color)
virtual

set focus draw color

void setFocusDrawingEnabled ( bool  state)
virtual

enable focus drawing

void setFocusView ( CView pView)
virtual
Parameters
pViewnew focus view
void setFocusWidth ( CCoord  width)
virtual

set focus draw width

bool setModalView ( CView pView)
virtual
Parameters
pViewthe view which should be set to modal.
Returns
true if view could be set as the modal view. false if there is a already a modal view or the view to be set as modal is already attached.
bool setPosition ( CCoord  x,
CCoord  y 
)
virtual

repositions the frame

Parameters
xx coordinate
yy coordinate
Returns
true on success
bool setSize ( CCoord  width,
CCoord  height 
)
virtual

set size of frame (and the platform representation)

Parameters
widthnew width
heightnew height
Returns
true on success
virtual void setViewAddedRemovedObserver ( IViewAddedRemovedObserver observer)
inlinevirtual
void setViewSize ( const CRect newSize,
bool  doInvalid = true 
)
virtual

set views size

Parameters
newSizerect of new size of view
invalidif true set view dirty

Reimplemented from CViewContainer.

bool setZoom ( double  zoomFactor)

set zoom factor

void unregisterKeyboardHook ( IKeyboardHook hook)

unregister a keyboard hook

void unregisterMouseObserver ( IMouseObserver observer)

unregister a mouse observer

void unregisterScaleFactorChangedListeneer ( IScaleFactorChangedListener listener)

Member Data Documentation

bool bActive
protected
CollectInvalidRects* collectInvalidRects
protected
int32_t kDefaultKnobMode = kCircularMode
static

default knob mode if host does not provide one

CView* pActiveFocusView
protected
Animation::Animator* pAnimator
protected
VSTGUIEditorInterface* pEditor
protected
CView* pFocusView
protected
KeyboardHookList* pKeyboardHooks
protected
IPlatformFrame* platformFrame
protected
CView* pModalView
protected
MouseObserverList* pMouseObservers
protected
ViewList pMouseViews
protected
ScaleFactorChangedListenerList* pScaleFactorChangedListenerList
protected
CTooltipSupport* pTooltips
protected
IViewAddedRemovedObserver* pViewAddedRemovedObserver
protected

The documentation for this class was generated from the following files: