VSTGUI: CFrame Class Reference

VSTGUI 4.10 Graphical User Interface Framework not only for VST plugins

Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
CFrame Class Referencefinal
Views » Container Views

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

`#include <cframe.h>`

Inheritance diagram for CFrame:

## Classes
struct | CollectInvalidRects
struct | Impl

## Public Member Functions
| CFrame (const CRect &size, VSTGUIEditorInterface *pEditor)
Public Member Functions inherited from CViewContainer
| CViewContainer (const CRect &size)
| CViewContainer constructor.
| CViewContainer (const CViewContainer &viewContainer)
bool | addView (CView *pView, const CRect &mouseableArea, bool mouseEnabled=true)
| add a child view
virtual bool | addView (CView *pView, CView *pBefore=nullptr)
| add a child view before another view
bool | isChild (CView *pView) const
| check if pView is a child view of this container
virtual bool | isChild (CView *pView, bool deep) const
| check if pView is a child view of this container
virtual bool | hasChildren () const
| check if container has child views
virtual uint32_t | getNbViews () const
| get the number of child views
virtual CView * | getView (uint32_t index) const
| get the child view at index
virtual bool | changeViewZOrder (CView *view, uint32_t newIndex)
| change view z order position
virtual void | setAutosizingEnabled (bool state)
| enable or disable autosizing subviews.
bool | getAutosizingEnabled () const
template<class ViewClass, class ContainerClass>
uint32_t | getChildViewsOfType (ContainerClass &result, bool deep=false) const
| get child views of type ViewClass.
template<typename Proc>
void | forEachChild (Proc proc) const
| execute proc for each child view
template<typename Proc>
CView * | findFirstViewIf (Proc filter) const
void | setViewLayouter (const SharedPointer< IViewLayouter > &layouter)
| set a view layouter
SharedPointer< IViewLayouter > | getViewLayouter () const
| get the current view layouter
std::optional< ViewLayout > | calculateViewLayout (const CRect &newSize) const
| calculate the view layout for the new size
bool | applyViewLayout (const ViewLayout &layout)
| apply a previously calculated view layout
bool | inApplyViewLayout () const
| check if a view layout is currently applied
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)
virtual CColor | getBackgroundColor () const
| get the background color
virtual void | setBackgroundOffset (const CPoint &p)
| set the offset of the background bitmap
virtual CPoint | getBackgroundOffset () const
| get the offset of the background bitmap
virtual void | drawBackgroundRect (CDrawContext *pContext, const CRect &_updateRect)
| draw the background
virtual void | setBackgroundColorDrawStyle (CDrawStyle style)
CDrawStyle | getBackgroundColorDrawStyle () const
void | setInitialFocusView (CView *view)
| set custom initial focus view which is first focused when advanceNextFocusView is called without oldFocus view
CView * | getInitialFocusView () const
| get custom initial focus view
virtual bool | invalidateDirtyViews ()
virtual CRect | getVisibleSize (const CRect &rect) const
void | setTransform (const CGraphicsTransform &t)
const CGraphicsTransform & | getTransform () const
void | registerViewContainerListener (IViewContainerListener *listener)
void | unregisterViewContainerListener (IViewContainerListener *listener)
void | draw (CDrawContext *pContext) override
void | drawRect (CDrawContext *pContext, const CRect &updateRect) override
void | onMouseDownEvent (MouseDownEvent &event) override
| called when a mouse down event occurs
void | onMouseMoveEvent (MouseMoveEvent &event) override
| called when a mouse move event occurs
void | onMouseUpEvent (MouseUpEvent &event) override
| called when a mouse up event occurs
void | onMouseCancelEvent (MouseCancelEvent &event) override
| called when mouse tracking should be canceled
void | onMouseWheelEvent (MouseWheelEvent &event) override
| called when a mouse wheel event occurs
void | onZoomGestureEvent (ZoomGestureEvent &event) override
| called when a zoom gesture event occurs
CMessageResult | notify (CBaseObject *sender, IdStringPtr message) override
bool | onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons) final
SharedPointer< IDropTarget > | getDropTarget () override
| get the drag target for drag and drop handling
void | looseFocus () override
| called if view should loose focus
void | takeFocus () override
| called if view should take focus
bool | isDirty () const override
| check if view is dirty
void | invalid () override
| mark whole view as invalid
void | invalidRect (const CRect &rect) override
| mark rect as invalid
void | setViewSize (const CRect &rect, bool invalid=true) override
void | parentSizeChanged () override
| notification that one of the views parent has changed its size
bool | sizeToFit () override
| resize view to optimal size
bool | removed (CView *parent) override
| view is removed from parent view
bool | attached (CView *parent) override
| view is attached to a parent view
CPoint & | frameToLocal (CPoint &point) const override
| conversion from frame coordinates to local view coordinates
CPoint & | localToFrame (CPoint &point) const override
| conversion from local view coordinates to frame coordinates
CBaseObject * | newCopy () const override
CViewContainer * | asViewContainer () final
const CViewContainer * | asViewContainer () const final
Public Member Functions inherited from CView
| CView (const CRect &size)
| CView (const CView &view)
uint64_t | getRuntimeID () const
| get the unique runtime ID
virtual void | onMouseEnterEvent (MouseEnterEvent &event)
| called when the mouse enters this view
virtual void | onMouseExitEvent (MouseExitEvent &event)
| called when the mouse leaves this view
virtual void | setMouseEnabled (bool bEnable=true)
| turn on/off mouse usage for this view
bool | getMouseEnabled () const
| get the state of wheather this view uses the mouse or not
virtual void | setMouseableArea (const CRect &rect)
| set the area in which the view reacts to the mouse
CRect | getMouseableArea () const
| get the area in which the view reacts to the mouse
virtual CMouseEventResult | onMouseDown (CPoint &where, const CButtonState &buttons)
| do not use any longer.
virtual CMouseEventResult | onMouseUp (CPoint &where, const CButtonState &buttons)
| do not use any longer.
virtual CMouseEventResult | onMouseMoved (CPoint &where, const CButtonState &buttons)
| do not use any longer.
virtual CMouseEventResult | onMouseCancel ()
| do not use any longer.
virtual CMouseEventResult | onMouseEntered (CPoint &where, const CButtonState &buttons)
| do not use any longer.
virtual CMouseEventResult | onMouseExited (CPoint &where, const CButtonState &buttons)
| do not use any longer.
virtual bool | onWheel (const CPoint &where, const float &distance, const CButtonState &buttons) final
CRect & | getMouseableArea (CRect &rect) const
| get the area in which the view reacts to the mouse
void | setHitTestPath (CGraphicsPath *path)
virtual bool | hitTest (const CPoint &where, const Event &event=noEvent())
| check if where hits this view
virtual bool | hitTest (const CPoint &where, const CButtonState &buttons)
bool | doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})
| start a drag operation
void | setDropTarget (const SharedPointer< IDropTarget > &dt)
| set a custom drop target
DragResult | doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
| a drag can only be started from within onMouseDown
virtual void | onKeyboardEvent (KeyboardEvent &event)
| called when a keyboard event is dispatched to this view
virtual int32_t | onKeyDown (VstKeyCode &keyCode)
| called if a key down event occurs and this view has focus
virtual int32_t | onKeyUp (VstKeyCode &keyCode)
| called if a key up event occurs and this view has focus
CCoord | getHeight () const
| get the height of the view
CCoord | getWidth () const
| get the width of the view
const CRect & | getViewSize () const
| read only access to view size
virtual CRect | getVisibleViewSize () const
| returns the visible size of the view
virtual void | setAutosizeFlags (int32_t flags)
| set autosize flags
int32_t | getAutosizeFlags () const
| get autosize flags
virtual bool | wantsFocus () const
| check if view supports focus
virtual void | setWantsFocus (bool state)
| set focus support on/off
bool | getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
| get the size of an attribute
bool | getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
| get an attribute
bool | setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
| set an attribute
bool | removeAttribute (const CViewAttributeID id)
| remove an attribute
template<typename T>
bool | setAttribute (const CViewAttributeID id, const T &data)
| set an attribute
template<typename T>
bool | getAttribute (const CViewAttributeID id, T &data) const
| get an attribute
virtual void | setBackground (CBitmap *background)
| set the background image of this view
CBitmap * | getBackground () const
| get the background image of this view
virtual void | setDisabledBackground (CBitmap *background)
| set background image used when the mouse is not enabled
CBitmap * | getDisabledBackground () const
| get background image used when the mouse is not enabled
CBitmap * | getDrawBackground () const
| get the bitmap which is drawn depending on the enabled state.
virtual void | setTransparency (bool val)
| set views transparent state
bool | getTransparency () const
| get views transparent state
virtual void | setAlphaValue (float alpha)
| set alpha value which will be applied when drawing this view
float | getAlphaValue () const
| get alpha value
bool | isAttached () const
| is view attached to a parentView
void | setSubviewState (bool state)
bool | isSubview () const
CView * | getParentView () const
| get parent view
CFrame * | getFrame () const
| get frame
void | addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject)
void | addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, const Animation::DoneFunction &doneFunc=nullptr, bool callDoneOnCancel=false)
void | removeAnimation (IdStringPtr name)
void | removeAllAnimations ()
void | registerViewListener (IViewListener *listener)
void | unregisterViewListener (IViewListener *listener)
void | registerViewEventListener (IViewEventListener *listener)
void | unregisterViewEventListener (IViewEventListener *listener)
void | registerViewMouseListener (IViewMouseListener *listener)
void | unregisterViewMouseListener (IViewMouseListener *listener)
CGraphicsTransform | getGlobalTransform (bool ignoreFrame=false) const
| get the active global transform for this view
template<typename T>
T & | translateToGlobal (T &t, bool ignoreFrame=false) const
| translates a local coordinate to a global one using parent transforms
template<typename T>
T | translateToGlobal (const T &t, bool ignoreFrame=false) const
| translates a local coordinate to a global one using parent transforms
template<typename T>
T & | translateToLocal (T &t, bool ignoreFrame=false) const
| translates a global coordinate to a local one using parent transforms
template<typename T>
T | translateToLocal (const T &t, bool ignoreFrame=false) const
| translates a local coordinate to a global one using parent transforms
CMouseEventResult | callMouseListener (MouseListenerCall type, CPoint pos, CButtonState buttons)
void | callMouseListenerEnteredExited (bool mouseEntered)
CBaseObject * | newCopy () const override
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.
virtual void | setVisible (bool state)
| set visibility state
bool | isVisible () const
| get visibility state
virtual void | onIdle ()
| called on idle when view wants idle
void | setWantsIdle (bool state)
| enable/disable onIdle() callback
bool | wantsIdle () const
| returns if the view wants idle callback or not
virtual bool | wantsWindowActiveStateChangeNotification () const
| whether this view wants to be informed if the window's active state changes
virtual void | onWindowActivate (bool state)
| called when the active state of the window changes
void | setTooltipText (UTF8StringPtr text)
Public Member Functions inherited from CBaseObject
| CBaseObject ()=default
| ~CBaseObject () noexcept override=default
| CBaseObject (const CBaseObject &)
CBaseObject & | operator= (const CBaseObject &)
Public Member Functions inherited from ReferenceCounted< int32_t >
| ReferenceCounted ()=default
virtual | ~ReferenceCounted () noexcept=default
| ReferenceCounted (const ReferenceCounted &)
ReferenceCounted & | operator= (const ReferenceCounted &)
| ReferenceCounted ()=default
| ReferenceCounted (const ReferenceCounted &)
virtual | ~ReferenceCounted () noexcept=default
ReferenceCounted & | operator= (const ReferenceCounted &)
void | forget () override
| decrease refcount and delete object if refcount == 0
void | remember () override
| increase refcount
virtual int32_t | getNbReference () const
| get refcount
void | forget () override
| decrease refcount and delete object if refcount == 0
void | remember () override
| increase refcount
virtual int32_t | getNbReference () const
| get refcount

## 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.
using | EventProcessingFunction = std::function<void ()>
void | setFocusDrawingEnabled (bool state)
| enable focus drawing
bool | focusDrawingEnabled () const
| is focus drawing enabled
void | setFocusColor (const CColor &color)
| set focus draw color
CColor | getFocusColor () const
| get focus draw color
void | setFocusWidth (CCoord width)
| set focus draw width
CCoord | getFocusWidth () const
| get focus draw width
bool | doAfterEventProcessing (EventProcessingFunction &&func)
| Queue a function which will be executed after the current event was handled.
bool | doAfterEventProcessing (const EventProcessingFunction &func)
| Queue a function which will be executed after the current event was handled.
bool | inEventProcessing () const
| Returns true if an event is currently being processed.
void | onStartLocalEventLoop ()
bool | performDrag (const DragDescription &desc, const SharedPointer< IDragCallback > &callback)
void | invalid () override
| mark whole view as invalid
void | invalidRect (const CRect &rect) override
| mark rect as invalid
bool | removeView (CView *pView, bool withForget=true) override
| remove a child view
bool | removeAll (bool withForget=true) override
| remove all child views
CView * | getViewAt (const CPoint &where, const GetViewOptions &options=GetViewOptions()) const override
| get the view at point where
CViewContainer * | getContainerAt (const CPoint &where, const GetViewOptions &options=GetViewOptions().deep()) const override
| get the container at point where
bool | getViewsAt (const CPoint &where, ViewList &views, const GetViewOptions &options=GetViewOptions().deep()) const override
| get all views at point where, top->down
bool | hitTestSubViews (const CPoint &where, const Event &event) override
CPoint & | frameToLocal (CPoint &point) const override
| conversion from frame coordinates to local view coordinates
CPoint & | localToFrame (CPoint &point) const override
| conversion from local view coordinates to frame coordinates
bool | attached (CView *parent) override
| view is attached to a parent view
void | draw (CDrawContext *pContext) override
| called if the view should draw itself
void | drawRect (CDrawContext *pContext, const CRect &updateRect) override
| called if the view should draw itself
void | setViewSize (const CRect &rect, bool invalid=true) override
| set views size
void | dispatchEvent (Event &event) override
| dispatch an event
VSTGUIEditorInterface * | getEditor () const override
| get editor
IPlatformFrame * | getPlatformFrame () const
CBaseObject * | newCopy () const override
| CFrame (const CFrame &)=delete
| ~CFrame () noexcept override=default
void | beforeDelete () override
void | checkMouseViews (const MouseEvent &event)
void | clearMouseViews (const CPoint &where, Modifiers modifiers, bool callMouseExit=true)
void | removeFromMouseViews (CView *view)
void | setCollectInvalidRects (CollectInvalidRects *collectInvalidRects)
void | dispatchKeyboardEventToHooks (KeyboardEvent &event)
void | callMouseObserverMouseEntered (CView *view)
void | callMouseObserverMouseExited (CView *view)
void | callMouseObserverOtherMouseEvent (MouseEvent &event)
void | dispatchNewScaleFactor (double newScaleFactor)
void | platformDrawRects (const PlatformGraphicsDeviceContextPtr &context, double scaleFactor, const std::vector< CRect > &rects) override
void | platformOnEvent (Event &event) override
DragOperation | platformOnDragEnter (DragEventData data) override
DragOperation | platformOnDragMove (DragEventData data) override
void | platformOnDragLeave (DragEventData data) override
bool | platformOnDrop (DragEventData data) override
void | platformOnActivate (bool state) override
void | platformOnWindowActivate (bool state) override
void | platformScaleFactorChanged (double newScaleFactor) override

## CFrame Methods
static int32_t | kDefaultKnobMode = kCircularMode
| default knob mode if host does not provide one
bool | open (void *pSystemWindow, PlatformType systemWindowType=PlatformType::kDefaultNative, IPlatformFrameConfig *=nullptr)
void | close ()
| closes the frame and calls forget
bool | setZoom (double zoomFactor)
| set zoom factor
double | getZoom () const
| get zoom factor
void | setBitmapInterpolationQuality (BitmapInterpolationQuality quality)
| set interpolation quality for bitmaps
BitmapInterpolationQuality | getBitmapInterpolationQuality () const
| get interpolation quality for bitmaps
double | getScaleFactor () const
void | idle ()
uint64_t | getTicks () const
| get the current time (in ms)
int32_t | getKnobMode () const
| get hosts knob mode
bool | setPosition (CCoord x, CCoord y)
| repositions the frame
bool | getPosition (CCoord &x, CCoord &y) const
| get global position of frame
bool | setSize (CCoord width, CCoord height)
| set size of frame (and the platform representation)
bool | getSize (CRect *pSize) const
| get size relative to parent
bool | getSize (CRect &pSize) const
CPoint | checkSizeConstraint (const CPoint &newSize) const
bool | setModalView (CView *pView)
| set a modal view.
CView * | getModalView () const
| get the currently active modal view or nullptr if there is none
Optional< ModalViewSessionID > | beginModalViewSession (CView *view)
| begin a new modal view session
bool | endModalViewSession (ModalViewSessionID session)
| end a modal view session
void | beginEdit (int32_t index)
void | endEdit (int32_t index)
bool | getCurrentMouseLocation (CPoint &where) const
| get current mouse location
CButtonState | getCurrentMouseButtons () const
| get current mouse buttons and key modifiers
void | setCursor (CCursorType type)
| set mouse cursor
void | setFocusView (CView *pView)
CView * | getFocusView () const
bool | advanceNextFocusView (CView *oldFocus, bool reverse=false) override
void | onViewAdded (CView *pView)
void | onViewRemoved (CView *pView)
void | onActivate (bool state)
| called when the platform view/window is activated/deactivated
void | invalidate (const CRect &rect)
void | scrollRect (const CRect &src, const CPoint &distance)
| scroll src rect by distance
void | enableTooltips (bool state, uint32_t delayTimeInMs=1000)
| enable or disable tooltips
Animation::Animator * | getAnimator ()
| get animator for this frame
SharedPointer< IDataPackage > | getClipboard ()
| get the clipboard data.
void | setClipboard (const SharedPointer< IDataPackage > &data)
| set the clipboard data.
IViewAddedRemovedObserver * | getViewAddedRemovedObserver () const
void | setViewAddedRemovedObserver (IViewAddedRemovedObserver *observer)
void | registerKeyboardHook (IKeyboardHook *hook)
| register a keyboard hook
void | unregisterKeyboardHook (IKeyboardHook *hook)
| unregister a keyboard hook
void | registerMouseObserver (IMouseObserver *observer)
| register a mouse observer
void | unregisterMouseObserver (IMouseObserver *observer)
| unregister a mouse observer
void | registerScaleFactorChangedListeneer (IScaleFactorChangedListener *listener)
void | unregisterScaleFactorChangedListeneer (IScaleFactorChangedListener *listener)
void | registerScaleFactorChangedListener (IScaleFactorChangedListener *listener)
void | unregisterScaleFactorChangedListener (IScaleFactorChangedListener *listener)
void | registerFocusViewObserver (IFocusViewObserver *observer)
void | unregisterFocusViewObserver (IFocusViewObserver *observer)

