VSTGUI  4.2
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
CControl Class Referenceabstract

base class of all VSTGUI controls More...

+ Inheritance diagram for CControl:
+ Collaboration diagram for CControl:

Public Member Functions

 CControl (const CRect &size, CControlListener *listener=0, int32_t tag=0, CBitmap *pBackground=0)
 
 CControl (const CControl &c)
 
void draw (CDrawContext *pContext)=0
 called if the view should draw itself More...
 
bool isDirty () const
 check if view is dirty More...
 
void setDirty (bool val=true)
 set the view to dirty so that it is redrawn in the next idle. Thread Safe ! More...
 
bool drawFocusOnTop ()
 
bool getFocusPath (CGraphicsPath &outPath)
 
virtual bool isTypeOf (IdStringPtr s) const
 
virtual CBaseObjectnewCopy () const =0
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message)
 
virtual void addDependency (CBaseObject *obj)
 
virtual void removeDependency (CBaseObject *obj)
 
virtual void changed (IdStringPtr message)
 
virtual void deferChanges (bool state)
 
Value Methods
virtual void setValue (float val)
 
virtual float getValue () const
 
virtual void setValueNormalized (float val)
 
virtual float getValueNormalized () const
 
virtual void setMin (float val)
 
virtual float getMin () const
 
virtual void setMax (float val)
 
virtual float getMax () const
 
float getRange () const
 
virtual void setOldValue (float val)
 
virtual float getOldValue (void) const
 
virtual void setDefaultValue (float val)
 
virtual float getDefaultValue (void) const
 
virtual void bounceValue ()
 
virtual bool checkDefaultValue (CButtonState button)
 
virtual void valueChanged ()
 notifies listener and dependent objects More...
 
Editing Methods
virtual void setTag (int32_t val)
 
virtual int32_t getTag () const
 
virtual void beginEdit ()
 
virtual void endEdit ()
 
bool isEditing () const
 
virtual CControlListenergetListener () const
 get main listener More...
 
virtual void setListener (CControlListener *l)
 set main listener More...
 
Misc
virtual void setBackOffset (const CPoint &offset)
 
virtual const CPointgetBackOffset () const
 
virtual void copyBackOffset ()
 
virtual void setWheelInc (float val)
 
virtual float getWheelInc () const
 
virtual void doIdleStuff ()
 
Mouse Methods
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 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 bool hitTest (const CPoint &where, const CButtonState &buttons=-1)
 check if where hits this view 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 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...
 
Touch Event Handling Methods
virtual void onTouchEvent (ITouchEvent &event)
 
virtual bool wantsMultiTouchEvents () const
 
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...
 
virtual void setViewSize (const CRect &rect, bool invalid=true)
 set views size 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 parentSizeChanged ()
 notification that one of the views parent has changed its size 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 void setAutosizeFlags (int32_t flags)
 set autosize flags More...
 
virtual int32_t getAutosizeFlags () const
 get autosize flags More...
 
virtual bool sizeToFit ()
 resize view to optimal size More...
 
Focus Methods
virtual void looseFocus ()
 called if view should loose focus More...
 
virtual void takeFocus ()
 called if view should take focus More...
 
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, int32_t &outSize) const
 get the size of an attribute More...
 
bool getAttribute (const CViewAttributeID id, const int32_t inSize, void *outData, int32_t &outSize) const
 get an attribute More...
 
bool setAttribute (const CViewAttributeID id, const int32_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
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...
 
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 ()
 
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...
 

Static Public Attributes

static int32_t kZoomModifier = kShift
 zoom modifier key, per default is the shift key More...
 
static int32_t kDefaultValueModifier = kControl
 default value modifier key, per default is the control key More...
 
static IdStringPtr kMessageTagWillChange = "kMessageTagWillChange"
 
static IdStringPtr kMessageTagDidChange = "kMessageTagDidChange"
 
static IdStringPtr kMessageValueChanged = "kMessageValueChanged"
 
static IdStringPtr kMessageBeginEdit = "kMessageBeginEdit"
 
static IdStringPtr kMessageEndEdit = "kMessageEndEdit"
 

Protected Types

enum  {
  kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3,
  kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kLastCViewFlag = 6
}
 
typedef std::set< IdStringPtrDeferedChangesSet
 
typedef std::list< CBaseObject * > DependentList
 

Protected Member Functions

 ~CControl ()
 
CGraphicsPathgetHitTestPath () const
 

Static Protected Member Functions

static int32_t mapVstKeyModifier (int32_t vstModifier)
 
static void rememberObject (CBaseObject *obj)
 
static void forgetObject (CBaseObject *obj)
 

Protected Attributes

CControlListenerlistener
 
int32_t tag
 
float oldValue
 
float defaultValue
 
float value
 
float vmin
 
float vmax
 
float wheelInc
 
int32_t editing
 
CPoint backOffset
 
CRect size
 
CRect mouseableArea
 
CFramepParentFrame
 
CViewpParentView
 
int32_t viewFlags
 
int32_t autosizeFlags
 
float alphaValue
 
int32_t deferChangeCount
 
DeferedChangesSet deferedChanges
 
DependentList dependents
 

Draw and Update Methods

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...
 
virtual void drawRect (CDrawContext *pContext, const CRect &updateRect)
 called if the view should draw itself More...
 
virtual bool checkUpdate (const CRect &updateRect) const
 
virtual void invalidRect (const CRect &rect)
 mark rect as invalid More...
 
virtual void invalid ()
 mark whole view as invalid More...
 
virtual void setVisible (bool state)
 set visibility state More...
 
bool isVisible () const
 get visibility state 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...
 
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...
 
enum  DragResult { kDragRefused = 0, kDragMoved, kDragCopied, kDragError = -1 }
 

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.

static int32_t idleRate
 global idle rate in Hz, defaults to 30 Hz More...
 
virtual void onIdle ()
 called on idle when view wants idle More...
 
void setWantsIdle (bool state)
 enable/disable onIdle() callback More...
 
bool wantsIdle () const
 returns if the view wants idle callback or not More...
 

Detailed Description

base class of all VSTGUI controls

This object manages the tag identification and the value of a control object.

Member Typedef Documentation

typedef std::set<IdStringPtr> DeferedChangesSet
protectedinherited
typedef std::list<CBaseObject*> DependentList
protectedinherited

Member Enumeration Documentation

anonymous enum
protectedinherited
Enumerator
kMouseEnabled 
kTransparencyEnabled 
kWantsFocus 
kIsAttached 
kVisible 
kDirty 
kWantsIdle 
kLastCViewFlag 
enum DragResult
inherited
Enumerator
kDragRefused 
kDragMoved 
kDragCopied 
kDragError 

Constructor & Destructor Documentation

CControl ( const CRect size,
CControlListener listener = 0,
int32_t  tag = 0,
CBitmap pBackground = 0 
)

+ Here is the call graph for this function:

CControl ( const CControl c)
~CControl ( )
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:

void addDependency ( CBaseObject obj)
inlinevirtualinherited

add a dependent object

+ Here is the caller graph for this function:

bool attached ( CView parent)
virtualinherited

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void beginEdit ( )
virtual

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void bounceValue ( )
virtual

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void changed ( IdStringPtr  message)
inlinevirtualinherited

notify dependent objects of change with message.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool checkDefaultValue ( CButtonState  button)
virtual

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual bool checkUpdate ( const CRect updateRect) const
inlinevirtualinherited

+ Here is the call graph for this function:

void copyBackOffset ( )
virtual

+ Here is the call graph for this function:

void deferChanges ( bool  state)
inlinevirtualinherited

defer changes until later. can be nested. If you use this, you must make sure that all message pointers are valid the whole time.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

void doIdleStuff ( )
virtual

+ Here is the call graph for this function:

void draw ( CDrawContext pContext)
pure virtual
bool drawFocusOnTop ( )
virtual

draw focus before view will be drawn or afterwards

Implements IFocusDrawing.

Reimplemented in CKnob.

+ Here is the caller graph for this function:

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

called if the view should draw itself

Reimplemented in CFrame, CViewContainer, CShadowViewContainer, and CLayeredViewContainer.

+ Here is the call graph for this function:

void endEdit ( )
virtual

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void forget ( )
inlinevirtualinherited

decrease refcount and delete object if refcount == 0

static void forgetObject ( CBaseObject obj)
inlinestaticprotectedinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CPoint & frameToLocal ( CPoint point) const
virtualinherited

conversion from frame coordinates to local view coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented in CViewContainer.

+ Here is the call graph for this function:

+ 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 int32_t  inSize,
void *  outData,
int32_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,
int32_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:

CBitmap* getBackground ( ) const
inlineinherited

get the background image of this view

+ Here is the caller graph for this function:

virtual const CPoint& getBackOffset ( ) const
inlinevirtual
virtual float getDefaultValue ( void  ) const
inlinevirtual

+ 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:

bool getFocusPath ( CGraphicsPath outPath)
virtual

the graphics path will be drawn filled with the evenodd method and the color set in CFrame::setFocusColor()

Implements IFocusDrawing.

Reimplemented in CKnob, and CParamDisplay.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CFrame* getFrame ( ) const
inlineinherited

get frame

+ 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 CControlListener* getListener ( ) const
inlinevirtual

get main listener

+ Here is the caller graph for this function:

virtual float getMax ( ) const
inlinevirtual

Reimplemented in COptionMenu.

+ Here is the caller graph for this function:

virtual float getMin ( ) const
inlinevirtual

Reimplemented in COptionMenu.

+ Here is the caller graph for this function:

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

+ Here is the caller graph for this function:

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 float getOldValue ( void  ) const
inlinevirtual

+ Here is the caller graph for this function:

CView* getParentView ( ) const
inlineinherited

get parent view

+ Here is the caller graph for this function:

float getRange ( ) const
inline

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual int32_t getTag ( ) const
inlinevirtual

+ 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 float getValue ( ) const
inlinevirtual

+ Here is the caller graph for this function:

float getValueNormalized ( ) const
virtual

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

CRect getVisibleViewSize ( ) const
virtualinherited

returns the visible size of the view

Returns
visible size of view

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual float getWheelInc ( ) const
inlinevirtual
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:

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

check if where hits this view

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

Reimplemented in CViewContainer, and CSplashScreen.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void invalid ( )
inlinevirtualinherited

mark whole view as invalid

Reimplemented in CFrame, and CViewContainer.

+ Here is the call graph for this function:

void invalidRect ( const CRect rect)
virtualinherited

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented in CFrame, CViewContainer, COpenGLView, and CLayeredViewContainer.

+ Here is the call graph for this function:

+ 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:

bool isDirty ( ) const
virtual

check if view is dirty

Reimplemented from CView.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool isEditing ( ) const
inline

+ Here is the caller graph for this function:

bool isVisible ( ) const
inlineinherited

get visibility state

+ Here is the caller graph for this function:

CPoint & localToFrame ( CPoint point) const
virtualinherited

conversion from local view coordinates to frame coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented in CViewContainer.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void looseFocus ( )
virtualinherited

called if view should loose focus

Reimplemented in COptionMenu, CViewContainer, and CTextEdit.

+ Here is the caller graph for this function:

int32_t mapVstKeyModifier ( int32_t  vstModifier)
staticprotected

+ Here is the caller graph for this function:

CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
)
virtualinherited
Parameters
sendermessage sender
messagemessage text
Returns
message handled or not. See CMessageResult

