|
VSTGUI
4.2
Graphical User Interface Framework not only for VST plugins
|
Base Class of all view objects. More...
Inheritance diagram for CView:
Collaboration diagram for CView:Public Member Functions | |
| CView (const CRect &size) | |
| CView (const CView &view) | |
| CMessageResult | notify (CBaseObject *sender, IdStringPtr message) |
| virtual bool | isTypeOf (IdStringPtr s) const |
| virtual CBaseObject * | newCopy () const |
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 CRect & | getMouseableArea (CRect &rect) const |
| get the area in which the view reacts to the mouse More... | |
| virtual const CRect & | getMouseableArea () 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... | |
| CRect & | getViewSize (CRect &rect) const |
| returns the current view size More... | |
| const CRect & | getViewSize () 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 CPoint & | frameToLocal (CPoint &point) const |
| conversion from frame coordinates to local view coordinates More... | |
| virtual CPoint & | localToFrame (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... | |
| CBitmap * | getBackground () 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... | |
| CBitmap * | getDisabledBackground () const |
| get background image used when the mouse is not enabled More... | |
| CBitmap * | getDrawBackground () 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 | |
| CView * | getParentView () const |
| get parent view More... | |
| CFrame * | getFrame () const |
| get frame More... | |
| virtual VSTGUIEditorInterface * | getEditor () 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... | |
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 } |
Protected Member Functions | |
| ~CView () | |
| CGraphicsPath * | getHitTestPath () const |
Protected Attributes | |
| CRect | size |
| CRect | mouseableArea |
| CFrame * | pParentFrame |
| CView * | pParentView |
| int32_t | viewFlags |
| int32_t | autosizeFlags |
| float | alphaValue |
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 | 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 bool | checkUpdate (const CRect &updateRect) const |
| virtual bool | isDirty () const |
| check if view is dirty More... | |
| 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 | 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 | |
| enum | DragResult { kDragRefused = 0, kDragMoved, kDragCopied, kDragError = -1 } |
| 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... | |
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... | |
Base Class of all view objects.
|
protected |
| enum DragResult |
|
protected |
Here is the call graph for this function:| void addAnimation | ( | IdStringPtr | name, |
| Animation::IAnimationTarget * | target, | ||
| Animation::ITimingFunction * | timingFunction, | ||
| CBaseObject * | notificationObject = 0 |
||
| ) |
Here is the call graph for this function:
Here is the caller graph for this function:
|
virtual |
view is attached to a parent view
| parent | parent view |
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:
|
inlinevirtual |
Here is the call graph for this function:
|
virtual |
start a drag operation. See CDropSource to create the source data package
a drag can only be started from within onMouseDown
| source | source drop |
| offset | bitmap offset |
| dragBitmap | bitmap to drag |
Reimplemented in CFrame.
Here is the call graph for this function:
|
virtual |
called if the view should draw itself
| pContext | draw context in which to draw |
Reimplemented in CTextButton, COptionMenu, CScrollbar, CControl, CFrame, CAnimKnob, CKickButton, CCheckBox, CRockerSwitch, CAnimationSplashScreen, CSlider, CViewContainer, CKnob, CParamDisplay, CHorizontalSwitch, CGradientView, CVuMeter, CTextLabel, CTextEdit, COnOffButton, CVerticalSwitch, CAutoAnimation, CMovieBitmap, CMovieButton, CSplashScreen, CSpecialDigit, and CXYPad.
Here is the call graph for this function:
Here is the caller graph for this function:
|
inlinevirtual |
called if the view should draw itself
Reimplemented in CFrame, CViewContainer, CShadowViewContainer, and CLayeredViewContainer.
Here is the call graph for this function:
|
inlinevirtualinherited |
decrease refcount and delete object if refcount == 0
conversion from frame coordinates to local view coordinates
| point | location |
Reimplemented in CViewContainer.
Here is the call graph for this function:
Here is the caller graph for this function:
|
inline |
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 |
get an attribute
| aId | the ID of the Attribute |
| inSize | the size of the outData pointer |
| outData | a pointer where to copy the attribute data |
| outSize | the size in bytes which was copied into outData |
Here is the caller graph for this function:| bool getAttributeSize | ( | const CViewAttributeID | aId, |
| int32_t & | outSize | ||
| ) | const |
get the size of an attribute
| aId | the ID of the Attribute |
| outSize | on return the size of the attribute |
Here is the caller graph for this function:
|
inlinevirtual |
get autosize flags
Here is the caller graph for this function:
|
inline |
get the background image of this view
Here is the caller graph for this function:
|
inline |
get background image used when the mouse is not enabled
|
inline |
Here is the call graph for this function:
Here is the caller graph for this function:
|
virtual |
|
inline |
get frame
Here is the caller graph for this function:
|
inline |
get the height of the view
Here is the call graph for this function:
Here is the caller graph for this function:
|
inlineprotected |
get the area in which the view reacts to the mouse
Here is the caller graph for this function:
|
inlinevirtual |
read only access to the mouseable area
Here is the caller graph for this function:
|
inlinevirtual |
get the state of wheather this view uses the mouse or not
Here is the caller graph for this function:
|
inlinevirtualinherited |
get refcount
|
inline |
get parent view
Here is the caller graph for this function:
|
inlinevirtual |
get views transparent state
Here is the caller graph for this function:returns the current view size
Here is the caller graph for this function:
|
inline |
read only access to view size
|
virtual |
returns the visible size of the view
Here is the call graph for this function:
Here is the caller graph for this function:
|
inline |
get the width of the view
Here is the call graph for this function:
Here is the caller graph for this function:
|
virtual |
check if where hits this view
| where | location |
| buttons | button and modifier state |
Reimplemented in CViewContainer, and CSplashScreen.
Here is the call graph for this function:
Here is the caller graph for this function:
|
inlinevirtual |
mark whole view as invalid
Reimplemented in CFrame, and CViewContainer.
Here is the call graph for this function:
|
virtual |
mark rect as invalid
| rect | rect 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:
|
inline |
is view attached to a parentView
Here is the caller graph for this function:
|
inlinevirtual |
check if view is dirty
Reimplemented in CControl, and CViewContainer.
Here is the caller graph for this function:
|
inlinevirtual |
Reimplemented in CTextButton, CViewContainer, COptionMenu, CControl, CScrollbar, CFrame, CAnimKnob, CKickButton, CRockerSwitch, CCheckBox, CScrollView, CSlider, CKnob, CRowColumnView, CParamDisplay, CHorizontalSwitch, CTabView, CTextEdit, CShadowViewContainer, CVuMeter, CTextLabel, COpenGLView, COnOffButton, CAutoAnimation, CSplashScreen, CVerticalSwitch, CMovieButton, UIViewSwitchContainer, CAutoLayoutContainerView, CMovieBitmap, and CSpecialDigit.
|
inline |
get visibility state
Here is the caller graph for this function:conversion from local view coordinates to frame coordinates
| point | location |
Reimplemented in CViewContainer.
Here is the call graph for this function:
Here is the caller graph for this function:
|
virtual |
called if view should loose focus
Reimplemented in COptionMenu, CViewContainer, and CTextEdit.
Here is the caller graph for this function:
|
inlinevirtual |
Reimplemented in CTextButton, CViewContainer, COptionMenu, CControl, CScrollbar, CFrame, CAnimKnob, CKickButton, CRockerSwitch, CCheckBox, CScrollView, CSlider, CKnob, CRowColumnView, CParamDisplay, CHorizontalSwitch, CTabView, CTextEdit, CShadowViewContainer, CVuMeter, CTextLabel, COpenGLView, COnOffButton, CAutoAnimation, CSplashScreen, CVerticalSwitch, CMovieButton, UIViewSwitchContainer, CAutoLayoutContainerView, CMovieBitmap, and CSpecialDigit.
Here is the caller graph for this function:
|
virtual |
| sender | message sender |
| message | message text |
Reimplemented from CBaseObject.
Reimplemented in CViewContainer.
Here is the caller graph for this function:
|
inlinevirtual |
called if a drag is entering this view
Reimplemented in CViewContainer.
|
inlinevirtual |
called if a drag is leaving this view
Reimplemented in CViewContainer.
|
inlinevirtual |
called if a drag is moved inside this view
Reimplemented in CViewContainer.
|
inlinevirtual |
called if a drag is dropped onto this view
Reimplemented in CViewContainer.
|
inlinevirtual |
called on idle when view wants idle
Reimplemented in CVuMeter.
|
virtual |
called if a key down event occurs and this view has focus
| keyCode | key code of pressed key |
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:
|
virtual |
called if a key up event occurs and this view has focus
| keyCode | key code of pressed key |
Reimplemented in CTextButton, CFrame, CKickButton, and CRockerSwitch.
Here is the caller graph for this function:
|
virtual |
called when mouse tracking should be canceled
Reimplemented in CTextButton, CKickButton, CCheckBox, CSlider, CViewContainer, and COnOffButton.
Here is the caller graph for this function:
|
virtual |
called when a mouse down event occurs
| where | mouse location of mouse down |
| buttons | button and modifier state |
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:
|
inlinevirtual |
called when the mouse enters this view
Reimplemented in CScrollbar.
|
inlinevirtual |
called when the mouse leaves this view
Reimplemented in CScrollbar, and CFrame.
Here is the caller graph for this function:
|
virtual |
called when a mouse move event occurs
| where | mouse location of mouse move |
| buttons | button and modifier state |
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:
|
virtual |
called when a mouse up event occurs
| where | mouse location of mouse up |
| buttons | button and modifier state |
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:
|
inlinevirtual |
|
virtual |
called if a mouse wheel event is happening over this view
| where | location |
| distance | wheel distance |
| buttons | button and modifier state |
Reimplemented in CFrame, CRockerSwitch, CSlider, CViewContainer, CKnob, and CTextLabel.
Here is the caller graph for this function:
|
virtual |
called if a mouse wheel event is happening over this view
| where | location |
| axis | mouse wheel axis |
| distance | wheel distance |
| buttons | button and modifier state |
Reimplemented in CScrollbar, CFrame, CScrollView, CViewContainer, and CTextLabel.
Here is the call graph for this function:
|
inlinevirtual |
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:
|
inlinevirtualinherited |
increase refcount
Here is the caller graph for this function:| void removeAllAnimations | ( | ) |
Here is the call graph for this function:| void removeAnimation | ( | IdStringPtr | name | ) |
Here is the call graph for this function:| bool removeAttribute | ( | const CViewAttributeID | id | ) |
remove an attribute
Here is the caller graph for this function:
|
virtual |
view is removed from parent view
| parent | parent view |
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:
|
virtual |
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 | ||
| ) |
set an attribute
copies data into the attribute. If it does not exist, creates a new attribute.
| aId | the ID of the Attribute |
| inSize | the size of the outData pointer |
| inData | a pointer to the data |
Here is the caller graph for this function:
|
inlinevirtual |
set autosize flags
Reimplemented in CDataBrowser, CScrollView, and CTabView.
Here is the caller graph for this function:
|
virtual |
|
virtual |
|
virtual |
set background image used when the mouse is not enabled
| background | new disabled background bitmap |
Here is the call graph for this function:| void setHitTestPath | ( | CGraphicsPath * | path | ) |
| path | the 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. |
|
inlinevirtual |
set the area in which the view reacts to the mouse
Here is the caller graph for this function:
|
virtual |
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 |
set views transparent state
Reimplemented in CScrollView.
Here is the call graph for this function:
Here is the caller graph for this function:
|
virtual |
set views size
| newSize | rect of new size of view |
| invalid | if 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:
|
virtual |
set visibility state
Reimplemented in COpenGLView.
Here is the call graph for this function:
Here is the caller graph for this function:
|
virtual |
| void setWantsIdle | ( | bool | state | ) |
enable/disable onIdle() callback
Here is the call graph for this function:
Here is the caller graph for this function:
|
inlinevirtual |
resize view to optimal size
Reimplemented in CTextButton, CAnimKnob, CKickButton, CViewContainer, CRockerSwitch, CCheckBox, CSlider, CAnimationSplashScreen, CKnob, CRowColumnView, CHorizontalSwitch, CSplitView, CVuMeter, CTextLabel, COnOffButton, CVerticalSwitch, CMovieButton, and CMovieBitmap.
|
virtual |
called if view should take focus
Reimplemented in COptionMenu, CViewContainer, and CTextEdit.
Here is the caller graph for this function:
|
inlinevirtual |
check if view supports focus
Here is the caller graph for this function:
|
inline |
returns if the view wants idle callback or not
Here is the caller graph for this function:
|
inlinevirtual |
Reimplemented in CViewContainer.
|
protected |
|
protected |
|
static |
global idle rate in Hz, defaults to 30 Hz
|
static |
if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |