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

Container Class of CView objects. More...

+ Inheritance diagram for CViewContainer:
+ Collaboration diagram for CViewContainer:

Classes

class  Iterator
 

Public Types

typedef std::list
< SharedPointer< CView > > 
ViewList
 
typedef ViewList::const_iterator ChildViewConstIterator
 
typedef
ViewList::const_reverse_iterator 
ChildViewConstReverseIterator
 

Public Member Functions

 CViewContainer (const CRect &size)
 
 CViewContainer (const CRect &size, CFrame *pParent, CBitmap *pBackground=0)
 
 CViewContainer (const CViewContainer &viewContainer)
 
virtual bool advanceNextFocusView (CView *oldFocus, bool reverse=false)
 
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 void draw (CDrawContext *pContext)
 called if the view should draw itself More...
 
virtual void drawRect (CDrawContext *pContext, const CRect &updateRect)
 called if the view should draw itself More...
 
virtual CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons)
 called when a mouse down event occurs More...
 
virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons)
 called when a mouse up event occurs More...
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons)
 called when a mouse move event occurs More...
 
virtual CMouseEventResult onMouseCancel ()
 called when mouse tracking should be canceled More...
 
virtual bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view More...
 
virtual 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...
 
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 invalid ()
 mark whole view as invalid More...
 
virtual void invalidRect (const CRect &rect)
 mark rect as invalid More...
 
virtual void setViewSize (const CRect &rect, bool invalid=true)
 set views size 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 bool attached (CView *parent)
 view is attached to a 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 isTypeOf (IdStringPtr s) const
 
virtual CBaseObjectnewCopy () const
 
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 ()
 
Sub View Methods
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 removeView (CView *pView, bool withForget=true)
 remove a child view More...
 
virtual bool removeAll (bool withForget=true)
 remove all child views 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 CViewgetViewAt (const CPoint &where, const GetViewOptions &options=GetViewOptions(GetViewOptions::kNone)) const
 get the view at point where More...
 
virtual CViewContainergetContainerAt (const CPoint &where, const GetViewOptions &options=GetViewOptions(GetViewOptions::kDeep)) const
 get the container at point where 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
 
Background Methods
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
 
Mouse Methods
virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 called when the mouse enters this view More...
 
virtual CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons)
 called when the mouse leaves 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...
 
Drag & Drop Methods
virtual DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=0)
 start a drag operation. See CDropSource to create the source data package More...
 
Keyboard Methods
virtual int32_t onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus More...
 
virtual int32_t onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus More...
 
View Size Methods
CCoord getHeight () const
 get the height of the view More...
 
CCoord getWidth () const
 get the width of the view More...
 
CRectgetViewSize (CRect &rect) const
 returns the current view size 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...
 
Focus Methods
virtual bool wantsFocus () const
 check if view supports focus More...
 
virtual void setWantsFocus (bool state)
 set focus support on/off More...
 
Attribute Methods
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...
 
Background Methods
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
 
Transparency Methods
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...
 
Attaching Methods
bool isAttached () const
 is view attached to a parentView More...
 
Parent Methods
CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () const
 get frame More...
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor More...
 
Animation Methods
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=0)
 
void removeAnimation (IdStringPtr name)
 
void removeAllAnimations ()
 
View Listener Methods
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
Reference Counting Methods
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

enum  { kAutosizeSubviews = 1 << (CView::kLastCViewFlag + 1) }
 
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

 ~CViewContainer ()
 
virtual bool checkUpdateRect (CView *view, const CRect &rect)
 
virtual bool hitTestSubViews (const CPoint &where, const CButtonState buttons=-1)
 
CGraphicsPathgetHitTestPath () const
 

Protected Attributes

CDrawStyle backgroundColorDrawStyle
 
CColor backgroundColor
 
CPoint backgroundOffset
 
CRect lastDrawnFocus
 
CViewcurrentDragView
 
CViewmouseDownView
 
CRect size
 
CRect mouseableArea
 
CFramepParentFrame
 