Reimplemented from CBaseObject.

Reimplemented in CViewContainer.

+ Here is the caller graph for this function:

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

called if a drag is entering this view

Reimplemented in CViewContainer.

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

called if a drag is leaving this view

Reimplemented in CViewContainer.

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

called if a drag is moved inside this view

Reimplemented in CViewContainer.

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

called if a drag is dropped onto this view

Reimplemented in CViewContainer.

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, CCheckBox, CRockerSwitch, CSlider, CFontChooser, CKnob, CHorizontalSwitch, CTextEdit, COnOffButton, CVerticalSwitch, and CMovieButton.

+ 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:

CMouseEventResult onMouseCancel ( )
virtualinherited

called when mouse tracking should be canceled

Reimplemented in CTextButton, CKickButton, CCheckBox, CSlider, CViewContainer, and COnOffButton.

+ Here is the caller graph for this function:

CMouseEventResult onMouseDown ( CPoint where,
const CButtonState buttons 
)
virtualinherited

called when a mouse down event occurs

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

Reimplemented in CTextButton, COptionMenu, CDataBrowser, CScrollbar, CFrame, CKickButton, CRockerSwitch, CCheckBox, CKnob, CAnimationSplashScreen, CSlider, CViewContainer, CHorizontalSwitch, CTextEdit, COnOffButton, CSplashScreen, CVerticalSwitch, CMovieButton, CAutoAnimation, and CXYPad.

+ 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 CScrollbar, and CFrame.

+ Here is the caller graph for this function:

CMouseEventResult onMouseMoved ( CPoint where,
const CButtonState buttons 
)
virtualinherited

called when a mouse move event occurs

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

Reimplemented in CTextButton, CScrollbar, CFrame, CKickButton, CRockerSwitch, CCheckBox, CKnob, CSlider, CViewContainer, CHorizontalSwitch, COnOffButton, CVerticalSwitch, CMovieButton, and CXYPad.

+ Here is the caller graph for this function:

CMouseEventResult onMouseUp ( CPoint where,
const CButtonState buttons 
)
virtualinherited

called when a mouse up event occurs

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

Reimplemented in CTextButton, CScrollbar, CFrame, CKickButton, CCheckBox, CRockerSwitch, CKnob, CSlider, CViewContainer, CHorizontalSwitch, COnOffButton, CVerticalSwitch, CMovieButton, and CXYPad.

+ Here is the caller graph for this function:

virtual void onTouchEvent ( ITouchEvent event)
inlinevirtualinherited

Reimplemented in CViewContainer.

+ Here is the caller graph for this function:

bool onWheel ( const CPoint where,
const float &  distance,
const CButtonState buttons 
)
virtualinherited

