ASPiK SDK
VSTGUI::CFrame Class Referencefinal

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

#include <cframe.h>

Inheritance diagram for VSTGUI::CFrame:
VSTGUI::CViewContainer VSTGUI::CView VSTGUI::CBaseObject VSTGUI::ReferenceCounted< T > VSTGUI::IReference

Classes

struct  CollectInvalidRects
 
struct  Impl
 

Public Types

using Function = std::function< void()>
 
- Public Types inherited from VSTGUI::CViewContainer
using ViewList = std::list< SharedPointer< CView > >
 
using ChildViewConstIterator = ViewList::const_iterator
 
using ChildViewConstReverseIterator = ViewList::const_reverse_iterator
 

Public Member Functions

 CFrame (const CRect &size, VSTGUIEditorInterface *pEditor)
 
bool doAfterEventProcessing (Function &&func)
 
bool doAfterEventProcessing (const Function &func)
 
bool inEventProcessing () const
 
void onStartLocalEventLoop ()
 
void invalid () override
 mark whole view as invalid
 
void invalidRect (const CRect &rect) override
 mark rect as invalid More...
 
bool removeView (CView *pView, bool withForget=true) override
 remove a child view More...
 
bool removeAll (bool withForget=true) override
 remove all child views More...
 
CViewgetViewAt (const CPoint &where, const GetViewOptions &options=GetViewOptions()) const override
 get the view at point where More...
 
CViewContainergetContainerAt (const CPoint &where, const GetViewOptions &options=GetViewOptions().deep()) const override
 get the container at point where More...
 
bool hitTestSubViews (const CPoint &where, const CButtonState &buttons=-1) override
 
bool attached (CView *parent) override
 view is attached to a parent view More...
 
void draw (CDrawContext *pContext) override
 called if the view should draw itself More...
 
void drawRect (CDrawContext *pContext, const CRect &updateRect) override
 called if the view should draw itself
 
CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 called when a mouse down event occurs More...
 
CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons) override
 called when a mouse up event occurs More...
 
CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons) override
 called when a mouse move event occurs More...
 
CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons) override
 called when the mouse leaves this view
 
bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons) override
 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) override
 called if a mouse wheel event is happening over this view More...
 
int32_t onKeyDown (VstKeyCode &keyCode) override
 called if a key down event occurs and this view has focus More...
 
int32_t onKeyUp (VstKeyCode &keyCode) override
 called if a key up event occurs and this view has focus More...
 
DragResult doDrag (IDataPackage *source, const CPoint &offset, CBitmap *dragBitmap) override
 start a drag operation. See CDropSource to create the source data package More...
 
void setViewSize (const CRect &rect, bool invalid=true) override
 set views size More...
 
VSTGUIEditorInterfacegetEditor () const override
 get editor
 
IPlatformFrame * getPlatformFrame () 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.

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
 
- Public Member Functions inherited from VSTGUI::CViewContainer
 CViewContainer (const CRect &size)
 
 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)
 
void draw (CDrawContext *pContext) override
 
void drawRect (CDrawContext *pContext, const CRect &updateRect) override
 
CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 called when a mouse down event occurs More...
 
CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons) override
 called when a mouse up event occurs More...
 
CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons) override
 called when a mouse move event occurs More...
 
CMouseEventResult onMouseCancel () override
 called when mouse tracking should be canceled
 
bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons) override
 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) override
 called if a mouse wheel event is happening over this view More...
 
bool hitTest (const CPoint &where, const CButtonState &buttons=-1) override
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message) override
 
bool onDrop (IDataPackage *drag, const CPoint &where) override
 called if a drag is dropped onto this view
 
void onDragEnter (IDataPackage *drag, const CPoint &where) override
 called if a drag is entering this view
 
void onDragLeave (IDataPackage *drag, const CPoint &where) override
 called if a drag is leaving this view
 
void onDragMove (IDataPackage *drag, const CPoint &where) override
 called if a drag is moved inside this view
 
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 More...
 
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 More...
 
bool attached (CView *parent) override
 view is attached to a parent view More...
 
CPointframeToLocal (CPoint &point) const override
 conversion from frame coordinates to local view coordinates More...
 
CPointlocalToFrame (CPoint &point) const override
 conversion from local view coordinates to frame coordinates More...
 
CViewContainerasViewContainer () final
 
const CViewContainerasViewContainer () const final
 
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
 
virtual bool hasChildren () const
 check if container has child views
 
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().deep()) 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.
 
bool getAutosizingEnabled () const
 
template<class ViewClass , class ContainerClass >
uint32_t getChildViewsOfType (ContainerClass &result, bool deep=false) const
 
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
 
virtual void setBackgroundOffset (const CPoint &p)
 set the offset of the background bitmap
 
virtual const CPointgetBackgroundOffset () const
 get the offset of the background bitmap
 
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 VSTGUI::CView
 CView (const CRect &size)
 
 CView (const CView &view)
 
void setSubviewState (bool state)
 
bool isSubview () const
 
virtual bool wantsWindowActiveStateChangeNotification () const
 
virtual void onWindowActivate (bool state)
 
CGraphicsTransform getGlobalTransform () const
 
template<typename T >
T & translateToGlobal (T &t) const
 translates a local coordinate to a global one using parent transforms
 
template<typename T >
translateToGlobal (const T &t) const
 translates a local coordinate to a global one using parent transforms
 
template<typename T >
T & translateToLocal (T &t) const
 translates a global coordinate to a local one using parent transforms
 
template<typename T >
translateToLocal (const T &t) const
 translates a local coordinate to a global one using parent transforms
 
virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 called when the mouse enters this view
 
void setHitTestPath (CGraphicsPath *path)
 
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
 
CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse
 
const CRectgetMouseableArea () const
 read only access to the mouseable area
 
CCoord getHeight () const
 get the height of the view
 
CCoord getWidth () const
 get the width of the view
 
const CRectgetViewSize () const
 read only access to view size
 
virtual CRect getVisibleViewSize () const
 returns the visible size of the view More...
 
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 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
 
virtual void setBackground (CBitmap *background)
 set the background image of this view More...
 
CBitmapgetBackground () const
 get the background image of this view
 
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
 
CBitmapgetDrawBackground () const
 
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
 
CViewgetParentView () const
 get parent view
 
CFramegetFrame () const
 get frame
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=nullptr)
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, const Animation::DoneFunction &doneFunc)
 
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 !
 
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
 
- Public Member Functions inherited from VSTGUI::CBaseObject
 CBaseObject (const CBaseObject &o)
 
CBaseObjectoperator= (const CBaseObject &obj)
 
- Public Member Functions inherited from VSTGUI::ReferenceCounted< T >
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (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
 

Protected Member Functions

void beforeDelete () override
 
void checkMouseViews (const CPoint &where, const CButtonState &buttons)
 
void clearMouseViews (const CPoint &where, const CButtonState &buttons, bool callMouseExit=true)
 
void removeFromMouseViews (CView *view)
 
void setCollectInvalidRects (CollectInvalidRects *collectInvalidRects)
 
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)
 
void dispatchNewScaleFactor (double newScaleFactor)
 
bool platformDrawRect (CDrawContext *context, const CRect &rect) override
 
CMouseEventResult platformOnMouseDown (CPoint &where, const CButtonState &buttons) override
 
CMouseEventResult platformOnMouseMoved (CPoint &where, const CButtonState &buttons) override
 
CMouseEventResult platformOnMouseUp (CPoint &where, const CButtonState &buttons) override
 
CMouseEventResult platformOnMouseExited (CPoint &where, const CButtonState &buttons) override
 
bool platformOnMouseWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons) override
 
bool platformOnDrop (IDataPackage *drag, const CPoint &where) override
 
void platformOnDragEnter (IDataPackage *drag, const CPoint &where) override
 
void platformOnDragLeave (IDataPackage *drag, const CPoint &where) override
 
void platformOnDragMove (IDataPackage *drag, const CPoint &where) override
 
bool platformOnKeyDown (VstKeyCode &keyCode) override
 
bool platformOnKeyUp (VstKeyCode &keyCode) override
 
void platformOnActivate (bool state) override
 
void platformOnWindowActivate (bool state) override
 
void platformScaleFactorChanged (double newScaleFactor) override
 
- Protected Member Functions inherited from VSTGUI::CViewContainer
void beforeDelete () override
 
virtual bool checkUpdateRect (CView *view, const CRect &rect)
 
void setMouseDownView (CView *view)
 
CViewgetMouseDownView () const
 
const ViewList & getChildren () const
 
- Protected Member Functions inherited from VSTGUI::CView
CGraphicsPathgetHitTestPath () 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)
 

CFrame Methods

static int32_t kDefaultKnobMode = kCircularMode
 default knob mode if host does not provide one
 
bool open (void *pSystemWindow, PlatformType systemWindowType=kDefaultNative, IPlatformFrameConfig *=nullptr)
 
void close ()
 closes the frame and calls forget
 
bool setZoom (double zoomFactor)
 set zoom factor
 
double getZoom () const
 get zoom factor
 
double getScaleFactor () const
 
void idle ()
 