CViewpParentView
 
int32_t viewFlags
 
int32_t autosizeFlags
 
float alphaValue
 

Draw and Update Methods

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

Idle Methods

Should be used when a view needs to do a task periodically. The onIdle() method will be called only if the view is attached.

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...
 
static uint32_t idleRate
 global idle rate in Hz, defaults to 30 Hz More...
 

Detailed Description

Container Class of CView objects.

Member Typedef Documentation

typedef ViewList::const_iterator ChildViewConstIterator
typedef ViewList::const_reverse_iterator ChildViewConstReverseIterator
typedef std::list<SharedPointer<CView> > ViewList

Member Enumeration Documentation

anonymous enum
protectedinherited
Enumerator
kMouseEnabled 
kTransparencyEnabled 
kWantsFocus 
kIsAttached 
kVisible 
kDirty 
kWantsIdle 
kIsSubview 
kLastCViewFlag 
anonymous enum
protected
Enumerator
kAutosizeSubviews 

Constructor & Destructor Documentation

CViewContainer ( const CRect size)

+ Here is the caller graph for this function:

CViewContainer ( const CRect size,
CFrame pParent,
CBitmap pBackground = 0 
)
CViewContainer ( const CViewContainer viewContainer)
~CViewContainer ( )
protected

Member Function Documentation

void addAnimation ( IdStringPtr  name,
Animation::IAnimationTarget target,
Animation::ITimingFunction timingFunction,
CBaseObject notificationObject = 0 
)
inherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual bool addView ( CView pView)
virtual

add a child view

Reimplemented in CScrollView, CSplitView, and CAutoLayoutContainerView.

+ Here is the caller graph for this function:

virtual bool addView ( CView pView,
const CRect mouseableArea,
bool  mouseEnabled = true 
)
virtual

add a child view

Reimplemented in CScrollView, CSplitView, and CAutoLayoutContainerView.

virtual bool addView ( CView pView,
CView pBefore 
)
virtual

add a child view before another view

Reimplemented in CScrollView, CSplitView, and CAutoLayoutContainerView.

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

Reimplemented in CFrame.

+ Here is the caller graph for this function:

virtual 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 CView.

Reimplemented in CDataBrowser, CFrame, CFontChooser, CSplitView, CShadowViewContainer, UIViewSwitchContainer, CLayeredViewContainer, and CAutoLayoutContainerView.

+ Here is the caller graph for this function:

void beforeDelete ( )
virtualinherited

Reimplemented from CBaseObject.

+ Here is the call graph for this function:

virtual bool changeViewZOrder ( CView view,
uint32_t  newIndex 
)
virtual

change view z order position

Reimplemented in CAutoLayoutContainerView.

+ Here is the caller graph for this function:

virtual bool checkUpdate ( const CRect updateRect) const
inlinevirtualinherited

+ Here is the call graph for this function:

virtual bool checkUpdateRect ( CView view,
const CRect rect 
)
protectedvirtual
DragResult doDrag ( IDataPackage source,
const CPoint offset = CPoint (0, 0),
CBitmap dragBitmap = 0 
)
virtualinherited

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 in CFrame.

+ Here is the call graph for this function:

virtual void draw ( CDrawContext pContext)
virtual

called if the view should draw itself

Parameters
pContextdraw context in which to draw

Reimplemented from CView.

Reimplemented in CFrame.

+ Here is the caller graph for this function:

virtual void drawBackgroundRect ( CDrawContext pContext,
const CRect _updateRect 
)
virtual

draw the background

Reimplemented in CScrollView, CTabView, and CShadowViewContainer.

+ Here is the caller graph for this function:

virtual void drawRect ( CDrawContext pContext,
const CRect updateRect 
)
virtual

called if the view should draw itself

Reimplemented from CView.

Reimplemented in CFrame, CShadowViewContainer, and CLayeredViewContainer.

+ Here is the caller graph for this function:

virtual void forget ( )
inlinevirtualinherited

decrease refcount and delete object if refcount == 0

+ Here is the call graph for this function:

