|
VSTGUI
3.6
|
The CFrame is the parent container of all views. More...
#include <vstgui.h>
Inheritance diagram for CFrame:Public Member Functions | |
| virtual | ~CFrame () |
| void | invalid () |
| mark whole view as invalid More... | |
| void | invalidRect (const CRect rect) |
| mark rect as invalid More... | |
| void * | getSystemWindow () const |
| get platform window More... | |
| bool | removeView (CView *pView, const bool &withForget=true) |
| remove a child view More... | |
| bool | removeAll (const bool &withForget=true) |
| remove all child views More... | |
| void | draw (CDrawContext *pContext) |
| void | drawRect (CDrawContext *pContext, const CRect &updateRect) |
| CMouseEventResult | onMouseDown (CPoint &where, const long &buttons) |
| called when a mouse down event occurs More... | |
| CMouseEventResult | onMouseUp (CPoint &where, const long &buttons) |
| called when a mouse up event occurs More... | |
| CMouseEventResult | onMouseMoved (CPoint &where, const long &buttons) |
| called when a mouse move event occurs More... | |
| CMouseEventResult | onMouseExited (CPoint &where, const long &buttons) |
| called when the mouse leaves this view More... | |
| bool | onWheel (const CPoint &where, const float &distance, const long &buttons) |
| called if a mouse wheel event is happening over this view More... | |
| 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... | |
| long | onKeyDown (VstKeyCode &keyCode) |
| called if a key down event occurs and this view has focus More... | |
| long | onKeyUp (VstKeyCode &keyCode) |
| called if a key up event occurs and this view has focus More... | |
| void | setViewSize (CRect &rect, bool invalid=true) |
| virtual VSTGUIEditorInterface * | getEditor () const |
| get editor More... | |
| virtual IMouseObserver * | getMouseObserver () const |
| virtual void | setMouseObserver (IMouseObserver *observer) |
| virtual bool | isTypeOf (const char *s) const |
| virtual CView * | newCopy () const |
| virtual bool | getCurrentLocation (CPoint &where) |
| virtual void | mouse (CDrawContext *pContext, CPoint &where, long buttons=-1) |
| virtual CView * | getCurrentView () const |
| void | draw (CView *pView=0) |
| virtual void | useOffscreen (bool b) |
| turn on/off using an offscreen. Not necessary with GDI+ on Windows, or on Mac OS X. More... | |
| void | modifyDrawContext (CCoord save[4], CDrawContext *pContext) |
| void | restoreDrawContext (CDrawContext *pContext, CCoord save[4]) |
| virtual bool | hitTest (const CPoint &where, const long buttons=-1) |
| virtual CMessageResult | notify (CBaseObject *sender, const char *message) |
| 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... | |
| 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 bool | invalidateDirtyViews () |
| virtual void | parentSizeChanged () |
| notification that one of the views parent has changed its size More... | |
| virtual CRect | getVisibleSize (const CRect rect) const |
| 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 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 | 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... | |
| bool | isAttached () const |
| is view attached to a parentView More... | |
| virtual void | getMouseLocation (CDrawContext *context, CPoint &point) |
| virtual void | setParentView (CView *pParentView) |
| virtual void | setFrame (CFrame *pParent) |
| virtual void | getFrameTopLeftPos (CPoint &topLeft) const |
Protected Member Functions | |
| bool | initFrame (void *pSystemWin) |
| virtual bool | checkUpdateRect (CView *view, const CRect &rect) |
| virtual bool | hitTestSubViews (const CPoint &where, const long buttons=-1) |
| void | drawBackToFront (CDrawContext *context, const CRect &rect) |
Protected Attributes | |
| VSTGUIEditorInterface * | pEditor |
| IMouseObserver * | pMouseObserver |
| void * | pSystemWindow |
| CView * | pModalView |
| CView * | pFocusView |
| CView * | pMouseOverView |
| bool | bFirstDraw |
| bool | bOpenFlag |
| bool | bDropActive |
| CCView * | pFirstView |
| CCView * | pLastView |
| COffscreenContext * | pOffscreenContext |
| CColor | backgroundColor |
| CPoint | backgroundOffset |
| bool | bDrawInOffscreen |
| CView * | currentDragView |
| CView * | mouseDownView |
| 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... | |
Draw and Update Methods | |
| virtual bool | checkUpdate (const CRect &updateRect) const |
| 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 | setVisible (bool state) |
| set visibility state More... | |
| bool | isVisible () const |
| get visibility state More... | |
Mouse Methods | |
| virtual CMouseEventResult | onMouseEntered (CPoint &where, const long &buttons) |
| called when the mouse enters 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... | |
View Size Methods | |
| virtual CRect | getVisibleSize () const |
| returns the visible size of the view More... | |
| CCoord | getHeight () const |
| get the height of the view More... | |
| CCoord | getWidth () const |
| get the width of the view 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 void | setAutosizeFlags (long flags) |
| set autosize flags More... | |
| virtual long | 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, 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... | |
Sub View Methods | |
| virtual bool | addView (CView *pView) |
| add a child view More... | |
| virtual bool | addView (CView *pView, CRect &mouseableArea, bool mouseEnabled=true) |
| add a child view More... | |
| virtual bool | addView (CView *pView, CView *pBefore) |
| add a child view before another view More... | |
| virtual bool | isChild (CView *pView) const |
| check if pView is a child view of this container More... | |
| virtual long | getNbViews () const |
| get the number of child views More... | |
| virtual CView * | getView (long index) const |
| get the child view at index More... | |
| virtual CView * | getViewAt (const CPoint &where, bool deep=false) const |
| get the view at point where More... | |
| virtual CViewContainer * | getContainerAt (const CPoint &where, bool deep=true) const |
| get the container at point where More... | |
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 CPoint & | getBackgroundOffset () const |
| get the offset of the background bitmap More... | |
| virtual void | drawBackgroundRect (CDrawContext *pContext, CRect &_updateRect) |
| draw the background More... | |
Constructor | |
| CFrame (const CRect &size, void *pSystemWindow, VSTGUIEditorInterface *pEditor) | |
CFrame Methods | |
| virtual bool | isOpen () const |
| virtual void | idle () |
| virtual void | doIdleStuff () |
| virtual unsigned long | getTicks () const |
| get the current time (in ms) More... | |
| virtual long | getKnobMode () const |
| get hosts knob mode More... | |
| virtual bool | setPosition (CCoord x, CCoord y) |
| virtual bool | getPosition (CCoord &x, CCoord &y) const |
| virtual bool | setSize (CCoord width, CCoord height) |
| virtual bool | getSize (CRect *pSize) const |
| virtual bool | getSize (CRect &pSize) const |
| virtual bool | setModalView (CView *pView) |
| virtual CView * | getModalView () const |
| virtual void | beginEdit (long index) |
| virtual void | endEdit (long index) |
| virtual bool | getCurrentMouseLocation (CPoint &where) const |
| get current mouse location More... | |
| virtual long | getCurrentMouseButtons () const |
| get current mouse buttons and key modifiers More... | |
| virtual void | setCursor (CCursorType type) |
| set mouse cursor More... | |
| virtual void | setFocusView (CView *pView) |
| virtual CView * | getFocusView () const |
| virtual bool | advanceNextFocusView (CView *oldFocus, bool reverse=false) |
| virtual void | onViewRemoved (CView *pView) |
| virtual bool | setDropActive (bool val) |
| virtual bool | isDropActive () const |
| CDrawContext * | createDrawContext () |
| virtual void | setOpenFlag (bool val) |
| virtual bool | getOpenFlag () const |
| virtual void | invalidate (const CRect &rect) |
| void | scrollRect (const CRect &src, const CPoint &distance) |
| scroll src rect by distance More... | |
The CFrame is the parent container of all views.
It creates a platform dependend view object.
On Mac OS X it is a HIView.
On Windows it's a WS_CHILD Window.
| CFrame | ( | const CRect & | inSize, |
| void * | inSystemWindow, | ||
| VSTGUIEditorInterface * | inEditor | ||
| ) |
| inSize | size of frame |
| inSystemWindow | parent platform window |
| inEditor | editor |
|
virtual |
|
virtualinherited |
add a child view
| pView | the view object to add to this container |
Reimplemented in CScrollView.
add a child view
| pView | the view object to add to this container |
| mouseableArea | the view area in where the view will get mouse events |
| mouseEnabled | bool to set if view will get mouse events |
Reimplemented in CScrollView.
add a child view before another view
| pView | the view object to add to this container |
| pBefore | the view object |
|
virtual |
| oldFocus | old focus view |
| reverse | search order |
Reimplemented from CViewContainer.
|
virtualinherited |
view is attached to a parent view
| parent | parent view |
Reimplemented from CView.
Reimplemented in CDataBrowser.
|
virtual |
|
inlinevirtualinherited |
check if view needs to be updated for rect
| view | view to check |
| rect | update rect |
| CDrawContext * createDrawContext | ( | ) |
|
virtual |
|
virtual |
| pContext | the context which to use to draw this container and its subviews |
Reimplemented from CViewContainer.
| void draw | ( | CView * | pView = 0 | ) |
|
virtualinherited |
draw the background
| pContext | the context which to use to draw the background |
| _updateRect | the area which to draw |
Reimplemented in CScrollView.
|
protectedinherited |
|
virtual |
| pContext | the context which to use to draw |
| updateRect | the area which to draw |
Reimplemented from CViewContainer.
|
virtual |
|
inlinevirtualinherited |
decrease refcount and delete object if refcount == 0
Reimplemented in CDrawContext.
conversion from frame coordinates to local view coordinates
| point | location |
Reimplemented from CView.
|
inherited |
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 |
|
inherited |
get the size of an attribute
| id | the ID of the Attribute |
| outSize | on return the size of the attribute |
|
inlinevirtualinherited |
get autosize flags
|
inlinevirtualinherited |
get the background image of this view
|
inlinevirtualinherited |
get the background color
|
inlinevirtualinherited |
get the offset of the background bitmap
|
virtualinherited |
get the container at point where
| p | location |
| deep | search deep |
|
virtual |
|
virtual |
get current mouse buttons and key modifiers
|
virtual |
get current mouse location
| where | location of mouse |
|
virtual |
Reimplemented from CViewContainer.
|
inlinevirtual |
get editor
Reimplemented from CView.
|
inlinevirtual |
|
inlineinherited |
get frame
|
virtualinherited |
|
inlineinherited |
get the height of the view
|
virtual |
get hosts knob mode
|
inlinevirtual |
get the area in which the view reacts to the mouse
|
inlinevirtualinherited |
read only access to the mouseable area
|
inlinevirtualinherited |
get the state of wheather this view uses the mouse or not
|
virtualinherited |
|
inlinevirtual |
|
inlineinherited |
get refcount
|
virtualinherited |
|
inlinevirtual |
|
inlineinherited |
get parent view
get global position of frame
| x | x coordinate |
| y | y coordinate |
|
virtual |
get size relative to parent
| pRect | size |
|
virtual |
| void * getSystemWindow | ( | ) | const |
get platform window
|
virtual |
get the current time (in ms)
|
inlinevirtualinherited |
get views transparent state
|
virtualinherited |
get the child view at index
| index | the index of the view to return |
Reimplemented in CScrollView.
get the view at point where
| p | location |
| deep | search deep |
returns the current view size
|
inlinevirtualinherited |
read only access to view size
|
virtualinherited |
returns the visible size of the view
| rect | size to get visible size of |
|
inlineinherited |
get the width of the view
|
virtualinherited |
| where | point |
| buttons | mouse button and modifier state |
Reimplemented from CView.
|
protectedvirtualinherited |
| where | point |
| buttons | mouse button and modifier state |
|
virtual |
|
protected |
|
inlinevirtual |
mark whole view as invalid
Reimplemented from CViewContainer.
|
virtual |
|
virtualinherited |
|
virtual |
|
inlineinherited |
is view attached to a parentView
|
virtualinherited |
check if pView is a child view of this container
| pView | the view which should be checked if it is a child of this container |
Reimplemented in CScrollView.
|
virtualinherited |
check if view is dirty
Reimplemented from CView.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Reimplemented from CViewContainer.
|
inlineinherited |
get visibility state
conversion from local view coordinates to frame coordinates
| point | location |
Reimplemented from CView.
|
virtualinherited |
called if view should loose focus
Reimplemented from CView.
|
inherited |
|
virtual |
Reimplemented from CViewContainer.
|
inlinevirtual |
Reimplemented from CViewContainer.
|
virtualinherited |
| sender | message sender |
| message | message text |
Reimplemented from CView.
Reimplemented in CDataBrowser.
|
virtualinherited |
called if a drag is entering this view
Reimplemented from CView.
|
virtualinherited |
called if a drag is leaving this view
Reimplemented from CView.
|
virtualinherited |
called if a drag is moved inside this view
Reimplemented from CView.
|
virtualinherited |
called if a drag is dropped onto this view
Reimplemented from CView.
|
virtual |
called if a key down event occurs and this view has focus
| keyCode | key code of pressed key |
Reimplemented from CViewContainer.
|
virtual |
called if a key up event occurs and this view has focus
| keyCode | key code of pressed key |
Reimplemented from CViewContainer.
|
virtual |
called when a mouse down event occurs
| where | mouse location of mouse down |
| buttons | button and modifier state |
Reimplemented from CViewContainer.
|
inlinevirtualinherited |
called when the mouse enters this view
|
virtual |
called when the mouse leaves this view
Reimplemented from CView.
|
virtual |
called when a mouse move event occurs
| where | mouse location of mouse move |
| buttons | button and modifier state |
Reimplemented from CViewContainer.
|
virtual |
called when a mouse up event occurs
| where | mouse location of mouse up |
| buttons | button and modifier state |
Reimplemented from CViewContainer.
|
virtual |
| pView | view which was removed |
|
virtual |
called if a mouse wheel event is happening over this view
| where | location |
| distance | wheel distance |
| buttons | button and modifier state |
Reimplemented from CViewContainer.
|
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 from CViewContainer.
|
virtualinherited |
notification that one of the views parent has changed its size
Reimplemented from CView.
|
inlinevirtualinherited |
increase refcount
|
virtual |
remove all child views
| withForget | bool to indicate if the view's reference counter should be decreased after removed from the container |
Reimplemented from CViewContainer.
|
inherited |
remove an attribute
|
virtualinherited |
view is removed from parent view
| parent | parent view |
Reimplemented from CView.
|
virtual |
remove a child view
| pView | the view which should be removed from the container |
| withForget | bool to indicate if the view's reference counter should be decreased after removed from the container |
Reimplemented from CViewContainer.
|
inherited |
scroll src rect by distance
| src | rect which to scroll |
| distance | point of distance |
|
inherited |
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 |
|
inlinevirtualinherited |
set autosize flags
|
virtualinherited |
set the background image of this view
| background | new background bitmap |
|
virtualinherited |
set the background color (will only be drawn if this container is not set to transparent and does not have a background bitmap)
| color | the new background color of the container |
|
inlinevirtualinherited |
set the offset of the background bitmap
|
virtual |
set mouse cursor
| type | cursor type see CCursorType |
|
inlinevirtualinherited |
|
virtual |
|
virtual |
| pView | new focus view |
|
inlinevirtualinherited |
|
virtual |
| pView | the view which should be set to modal. |
|
inlinevirtualinherited |
set the area in which the view reacts to the mouse
|
inlinevirtualinherited |
turn on/off mouse usage for this view
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtualinherited |
repositions the frame
| x | x coordinate |
| y | y coordinate |
set size of frame (and the platform representation)
| width | new width |
| height | new height |
|
inlinevirtualinherited |
set views transparent state
Reimplemented in CScrollView.
|
virtual |
| rect | the new size of the container |
| invalid | the views to dirty |
Reimplemented from CViewContainer.
|
virtualinherited |
set visibility state
|
inlinevirtualinherited |
set focus support on/off
|
virtualinherited |
called if view should take focus
Reimplemented from CView.
|
virtualinherited |
turn on/off using an offscreen. Not necessary with GDI+ on Windows, or on Mac OS X.
|
inlinevirtualinherited |
check if view supports focus
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protectedinherited |
|
protected |
|
protectedinherited |
|
protected |
|
protected |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protectedinherited |
1.8.7