## Additional Inherited Members
Public Types inherited from CViewContainer
using | ViewList = std::list<SharedPointer<CView>>
using | ChildViewConstIterator = ViewList::const_iterator
using | ChildViewConstReverseIterator = ViewList::const_reverse_iterator
enum class | MouseListenerCall { MouseDown , MouseMoved , MouseUp , MouseCancel }
static bool | kDirtyCallAlwaysOnMainThread = false
| if this is true, setting a view dirty will call invalid() instead of checking it in idle.
static uint32_t | idleRate = 30
| global idle rate in Hz, defaults to 30 Hz
Protected Types inherited from CViewContainer
enum | { kAutosizeSubviews = 1 << (CView::kLastCViewFlag + 1) , kInApplyLayout = 1 << (CView::kLastCViewFlag + 2) }
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 , kHasAlpha = 1 << 8 , kHasBackground = 1 << 9 , kHasDisabledBackground = 1 << 10 , kHasMouseableArea = 1 << 11 , kLastCViewFlag = 11 }
| ~CViewContainer () noexcept override
void | beforeDelete () override
virtual bool | checkUpdateRect (CView *view, const CRect &rect)
| check if view needs to be updated for rect
void | setMouseDownView (CView *view)
CView * | getMouseDownView () const
const ViewList & | getChildren () const
| ~CView () noexcept override
CGraphicsPath * | getHitTestPath () const
bool | hasViewFlag (int32_t bit) const
void | setViewFlag (int32_t bit, bool state)
void | setAlphaValueNoInvalidate (float value)
void | setParentFrame (CFrame *frame)
void | setParentView (CView *parent)