uint32_t getTicks () const
 get the current time (in ms) More...
 
int32_t getKnobMode () const
 get hosts knob mode
 
bool setPosition (CCoord x, CCoord y)
 
bool getPosition (CCoord &x, CCoord &y) const
 
bool setSize (CCoord width, CCoord height)
 
bool getSize (CRect *pSize) const
 
bool getSize (CRect &pSize) const
 
bool setModalView (CView *pView)
 
CViewgetModalView () const
 
void beginEdit (int32_t index)
 
void endEdit (int32_t index)
 
bool getCurrentMouseLocation (CPoint &where) const
 get current mouse location More...
 
CButtonState getCurrentMouseButtons () const
 get current mouse buttons and key modifiers More...
 
void setCursor (CCursorType type)
 set mouse cursor More...
 
void setFocusView (CView *pView)
 
CViewgetFocusView () 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 More...
 
void enableTooltips (bool state)
 enable or disable tooltips
 
Animation::AnimatorgetAnimator ()
 get animator for this frame
 
SharedPointer< IDataPackagegetClipboard ()
 get the clipboard data. data is owned by the caller
 
void setClipboard (const SharedPointer< IDataPackage > &data)
 set the clipboard data.
 
IViewAddedRemovedObservergetViewAddedRemovedObserver () 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 registerFocusViewObserver (IFocusViewObserver *observer)
 
void unregisterFocusViewObserver (IFocusViewObserver *observer)
 

Additional Inherited Members

- Static Public Attributes inherited from VSTGUI::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.
 
static uint32_t idleRate
 global idle rate in Hz, defaults to 30 Hz
 
- Protected Types inherited from VSTGUI::CViewContainer
enum  { kAutosizeSubviews = 1 << (CView::kLastCViewFlag + 1) }
 
- Protected Types inherited from VSTGUI::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
}
 

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 Function Documentation

◆ advanceNextFocusView()

bool VSTGUI::CFrame::advanceNextFocusView ( CView oldFocus,
bool  reverse = false 
)
overridevirtual
Parameters
oldFocusold focus view
reversesearch order
Returns
true on success

Reimplemented from VSTGUI::CViewContainer.

◆ attached()

bool VSTGUI::CFrame::attached ( CView parent)
overridevirtual

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

Reimplemented from VSTGUI::CView.

◆ doAfterEventProcessing() [1/2]

bool VSTGUI::CFrame::doAfterEventProcessing ( Function &&  func)

Queue a function which will be executed after the current event was handled. Only allowed when inEventProcessing () is true

Parameters
funcFunction to execute
Returns
true if the function was added to the execution queue

◆ doAfterEventProcessing() [2/2]

bool VSTGUI::CFrame::doAfterEventProcessing ( const Function &  func)

Queue a function which will be executed after the current event was handled. Only allowed when inEventProcessing () is true

Parameters
funcFunction to execute
Returns
true if the function was added to the execution queue

◆ doDrag()

DragResult VSTGUI::CFrame::doDrag ( IDataPackage source,
const CPoint offset,
CBitmap dragBitmap 
)
overridevirtual

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
see DragResult

Reimplemented from VSTGUI::CView.

◆ draw()

void VSTGUI::CFrame::draw ( CDrawContext pContext)
overridevirtual

called if the view should draw itself

Parameters
pContextdraw context in which to draw

Reimplemented from VSTGUI::CView.

◆ getContainerAt()

CViewContainer * VSTGUI::CFrame::getContainerAt ( const CPoint p,
const GetViewOptions options = GetViewOptions ().deep () 
) const
overridevirtual

get the container at point where

Parameters
plocation
optionssearch search options
Returns
view container at position p or null

Reimplemented from VSTGUI::CViewContainer.

◆ getCurrentMouseButtons()

CButtonState VSTGUI::CFrame::getCurrentMouseButtons ( ) const

get current mouse buttons and key modifiers

Returns
mouse and modifier state

◆ getCurrentMouseLocation()

bool VSTGUI::CFrame::getCurrentMouseLocation ( CPoint where) const

get current mouse location

Parameters
wherelocation of mouse
Returns
true on success

◆ getPosition()

bool VSTGUI::CFrame::getPosition ( CCoord &  x,
CCoord &  y 
) const

get global position of frame

Parameters
xx coordinate
yy coordinate
Returns
true on success

◆ getSize()

bool VSTGUI::CFrame::getSize ( CRect pRect) const

get size relative to parent

Parameters
pRectsize
Returns
true on success

◆ getTicks()

uint32_t VSTGUI::CFrame::getTicks ( ) const

get the current time (in ms)