virtual CPoint& frameToLocal ( CPoint point) const
virtual

conversion from frame coordinates to local view coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented from CView.

+ Here is the caller graph for this function:

float getAlphaValue ( ) const
inlineinherited

get alpha value

+ Here is the caller graph for this function:

bool getAttribute ( const CViewAttributeID  aId,
const uint32_t  inSize,
void *  outData,
uint32_t &  outSize 
) const
inherited

get an attribute

Parameters
aIdthe ID of the Attribute
inSizethe size of the outData pointer
outDataa pointer where to copy the attribute data
outSizethe size in bytes which was copied into outData
Returns
true if attribute exists and outData was big enough. outSize and outData is valid then.

+ Here is the caller graph for this function:

bool getAttributeSize ( const CViewAttributeID  aId,
uint32_t &  outSize 
) const
inherited

get the size of an attribute

Parameters
aIdthe ID of the Attribute
outSizeon return the size of the attribute
Returns
true if attribute exists. outSize is valid then.

+ Here is the caller graph for this function:

virtual int32_t getAutosizeFlags ( ) const
inlinevirtualinherited

get autosize flags

+ Here is the caller graph for this function:

bool getAutosizingEnabled ( ) const
inline
CBitmap* getBackground ( ) const
inlineinherited

get the background image of this view

+ Here is the caller graph for this function:

virtual CColor getBackgroundColor ( ) const
inlinevirtual

get the background color

CDrawStyle getBackgroundColorDrawStyle ( ) const
inline
virtual const CPoint& getBackgroundOffset ( ) const
inlinevirtual

get the offset of the background bitmap

uint32_t getChildViewsOfType ( ContainerClass &  result,
bool  deep = false 
) const

get child views of type ViewClass. ContainerClass must be a stdc++ container

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

get the container at point where

Reimplemented in CFrame.

+ Here is the caller graph for this function:

CBitmap* getDisabledBackground ( ) const
inlineinherited

get background image used when the mouse is not enabled

CBitmap* getDrawBackground ( ) const
inlineinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

VSTGUIEditorInterface * getEditor ( ) const
virtualinherited

get editor

Reimplemented in CFrame.

+ Here is the call graph for this function:

CFrame* getFrame ( ) const
inlineinherited

get frame

+ Here is the caller graph for this function:

CGraphicsTransform getGlobalTransform ( ) const
inherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CCoord getHeight ( ) const
inlineinherited

get the height of the view

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CGraphicsPath* getHitTestPath ( ) const
inlineprotectedinherited
virtual CRect& getMouseableArea ( CRect rect) const
inlinevirtualinherited

get the area in which the view reacts to the mouse

+ Here is the caller graph for this function:

virtual const CRect& getMouseableArea ( ) const
inlinevirtualinherited

read only access to the mouseable area

virtual bool getMouseEnabled ( ) const
inlinevirtualinherited

get the state of wheather this view uses the mouse or not

+ Here is the caller graph for this function:

virtual int32_t getNbReference ( ) const
inlinevirtualinherited

get refcount

virtual uint32_t getNbViews ( ) const
virtual

get the number of child views

Reimplemented in CScrollView.

+ Here is the caller graph for this function:

CView* getParentView ( ) const
inlineinherited

get parent view

+ Here is the caller graph for this function:

const CGraphicsTransform& getTransform ( ) const
inline

+ Here is the caller graph for this function:

virtual bool getTransparency ( ) const
inlinevirtualinherited

get views transparent state

+ Here is the caller graph for this function:

virtual CView* getView ( uint32_t  index) const
virtual

get the child view at index

Reimplemented in CScrollView.

+ Here is the caller graph for this function:

virtual CView* getViewAt ( const CPoint where,
const GetViewOptions options = GetViewOptions(GetViewOptions::kNone) 
) const
virtual

get the view at point where

Reimplemented in CFrame.

+ Here is the caller graph for this function:

virtual bool getViewsAt ( const CPoint where,
ViewList views,
const GetViewOptions options = GetViewOptions(GetViewOptions::kDeep) 
) const
virtual