## 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

## ◆ EventProcessingFunction

using EventProcessingFunction = std::function<void ()>

## Constructor & Destructor Documentation

## ◆ CFrame() [1/2]

CFrame | ( | const CRect & | size,
|  | VSTGUIEditorInterface * | pEditor )

## ◆ CFrame() [2/2]

CFrame | ( | const CFrame & |  | ) |
| protecteddelete

## ◆ ~CFrame()

~CFrame | ( |  | ) |
| overrideprotecteddefaultnoexcept

## Member Function Documentation

## ◆ advanceNextFocusView()

bool advanceNextFocusView | ( | CView * | oldFocus,
|  | bool | reverse = false )
| overridevirtual

Parameters

  oldFocus | old focus view
  reverse | search order

Returns
  true on success

Reimplemented from CViewContainer.

## ◆ attached()

bool attached | ( | CView * | parent | ) |
| overridevirtual

view is attached to a parent view

Parameters

  parent | parent view

Returns
  true if view successfully attached to parent

Reimplemented from CView.

## ◆ beforeDelete()

void beforeDelete | ( |  | ) |
| overrideprotectedvirtual

Reimplemented from ReferenceCounted< int32_t >.

## ◆ beginEdit()

void beginEdit | ( | int32_t | index | ) |

## ◆ beginModalViewSession()

Optional< ModalViewSessionID > beginModalViewSession | ( | CView * | view | ) |

begin a new modal view session

A modal view session is active until endModalViewSession is called and in that time all UI events are only dispatched to the modal view or its child views. Modal view sessions can be stacked but must be ended in the same order.

Parameters

  view | new modal view (ownership is transfered to frame, the same as addView)

Returns
  a unique session identifier

## ◆ callMouseObserverMouseEntered()

void callMouseObserverMouseEntered | ( | CView * | view | ) |
| protected

## ◆ callMouseObserverMouseExited()

void callMouseObserverMouseExited | ( | CView * | view | ) |
| protected

## ◆ callMouseObserverOtherMouseEvent()

void callMouseObserverOtherMouseEvent | ( | MouseEvent & | event | ) |
| protected

## ◆ checkMouseViews()

void checkMouseViews | ( | const MouseEvent & | event | ) |
| protected

## ◆ checkSizeConstraint()

CPoint checkSizeConstraint | ( | const CPoint & | newSize | ) | const

## ◆ clearMouseViews()

