|
VSTGUI
3.6
|
Base Class of all view objects. More...
#include <vstgui.h>
Inheritance diagram for CView:Public Member Functions | |
| virtual | ~CView () |
| virtual void | setBackground (CBitmap *background) |
| set the background image of this view More... | |
| virtual CBitmap * | getBackground () const |
| get the background image of this view More... | |
| virtual void | setTransparency (bool val) |
| set views transparent state More... | |
| virtual bool | getTransparency () const |
| get views transparent state 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... | |
| bool | isAttached () const |
| is view attached to a parentView More... | |
| virtual bool | isTypeOf (const char *s) const |
| virtual CView * | newCopy () const |
| CMessageResult | notify (CBaseObject *sender, const char *message) |
| virtual void | mouse (CDrawContext *pContext, CPoint &where, long buttons=-1) |
| virtual void | getMouseLocation (CDrawContext *context, CPoint &point) |
| virtual void | setParentView (CView *pParentView) |
| virtual void | setFrame (CFrame *pParent) |
| virtual void | getFrameTopLeftPos (CPoint &topLeft) const |
Protected Attributes | |
| CRect | size |
| CRect | mouseableArea |
| CFrame * | pParentFrame |
| CView * | pParentView |
| bool | bDirty |
| bool | bMouseEnabled |
| bool | bTransparencyEnabled |
| bool | bWantsFocus |
| bool | bIsAttached |
| bool | bVisible |
| long | autosizeFlags |
| CBitmap * | pBackground |
| CAttributeListEntry * | pAttributeList |
Reference Counting Methods | |
| virtual void | forget () |
| decrease refcount and delete object if refcount == 0 More... | |
| virtual void | remember () |
| increase refcount More... | |
| long | getNbReference () const |
| get refcount More... | |
Constructor | |
| CView (const CRect &size) | |
| CView (const CView &view) | |
Draw and Update Methods | |
| 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 (const 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... | |
Mouse Methods | |
| virtual CMouseEventResult | onMouseDown (CPoint &where, const long &buttons) |
| called when a mouse down event occurs More... | |
| virtual CMouseEventResult | onMouseUp (CPoint &where, const long &buttons) |
| called when a mouse up event occurs More... | |
| virtual CMouseEventResult | onMouseMoved (CPoint &where, const long &buttons) |
| called when a mouse move event occurs More... | |
| virtual CMouseEventResult | onMouseEntered (CPoint &where, const long &buttons) |
| called when the mouse enters this view More... | |
| virtual CMouseEventResult | onMouseExited (CPoint &where, const long &buttons) |
| called when the mouse leaves this view More... | |
| virtual bool | hitTest (const CPoint &where, const long buttons=-1) |
| check if where hits this view More... | |
| virtual bool | onWheel (const CPoint &where, const float &distance, const long &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 long &buttons) |
| called if a mouse wheel event is happening over this view More... | |
| virtual void | setMouseEnabled (const 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... | |
Drag & Drop Methods | |
| virtual bool | onDrop (CDragContainer *drag, const CPoint &where) |
| called if a drag is dropped onto this view More... | |
| virtual void | onDragEnter (CDragContainer *drag, const CPoint &where) |
| called if a drag is entering this view More... | |
| virtual void | onDragLeave (CDragContainer *drag, const CPoint &where) |
| called if a drag is leaving this view More... | |
| virtual void | onDragMove (CDragContainer *drag, const CPoint &where) |
| called if a drag is moved inside this view More... | |
Keyboard Methods | |
| virtual long | onKeyDown (VstKeyCode &keyCode) |
| called if a key down event occurs and this view has focus More... | |
| virtual long | 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 (CRect &rect, bool invalid=true) |
| set views size More... | |
| virtual CRect & | getViewSize (CRect &rect) const |
| returns the current view size More... | |
| virtual const CRect & | getViewSize () const |
| read only access to view size More... | |
| virtual CRect | getVisibleSize () 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 (long flags) |
| set autosize flags More... | |
| virtual long | getAutosizeFlags () const |
| get autosize flags 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, long &outSize) const |
| get the size of an attribute More... | |
| bool | getAttribute (const CViewAttributeID id, const long inSize, void *outData, long &outSize) const |
| get an attribute More... | |
| bool | setAttribute (const CViewAttributeID id, const long inSize, const void *inData) |
| set an attribute More... | |
| bool | removeAttribute (const CViewAttributeID id) |
| remove an attribute More... | |
Parent Methods | |
| CView * | getParentView () const |
| get parent view More... | |
| CFrame * | getFrame () const |
| get frame More... | |
| virtual VSTGUIEditorInterface * | getEditor () const |
| get editor More... | |
Base Class of all view objects.
|
virtual |
|
virtual |
view is attached to a parent view
| parent | parent view |
Reimplemented in CViewContainer, CVuMeter, and CDataBrowser.
|
inlinevirtual |
|
virtual |
called if the view should draw itself
| pContext | draw context in which to draw |
Reimplemented in CFrame, CVuMeter, CViewContainer, CSplashScreen, CKickButton, CSpecialDigit, CSlider, CAutoAnimation, CMovieButton, CMovieBitmap, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CAnimKnob, CKnob, COptionMenu, CTextEdit, CTextLabel, CParamDisplay, COnOffButton, CControl, and CScrollbar.
|
inlinevirtual |
called if the view should draw itself
Reimplemented in CFrame, and CViewContainer.
|
inlinevirtualinherited |
decrease refcount and delete object if refcount == 0
Reimplemented in CDrawContext.
conversion from frame coordinates to local view coordinates
| point | location |
Reimplemented in CViewContainer.
| bool getAttribute | ( | const CViewAttributeID | id, |
| const long | inSize, | ||
| void * | outData, | ||
| long & | outSize | ||
| ) | const |
get an attribute
| id | 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 |
| bool getAttributeSize | ( | const CViewAttributeID | id, |
| long & | outSize | ||
| ) | const |
get the size of an attribute
| id | the ID of the Attribute |
| outSize | on return the size of the attribute |
|
inlinevirtual |
get autosize flags
|
inlinevirtual |
get the background image of this view
|
virtual |
get editor
Reimplemented in CFrame.
|
inline |
get frame
|
virtual |
|
inline |
get the height of the view
get the area in which the view reacts to the mouse
|
inlinevirtual |
read only access to the mouseable area
|
inlinevirtual |
get the state of wheather this view uses the mouse or not
|
virtual |
|
inlineinherited |
get refcount
|
inline |
get parent view
|
inlinevirtual |
get views transparent state
|
inlinevirtual |
read only access to view size
|
virtual |
returns the visible size of the view
|
inline |
get the width of the view
|
inlinevirtual |
check if where hits this view
Reimplemented in CViewContainer, and CSplashScreen.
|
inlinevirtual |
mark whole view as invalid
Reimplemented in CFrame, and CViewContainer.
|
virtual |
|
inline |
is view attached to a parentView
|
inlinevirtual |
check if view is dirty
Reimplemented in CViewContainer, CAnimKnob, and CControl.
|
inlinevirtual |
Reimplemented in CFrame, CViewContainer, CVuMeter, CSplashScreen, CKickButton, CSpecialDigit, CSlider, CAutoAnimation, CMovieButton, CMovieBitmap, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CAnimKnob, CKnob, COptionMenu, CTextEdit, CTextLabel, CParamDisplay, COnOffButton, CControl, CScrollbar, CScrollView, and CTabView.
|
inline |
get visibility state
conversion from local view coordinates to frame coordinates
| point | location |
Reimplemented in CViewContainer.
|
virtual |
called if view should loose focus
Reimplemented in CViewContainer, COptionMenu, and CTextEdit.
|
virtual |
Reimplemented in CFrame, CViewContainer, CSplashScreen, CKickButton, CSlider, CAutoAnimation, CMovieButton, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CKnob, COptionMenu, CTextEdit, COnOffButton, and CScrollbar.
|
inlinevirtual |
Reimplemented in CFrame, CViewContainer, CVuMeter, CSplashScreen, CKickButton, CSpecialDigit, CSlider, CAutoAnimation, CMovieButton, CMovieBitmap, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CAnimKnob, CKnob, COptionMenu, CTextEdit, CTextLabel, CParamDisplay, COnOffButton, CControl, CScrollbar, CScrollView, and CTabView.
|
virtual |
| sender | message sender |
| message | message text |
Reimplemented from CBaseObject.
Reimplemented in CViewContainer.
|
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.
|
virtual |
called if a key down event occurs and this view has focus
| keyCode | key code of pressed key |
Reimplemented in CFrame, CViewContainer, CSlider, and CKnob.
|
virtual |
called if a key up event occurs and this view has focus
| keyCode | key code of pressed key |
Reimplemented in CFrame, and CViewContainer.
|
virtual |
called when a mouse down event occurs
| where | mouse location of mouse down |
| buttons | button and modifier state |
Reimplemented in CFrame, CViewContainer, CSplashScreen, CKickButton, CSlider, CAutoAnimation, CMovieButton, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CKnob, COptionMenu, CTextEdit, COnOffButton, and CScrollbar.
|
inlinevirtual |
called when the mouse enters this view
|
inlinevirtual |
called when the mouse leaves this view
Reimplemented in CFrame.
|
virtual |
called when a mouse move event occurs
| where | mouse location of mouse move |
| buttons | button and modifier state |
Reimplemented in CFrame, CViewContainer, CKickButton, CSlider, CMovieButton, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CKnob, and CScrollbar.
|
virtual |
called when a mouse up event occurs
| where | mouse location of mouse up |
| buttons | button and modifier state |
Reimplemented in CFrame, CViewContainer, CKickButton, CSlider, CMovieButton, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CKnob, and CScrollbar.
|
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, CViewContainer, CSlider, CRockerSwitch, and CKnob.
|
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 CFrame, CViewContainer, CScrollbar, and CScrollView.
|
inlinevirtual |
notification that one of the views parent has changed its size
Reimplemented in CViewContainer, and CTextEdit.
|
inlinevirtualinherited |
increase refcount
| bool removeAttribute | ( | const CViewAttributeID | id | ) |
remove an attribute
|
virtual |
view is removed from parent view
| parent | parent view |
Reimplemented in CViewContainer, and CVuMeter.
| bool setAttribute | ( | const CViewAttributeID | id, |
| const long | inSize, | ||
| const void * | inData | ||
| ) |
set an attribute
copies data into the attribute. If it does not exist, creates a new attribute.
| id | the ID of the Attribute |
| inSize | the size of the outData pointer |
| inData | a pointer to the data |
|
inlinevirtual |
set autosize flags
|
virtual |
set the background image of this view
| background | new background bitmap |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
set the area in which the view reacts to the mouse
|
inlinevirtual |
turn on/off mouse usage for this view
|
inlinevirtual |
|
inlinevirtual |
set views transparent state
Reimplemented in CScrollView.
|
virtual |
set views size
| newSize | rect of new size of view |
| invalid | if true set view dirty |
Reimplemented in CFrame, CViewContainer, CSlider, CTextEdit, CScrollbar, CScrollView, and CTabView.
|
virtual |
set visibility state
|
inlinevirtual |
set focus support on/off
|
virtual |
called if view should take focus
Reimplemented in CViewContainer, COptionMenu, and CTextEdit.
|
inlinevirtual |
check if view supports focus
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
1.8.7