get all views at point where, top->down

CRect& getViewSize ( CRect rect) const
inlineinherited

returns the current view size

+ Here is the caller graph for this function:

const CRect& getViewSize ( ) const
inlineinherited

read only access to view size

virtual CRect getVisibleSize ( const CRect rect) const
virtual
CRect getVisibleViewSize ( ) const
virtualinherited

returns the visible size of the view

Returns
visible size of view

+ Here is the caller graph for this function:

CCoord getWidth ( ) const
inlineinherited

get the width of the view

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual bool hasChildren ( ) const
virtual

check if container has child views

virtual bool hitTest ( const CPoint where,
const CButtonState buttons = -1 
)
virtual

check if where hits this view

Parameters
wherelocation
buttonsbutton and modifier state
Returns
true if point hits this view

Reimplemented from CView.

virtual bool hitTestSubViews ( const CPoint where,
const CButtonState  buttons = -1 
)
protectedvirtual
virtual void invalid ( )
virtual

mark whole view as invalid

Reimplemented from CView.

Reimplemented in CFrame, and CLayeredViewContainer.

+ Here is the caller graph for this function:

virtual bool invalidateDirtyViews ( )
virtual

+ Here is the caller graph for this function:

virtual void invalidRect ( const CRect rect)
virtual

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented from CView.

Reimplemented in CFrame, and CLayeredViewContainer.

+ Here is the caller graph for this function:

bool isAttached ( ) const
inlineinherited

is view attached to a parentView

+ Here is the caller graph for this function:

virtual bool isChild ( CView pView) const
virtual

check if pView is a child view of this container

+ Here is the caller graph for this function:

virtual bool isChild ( CView pView,
bool  deep 
) const
virtual

check if pView is a child view of this container

virtual bool isDirty ( ) const
virtual

check if view is dirty

Reimplemented from CView.

bool isSubview ( ) const
inlineinherited

+ Here is the caller graph for this function:

virtual bool isTypeOf ( IdStringPtr  s) const
inlinevirtual
bool isVisible ( ) const
inlineinherited

get visibility state

+ Here is the caller graph for this function:

virtual CPoint& localToFrame ( CPoint point) const
virtual

conversion from local view coordinates to frame coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented from CView.

virtual void looseFocus ( )
virtual

called if view should loose focus

Reimplemented from CView.

virtual CBaseObject* newCopy ( ) const
inlinevirtual
virtual CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
)
virtual

translates a local coordinate to a global one using parent transforms

Parameters
sendermessage sender
messagemessage text
Returns
message handled or not. See CMessageResult

Reimplemented from CView.

Reimplemented in CDataBrowser, CScrollView, CRowColumnView, and CShadowViewContainer.

+ Here is the caller graph for this function:

virtual void onDragEnter ( IDataPackage drag,
const CPoint where 
)
virtual

called if a drag is entering this view

Reimplemented from CView.

+ Here is the caller graph for this function:

virtual void onDragLeave ( IDataPackage drag,
const CPoint where 
)
virtual

called if a drag is leaving this view

Reimplemented from CView.

+ Here is the caller graph for this function:

virtual void onDragMove ( IDataPackage drag,
const CPoint where 
)
virtual

called if a drag is moved inside this view

Reimplemented from CView.

+ Here is the caller graph for this function:

virtual bool onDrop ( IDataPackage drag,
const CPoint where 
)
virtual

called if a drag is dropped onto this view

Reimplemented from CView.

+ Here is the caller graph for this function:

virtual void onIdle ( )
inlinevirtualinherited

called on idle when view wants idle

Reimplemented in CVuMeter.

int32_t onKeyDown ( VstKeyCode keyCode)
virtualinherited

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 in CTextButton, COptionMenu, CDataBrowser, CFrame, CKickButton, CSegmentButton, CCheckBox, CRockerSwitch, CSlider, CKnob, CFontChooser, CHorizontalSwitch, CTextEdit, COnOffButton, CMovieButton, and CVerticalSwitch.