void clearMouseViews | ( | const CPoint & | where,
|  | Modifiers | modifiers,
|  | bool | callMouseExit = true )
| protected

## ◆ close()

void close | ( |  | ) |

closes the frame and calls forget

## ◆ dispatchEvent()

void dispatchEvent | ( | Event & | event | ) |
| overridevirtual

dispatch an event

the event is then dispatched to the event listeners and then to one of the event methods.

Reimplemented from CView.

## ◆ dispatchKeyboardEventToHooks()

void dispatchKeyboardEventToHooks | ( | KeyboardEvent & | event | ) |
| protected

## ◆ dispatchNewScaleFactor()

void dispatchNewScaleFactor | ( | double | newScaleFactor | ) |
| protected

## ◆ doAfterEventProcessing() [1/2]

bool doAfterEventProcessing | ( | const EventProcessingFunction & | func | ) |

Queue a function which will be executed after the current event was handled.

Only allowed when inEventProcessing () is true

Parameters

  func | Function to execute

Returns
  true if the function was added to the execution queue

## ◆ doAfterEventProcessing() [2/2]

bool doAfterEventProcessing | ( | EventProcessingFunction && | func | ) |

Queue a function which will be executed after the current event was handled.

Only allowed when inEventProcessing () is true

Parameters

  func | Function to execute

Returns
  true if the function was added to the execution queue

## ◆ draw()

void draw | ( | CDrawContext * | pContext | ) |
| overridevirtual

called if the view should draw itself

Parameters

  pContext | draw context in which to draw

Reimplemented from CView.

## ◆ drawRect()

void drawRect | ( | CDrawContext * | pContext,
|  | const CRect & | updateRect )
| overridevirtual

called if the view should draw itself

Reimplemented from CView.

## ◆ enableTooltips()

void enableTooltips | ( | bool | state,
|  | uint32_t | delayTimeInMs = 1000 )

enable or disable tooltips

## ◆ endEdit()

void endEdit | ( | int32_t | index | ) |

## ◆ endModalViewSession()

bool endModalViewSession | ( | ModalViewSessionID | session | ) |

end a modal view session

Parameters

  session | a session identifer

Returns
  true on success

## ◆ focusDrawingEnabled()

bool focusDrawingEnabled | ( |  | ) | const

is focus drawing enabled

## ◆ frameToLocal()

CPoint & frameToLocal | ( | CPoint & | point | ) | const
| inlineoverridevirtual

conversion from frame coordinates to local view coordinates

Parameters

  point | location

Returns
  converted point

Reimplemented from CView.

## ◆ getAnimator()

Animation::Animator * getAnimator | ( |  | ) |

get animator for this frame

## ◆ getBitmapInterpolationQuality()

BitmapInterpolationQuality getBitmapInterpolationQuality | ( |  | ) | const

get interpolation quality for bitmaps

## ◆ getClipboard()

SharedPointer< IDataPackage > getClipboard | ( |  | ) |

get the clipboard data.

data is owned by the caller

## ◆ getContainerAt()

CViewContainer * getContainerAt | ( | const CPoint & | p,
|  | const GetViewOptions & | options = GetViewOptions ().deep () ) const
| overridevirtual

get the container at point where

Parameters

  p | location
  options | search search options

Returns
  view container at position p or null

Reimplemented from CViewContainer.

## ◆ getCurrentMouseButtons()

CButtonState getCurrentMouseButtons | ( |  | ) | const

get current mouse buttons and key modifiers

Returns
  mouse and modifier state

## ◆ getCurrentMouseLocation()

bool getCurrentMouseLocation | ( | CPoint & | where | ) | const

get current mouse location

Parameters

  where | location of mouse

Returns
  true on success

## ◆ getEditor()

VSTGUIEditorInterface * getEditor | ( |  | ) | const
| overridevirtual

get editor

Reimplemented from CView.

## ◆ getFocusColor()

CColor getFocusColor | ( |  | ) | const

get focus draw color

## ◆ getFocusView()

CView * getFocusView | ( |  | ) | const

## ◆ getFocusWidth()

CCoord getFocusWidth | ( |  | ) | const

get focus draw width

## ◆ getKnobMode()

int32_t getKnobMode | ( |  | ) | const

get hosts knob mode

## ◆ getModalView()

CView * getModalView | ( |  | ) | const

get the currently active modal view or nullptr if there is none

## ◆ getPlatformFrame()

IPlatformFrame * getPlatformFrame | ( |  | ) | const

## ◆ getPosition()

bool getPosition | ( | CCoord & | x,
|  | CCoord & | y ) const

get global position of frame

Parameters

  x | x coordinate
  y | y coordinate

Returns
  true on success