Returns
tick count in milliseconds

◆ getViewAt()

CView * VSTGUI::CFrame::getViewAt ( const CPoint p,
const GetViewOptions options = GetViewOptions () 
) const
overridevirtual

get the view at point where

Parameters
plocation
optionssearch options
Returns
view at position p or null

Reimplemented from VSTGUI::CViewContainer.

◆ hitTestSubViews()

bool VSTGUI::CFrame::hitTestSubViews ( const CPoint where,
const CButtonState buttons = -1 
)
overridevirtual
Parameters
wherepoint
buttonsmouse button and modifier state
Returns
true if any sub view accepts the hit

Reimplemented from VSTGUI::CViewContainer.

◆ inEventProcessing()

bool VSTGUI::CFrame::inEventProcessing ( ) const

Returns true if an event is currently being processed.

◆ invalidRect()

void VSTGUI::CFrame::invalidRect ( const CRect rect)
overridevirtual

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented from VSTGUI::CView.

◆ onKeyDown()

int32_t VSTGUI::CFrame::onKeyDown ( VstKeyCode keyCode)
overridevirtual

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 VSTGUI::CView.

◆ onKeyUp()

int32_t VSTGUI::CFrame::onKeyUp ( VstKeyCode keyCode)
overridevirtual

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 VSTGUI::CView.

◆ onMouseDown()

CMouseEventResult VSTGUI::CFrame::onMouseDown ( CPoint where,
const CButtonState buttons 
)
overridevirtual

called when a mouse down event occurs

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

Reimplemented from VSTGUI::CView.

◆ onMouseMoved()

CMouseEventResult VSTGUI::CFrame::onMouseMoved ( CPoint where,
const CButtonState buttons 
)
overridevirtual

called when a mouse move event occurs

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

Reimplemented from VSTGUI::CView.

◆ onMouseUp()

CMouseEventResult VSTGUI::CFrame::onMouseUp ( CPoint where,
const CButtonState buttons 
)
overridevirtual

called when a mouse up event occurs

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

Reimplemented from VSTGUI::CView.

◆ onViewAdded()

void VSTGUI::CFrame::onViewAdded ( CView pView)
Parameters
pViewview which was added

◆ onViewRemoved()

void VSTGUI::CFrame::onViewRemoved ( CView pView)
Parameters
pViewview which was removed

◆ onWheel() [1/2]

bool VSTGUI::CFrame::onWheel ( const CPoint where,
const float &  distance,
const CButtonState buttons 
)
overridevirtual

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 VSTGUI::CView.

◆ onWheel() [2/2]

bool VSTGUI::CFrame::onWheel ( const CPoint where,
const CMouseWheelAxis &  axis,
const float &  distance,
const CButtonState buttons 
)
overridevirtual

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 VSTGUI::CView.

◆ removeAll()

bool VSTGUI::CFrame::removeAll ( bool  withForget = true)
overridevirtual

remove all child views

Parameters
withForgetbool to indicate if the view's reference counter should be decreased after removed from the container
Returns
true on success

Reimplemented from VSTGUI::CViewContainer.

◆ removeView()

bool VSTGUI::CFrame::removeView ( CView pView,
bool  withForget = true 
)
overridevirtual

remove a child view

Parameters
pViewthe view which should be removed from the container
withForgetbool to indicate if the view's reference counter should be decreased after removed from the container
Returns
true on success

Reimplemented from VSTGUI::CViewContainer.

◆ scrollRect()

void VSTGUI::CFrame::scrollRect ( const CRect src,
const CPoint distance 
)

scroll src rect by distance

Parameters
srcrect which to scroll
distancepoint of distance

◆ setCursor()

void VSTGUI::CFrame::setCursor ( CCursorType  type)

set mouse cursor

Parameters
typecursor type see #CCursorType

◆ setFocusView()

void VSTGUI::CFrame::setFocusView ( CView pView)
Parameters
pViewnew focus view

◆ setModalView()

bool VSTGUI::CFrame::setModalView ( CView pView)
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.

◆ setPosition()

bool VSTGUI::CFrame::setPosition ( CCoord  x,
CCoord  y 
)

repositions the frame

Parameters
xx coordinate
yy coordinate
Returns
true on success

◆ setSize()

bool VSTGUI::CFrame::setSize ( CCoord  width,
CCoord  height 
)

set size of frame (and the platform representation)

Parameters
widthnew width
heightnew height
Returns
true on success

◆ setViewSize()

void VSTGUI::CFrame::setViewSize ( const CRect newSize,
bool  doInvalid = true 
)
overridevirtual

set views size

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

Reimplemented from VSTGUI::CView.


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