+ Here is the caller graph for this function:

int32_t onKeyUp ( VstKeyCode keyCode)
virtualinherited

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 in CTextButton, CFrame, CKickButton, and CRockerSwitch.

+ Here is the caller graph for this function:

virtual CMouseEventResult onMouseCancel ( )
virtual

called when mouse tracking should be canceled

Reimplemented from CView.

virtual 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 CView.

Reimplemented in CDataBrowser, and CFrame.

+ Here is the caller graph for this function:

virtual CMouseEventResult onMouseEntered ( CPoint where,
const CButtonState buttons 
)
inlinevirtualinherited

called when the mouse enters this view

Reimplemented in CScrollbar.

virtual CMouseEventResult onMouseExited ( CPoint where,
const CButtonState buttons 
)
inlinevirtualinherited

called when the mouse leaves this view

Reimplemented in CFrame, and CScrollbar.

+ Here is the caller graph for this function:

virtual 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 CView.

Reimplemented in CFrame.

+ Here is the caller graph for this function:

virtual 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 CView.

Reimplemented in CFrame.

+ Here is the caller graph for this function:

virtual 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 CView.

Reimplemented in CFrame.

+ Here is the caller graph for this function:

virtual 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 CView.

Reimplemented in CFrame, and CScrollView.

virtual void parentSizeChanged ( )
virtual

notification that one of the views parent has changed its size

Reimplemented from CView.

Reimplemented in CLayeredViewContainer.

+ Here is the caller graph for this function:

void registerViewContainerListener ( IViewContainerListener listener)

+ Here is the caller graph for this function:

void registerViewListener ( IViewListener listener)
inherited

+ Here is the call graph for this function:

virtual void remember ( )
inlinevirtualinherited

increase refcount

+ Here is the caller graph for this function:

virtual bool removeAll ( bool  withForget = true)
virtual

remove all child views

Reimplemented in CFrame, CScrollView, and CSplitView.

+ Here is the caller graph for this function:

void removeAllAnimations ( )
inherited

+ Here is the call graph for this function:

void removeAnimation ( IdStringPtr  name)
inherited

+ Here is the call graph for this function:

bool removeAttribute ( const CViewAttributeID  id)
inherited

remove an attribute

+ Here is the caller graph for this function:

virtual bool removed ( CView parent)
virtual

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented from CView.

Reimplemented in CDataBrowser, CSplitView, CShadowViewContainer, UIViewSwitchContainer, and CLayeredViewContainer.

+ Here is the caller graph for this function:

virtual bool removeView ( CView pView,
bool  withForget = true 
)
virtual

remove a child view

Reimplemented in CFrame, CScrollView, CSplitView, and CAutoLayoutContainerView.

+ Here is the caller graph for this function:

void setAlphaValue ( float  alpha)
virtualinherited

set alpha value which will be applied when drawing this view

Reimplemented in CLayeredViewContainer.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool setAttribute ( const CViewAttributeID  aId,
const uint32_t  inSize,
const void *  inData 
)
inherited

set an attribute

copies data into the attribute. If it does not exist, creates a new attribute.

Parameters
aIdthe ID of the Attribute
inSizethe size of the outData pointer
inDataa pointer to the data
Returns
true if attribute was set

+ Here is the caller graph for this function:

virtual void setAutosizeFlags ( int32_t  flags)
inlinevirtualinherited

set autosize flags

Reimplemented in CDataBrowser, CScrollView, and CTabView.

+ Here is the caller graph for this function:

virtual void setAutosizingEnabled ( bool  state)
virtual

enable or disable autosizing subviews. Per default this is enabled.

+ Here is the caller graph for this function:

void setBackground ( CBitmap background)
virtualinherited

set the background image of this view

Parameters
backgroundnew background bitmap

Reimplemented in CAnimKnob, and CCheckBox.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void setBackgroundColor ( const CColor color)
virtual

set the background color (will only be drawn if this container is not set to transparent and does not have a background bitmap)