## ◆ getScaleFactor()

double getScaleFactor | ( |  | ) | const

## ◆ getSize() [1/2]

bool getSize | ( | CRect & | pSize | ) | const

## ◆ getSize() [2/2]

bool getSize | ( | CRect * | pRect | ) | const

get size relative to parent

Parameters

  pRect | size

Returns
  true on success

## ◆ getTicks()

uint64_t getTicks | ( |  | ) | const

get the current time (in ms)

Returns
  tick count in milliseconds

## ◆ getViewAddedRemovedObserver()

IViewAddedRemovedObserver * getViewAddedRemovedObserver | ( |  | ) | const

## ◆ getViewAt()

CView * getViewAt | ( | const CPoint & | p,
|  | const GetViewOptions & | options = GetViewOptions () ) const
| overridevirtual

get the view at point where

Parameters

  p | location
  options | search options

Returns
  view at position p or null

Reimplemented from CViewContainer.

## ◆ getViewsAt()

bool getViewsAt | ( | const CPoint & | p,
|  | ViewList & | views,
|  | const GetViewOptions & | options = GetViewOptions ().deep () ) const
| overridevirtual

get all views at point where, top->down

Parameters

  p | location
  views | result list
  options | search options

Returns
  success

Reimplemented from CViewContainer.

## ◆ getZoom()

double getZoom | ( |  | ) | const

get zoom factor

## ◆ hitTestSubViews()

bool hitTestSubViews | ( | const CPoint & | where,
|  | const Event & | event )
| overridevirtual

Parameters

  where | point
  event | current event

Returns
  true if any sub view accepts the hit

Reimplemented from CViewContainer.

## ◆ idle()

void idle | ( |  | ) |

## ◆ inEventProcessing()

bool inEventProcessing | ( |  | ) | const

Returns true if an event is currently being processed.

## ◆ invalid()

void invalid | ( |  | ) |
| inlineoverridevirtual

mark whole view as invalid

Reimplemented from CView.

## ◆ invalidate()

void invalidate | ( | const CRect & | rect | ) |

## ◆ invalidRect()

void invalidRect | ( | const CRect & | rect | ) |
| overridevirtual

mark rect as invalid

Parameters

  rect | rect to invalidate

Reimplemented from CView.

## ◆ localToFrame()

CPoint & localToFrame | ( | CPoint & | point | ) | const
| inlineoverridevirtual

conversion from local view coordinates to frame coordinates

Parameters

  point | location

Returns
  converted point

Reimplemented from CView.

## ◆ newCopy()

CBaseObject * newCopy | ( |  | ) | const
| inlineoverride

## ◆ onActivate()

void onActivate | ( | bool | state | ) |

called when the platform view/window is activated/deactivated

## ◆ onStartLocalEventLoop()

void onStartLocalEventLoop | ( |  | ) |

## ◆ onViewAdded()

void onViewAdded | ( | CView * | pView | ) |

Parameters

  pView | view which was added

## ◆ onViewRemoved()

void onViewRemoved | ( | CView * | pView | ) |

Parameters

  pView | view which was removed

## ◆ open()

bool open | ( | void * | pSystemWindow,
|  | PlatformType | systemWindowType = PlatformType::kDefaultNative,
|  | IPlatformFrameConfig * | config = nullptr )

## ◆ performDrag()

bool performDrag | ( | const DragDescription & | desc,
|  | const SharedPointer< IDragCallback > & | callback )

## ◆ platformDrawRects()

void platformDrawRects | ( | const PlatformGraphicsDeviceContextPtr & | context,
|  | double | scaleFactor,
|  | const std::vector< CRect > & | rects )
| overrideprotected

## ◆ platformOnActivate()

void platformOnActivate | ( | bool | state | ) |
| overrideprotected

## ◆ platformOnDragEnter()

DragOperation platformOnDragEnter | ( | DragEventData | data | ) |
| overrideprotected

## ◆ platformOnDragLeave()

void platformOnDragLeave | ( | DragEventData | data | ) |
| overrideprotected

## ◆ platformOnDragMove()

DragOperation platformOnDragMove | ( | DragEventData | data | ) |
| overrideprotected

## ◆ platformOnDrop()

bool platformOnDrop | ( | DragEventData | data | ) |
| overrideprotected

## ◆ platformOnEvent()

void platformOnEvent | ( | Event & | event | ) |
| overrideprotected

## ◆ platformOnWindowActivate()

void platformOnWindowActivate | ( | bool | state | ) |
| overrideprotected

## ◆ platformScaleFactorChanged()

void platformScaleFactorChanged | ( | double | newScaleFactor | ) |
| overrideprotected

## ◆ registerFocusViewObserver()