called if a mouse wheel event is happening over this view

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

Reimplemented in CFrame, CRockerSwitch, CSlider, CViewContainer, CKnob, and CTextLabel.

+ Here is the caller graph for this function:

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

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 in CScrollbar, CFrame, CScrollView, CViewContainer, and CTextLabel.

+ Here is the call graph for this function:

virtual void parentSizeChanged ( )
inlinevirtualinherited

notification that one of the views parent has changed its size

Reimplemented in CViewContainer, CTextEdit, COpenGLView, and CLayeredViewContainer.

+ Here is the caller graph for this function:

virtual void remember ( )
inlinevirtualinherited

increase refcount

+ Here is the caller graph for this function:

static void rememberObject ( CBaseObject obj)
inlinestaticprotectedinherited

+ Here is the call graph for this function:

+ 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:

bool removed ( CView parent)
virtualinherited

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented in CTextButton, CDataBrowser, CViewContainer, CSplitView, COpenGLView, UIViewSwitchContainer, and CLayeredViewContainer.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void removeDependency ( CBaseObject obj)
inlinevirtualinherited

remove a dependent object.

+ Here is the caller graph for this function:

void setAlphaValue ( float  alpha)
virtualinherited

set alpha value which will be applied when drawing this view

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool setAttribute ( const CViewAttributeID  aId,
const int32_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:

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:

void setBackOffset ( const CPoint offset)
virtual
virtual void setDefaultValue ( float  val)
inlinevirtual

+ Here is the caller graph for this function:

void setDirty ( bool  val = true)
virtual

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

Reimplemented from CView.

Reimplemented in 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 setListener ( CControlListener l)
inlinevirtual

set main listener

+ Here is the caller graph for this function:

virtual void setMax ( float  val)
inlinevirtual

Reimplemented in COptionMenu, CKnob, and CXYPad.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void setMin ( float  val)
inlinevirtual

Reimplemented in COptionMenu, CKnob, and CXYPad.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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:

virtual void setOldValue ( float  val)
inlinevirtual

+ Here is the caller graph for this function:

void setTag ( int32_t  val)
virtual

+ Here is the call graph for this function:

+ 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:

void setValue ( float  val)
virtual

Reimplemented in COptionMenu, and CTextEdit.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setValueNormalized ( float  val)
virtual

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setViewSize ( const CRect newSize,
bool  invalid = true 
)
virtualinherited

set views size

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

Reimplemented in CTextButton, CDataBrowser, CScrollbar, CFrame, CViewContainer, CSlider, CScrollView, CKnob, CTabView, CSplitView, CGradientView, CTextEdit, CTextLabel, CVuMeter, CShadowViewContainer, COpenGLView, CLayeredViewContainer, and CAutoLayoutContainerView.

+ Here is the call graph for this function:

+ 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 void setWheelInc ( float  val)
inlinevirtual

+ Here is the caller graph for this function:

void takeFocus ( )
virtualinherited

called if view should take focus

Reimplemented in COptionMenu, CViewContainer, and CTextEdit.

+ Here is the caller graph for this function:

void valueChanged ( )
virtual

notifies listener and dependent objects

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual bool wantsFocus ( ) const
inlinevirtualinherited

check if view supports focus

+ 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:

virtual bool wantsMultiTouchEvents ( ) const
inlinevirtualinherited

Reimplemented in CViewContainer.

Member Data Documentation

float alphaValue
protectedinherited
int32_t autosizeFlags
protectedinherited
CPoint backOffset
protected
float defaultValue
protected
int32_t deferChangeCount
protectedinherited
DeferedChangesSet deferedChanges
protectedinherited
DependentList dependents
protectedinherited
int32_t editing
protected
int32_t idleRate
staticinherited

global idle rate in Hz, defaults to 30 Hz

int32_t kDefaultValueModifier = kControl
static

default value modifier key, per default is the control key

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.

IdStringPtr kMessageBeginEdit = "kMessageBeginEdit"
static
IdStringPtr kMessageEndEdit = "kMessageEndEdit"
static
IdStringPtr kMessageTagDidChange = "kMessageTagDidChange"
static
IdStringPtr kMessageTagWillChange = "kMessageTagWillChange"
static
IdStringPtr kMessageValueChanged = "kMessageValueChanged"
static
int32_t kZoomModifier = kShift
static

zoom modifier key, per default is the shift key

CControlListener* listener
protected
CRect mouseableArea
protectedinherited
float oldValue
protected
CFrame* pParentFrame
protectedinherited
CView* pParentView
protectedinherited
CRect size
protectedinherited
int32_t tag
protected
float value
protected
int32_t viewFlags
protectedinherited
float vmax
protected
float vmin
protected
float wheelInc
protected

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