Reimplemented in CScrollView.

+ Here is the caller graph for this function:

virtual void setBackgroundColorDrawStyle ( CDrawStyle  style)
virtual
virtual void setBackgroundOffset ( const CPoint p)
inlinevirtual

set the offset of the background bitmap

void setDirty ( bool  val = true)
virtualinherited

set the view to dirty so that it is redrawn in the next idle. Thread Safe !

Reimplemented in CControl, and CVuMeter.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setDisabledBackground ( CBitmap background)
virtualinherited

set background image used when the mouse is not enabled

Parameters
backgroundnew disabled background bitmap

+ Here is the call graph for this function:

void setHitTestPath ( CGraphicsPath path)
inherited
Parameters
paththe path to use for hit testing. The path will be translated by this views origin, so that the path must not be set again, if the view is moved. Otherwise when the size of the view changes, the path must also be set again.
virtual void setMouseableArea ( const CRect rect)
inlinevirtualinherited

set the area in which the view reacts to the mouse

+ Here is the caller graph for this function:

void setMouseEnabled ( bool  bEnable = true)
virtualinherited

turn on/off mouse usage for this view

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setSubviewState ( bool  state)
inherited

+ Here is the call graph for this function:

void setTransform ( const CGraphicsTransform t)

+ Here is the caller graph for this function:

void setTransparency ( bool  val)
virtualinherited

set views transparent state

Reimplemented in CScrollView.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual 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 CView.

Reimplemented in CDataBrowser, CFrame, CScrollView, CTabView, CSplitView, CShadowViewContainer, CLayeredViewContainer, and CAutoLayoutContainerView.

+ Here is the caller graph for this function:

void setVisible ( bool  state)
virtualinherited

set visibility state

Reimplemented in COpenGLView.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setWantsFocus ( bool  state)
virtualinherited

set focus support on/off

Reimplemented in CDataBrowser.

+ Here is the caller graph for this function:

void setWantsIdle ( bool  state)
inherited

enable/disable onIdle() callback

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual bool sizeToFit ( )
virtual

resize view to optimal size

Reimplemented from CView.

Reimplemented in CRowColumnView, and CSplitView.

+ Here is the caller graph for this function:

virtual void takeFocus ( )
virtual

called if view should take focus

Reimplemented from CView.

T& translateToGlobal ( T &  t) const
inlineinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

T translateToGlobal ( const T &  t) const
inlineinherited

translates a local coordinate to a global one using parent transforms

+ Here is the call graph for this function:

T& translateToLocal ( T &  t) const
inlineinherited

translates a local coordinate to a global one using parent transforms

+ Here is the call graph for this function:

T translateToLocal ( const T &  t) const
inlineinherited

translates a global coordinate to a local one using parent transforms

+ Here is the call graph for this function:

void unregisterViewContainerListener ( IViewContainerListener listener)

+ Here is the caller graph for this function:

void unregisterViewListener ( IViewListener listener)
inherited

+ Here is the call graph for this function:

virtual bool wantsFocus ( ) const
inlinevirtualinherited

check if view supports focus

Reimplemented in CTextEdit.

+ Here is the caller graph for this function:

bool wantsIdle ( ) const
inlineinherited

returns if the view wants idle callback or not

+ Here is the caller graph for this function:

Member Data Documentation

float alphaValue
protectedinherited
int32_t autosizeFlags
protectedinherited
CColor backgroundColor
protected
CDrawStyle backgroundColorDrawStyle
protected
CPoint backgroundOffset
protected
CView* currentDragView
protected
uint32_t idleRate
staticinherited

global idle rate in Hz, defaults to 30 Hz

bool kDirtyCallAlwaysOnMainThread = false
staticinherited

if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false.

CRect lastDrawnFocus
protected
CRect mouseableArea
protectedinherited
CView* mouseDownView
protected
CFrame* pParentFrame
protectedinherited
CView* pParentView
protectedinherited
CRect size
protectedinherited
int32_t viewFlags
protectedinherited

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