void registerFocusViewObserver | ( | IFocusViewObserver * | observer | ) |

## ◆ registerKeyboardHook()

void registerKeyboardHook | ( | IKeyboardHook * | hook | ) |

register a keyboard hook

## ◆ registerMouseObserver()

void registerMouseObserver | ( | IMouseObserver * | observer | ) |

register a mouse observer

## ◆ registerScaleFactorChangedListeneer()

void registerScaleFactorChangedListeneer | ( | IScaleFactorChangedListener * | listener | ) |
| inline

## ◆ registerScaleFactorChangedListener()

void registerScaleFactorChangedListener | ( | IScaleFactorChangedListener * | listener | ) |

## ◆ removeAll()

bool removeAll | ( | bool | withForget = true | ) |
| overridevirtual

remove all child views

Parameters

  withForget | bool to indicate if the view's reference counter should be decreased after removed from the container

Returns
  true on success

Reimplemented from CViewContainer.

## ◆ removeFromMouseViews()

void removeFromMouseViews | ( | CView * | view | ) |
| protected

## ◆ removeView()

bool removeView | ( | CView * | pView,
|  | bool | withForget = true )
| overridevirtual

remove a child view

Parameters

  pView | the view which should be removed from the container
  withForget | bool to indicate if the view's reference counter should be decreased after removed from the container

Returns
  true on success

Reimplemented from CViewContainer.

## ◆ scrollRect()

void scrollRect | ( | const CRect & | src,
|  | const CPoint & | distance )

scroll src rect by distance

Parameters

  src | rect which to scroll
  distance | point of distance

## ◆ setBitmapInterpolationQuality()

void setBitmapInterpolationQuality | ( | BitmapInterpolationQuality | quality | ) |

set interpolation quality for bitmaps

## ◆ setClipboard()

void setClipboard | ( | const SharedPointer< IDataPackage > & | data | ) |

set the clipboard data.

## ◆ setCollectInvalidRects()

void setCollectInvalidRects | ( | CollectInvalidRects * | collectInvalidRects | ) |
| protected

## ◆ setCursor()

void setCursor | ( | CCursorType | type | ) |

set mouse cursor

Parameters

  type | cursor type see CCursorType

## ◆ setFocusColor()

void setFocusColor | ( | const CColor & | color | ) |

set focus draw color

## ◆ setFocusDrawingEnabled()

void setFocusDrawingEnabled | ( | bool | state | ) |

enable focus drawing

## ◆ setFocusView()

void setFocusView | ( | CView * | pView | ) |

Parameters

  pView | new focus view

## ◆ setFocusWidth()

void setFocusWidth | ( | CCoord | width | ) |

set focus draw width

## ◆ setModalView()

bool setModalView | ( | CView * | pView | ) |

set a modal view.

deprecated use beginModalViewSession instead

Parameters

  pView | the 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.

## ◆ setPosition()

bool setPosition | ( | CCoord | x,
|  | CCoord | y )

repositions the frame

Parameters

  x | x coordinate
  y | y coordinate

Returns
  true on success

## ◆ setSize()

bool setSize | ( | CCoord | width,
|  | CCoord | height )

set size of frame (and the platform representation)

Parameters

  width | new width
  height | new height

Returns
  true on success

## ◆ setViewAddedRemovedObserver()

void setViewAddedRemovedObserver | ( | IViewAddedRemovedObserver * | observer | ) |

## ◆ setViewSize()

void setViewSize | ( | const CRect & | newSize,
|  | bool | doInvalid = true )
| overridevirtual

set views size

Parameters

  newSize | rect of new size of view
  doInvalid | if true set view dirty

Reimplemented from CView.

## ◆ setZoom()

bool setZoom | ( | double | zoomFactor | ) |

set zoom factor

## ◆ unregisterFocusViewObserver()

void unregisterFocusViewObserver | ( | IFocusViewObserver * | observer | ) |

## ◆ unregisterKeyboardHook()

void unregisterKeyboardHook | ( | IKeyboardHook * | hook | ) |

unregister a keyboard hook

## ◆ unregisterMouseObserver()

void unregisterMouseObserver | ( | IMouseObserver * | observer | ) |

unregister a mouse observer

## ◆ unregisterScaleFactorChangedListeneer()

void unregisterScaleFactorChangedListeneer | ( | IScaleFactorChangedListener * | listener | ) |
| inline

## ◆ unregisterScaleFactorChangedListener()

void unregisterScaleFactorChangedListener | ( | IScaleFactorChangedListener * | listener | ) |

## Member Data Documentation

## ◆ kDefaultKnobMode

int32_t kDefaultKnobMode = kCircularMode
| static

default knob mode if host does not provide one

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

- cframe.h
- cframe.cpp