The CFrame is the parent container of all views. More...
#include <vstgui.h>
Public Member Functions | |
| virtual | ~CFrame () |
| void | invalid () |
| mark whole view as invalid | |
| void | invalidRect (const CRect rect) |
| mark rect as invalid | |
| void * | getSystemWindow () const |
| get platform window | |
| bool | removeView (CView *pView, const bool &withForget=true) |
| remove a child view | |
| bool | removeAll (const bool &withForget=true) |
| remove all child views | |
| 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 | |
| CMouseEventResult | onMouseUp (CPoint &where, const long &buttons) |
| called when a mouse up event occurs | |
| CMouseEventResult | onMouseMoved (CPoint &where, const long &buttons) |
| called when a mouse move event occurs | |
| CMouseEventResult | onMouseExited (CPoint &where, const long &buttons) |
| called when the mouse leaves this view | |
| bool | onWheel (const CPoint &where, const float &distance, const long &buttons) |
| called if a mouse wheel event is happening over this view | |
| 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 | |
| long | onKeyDown (VstKeyCode &keyCode) |
| called if a key down event occurs and this view has focus | |
| long | onKeyUp (VstKeyCode &keyCode) |
| called if a key up event occurs and this view has focus | |
| void | setViewSize (CRect &rect, bool invalid=true) |
| virtual VSTGUIEditorInterface * | getEditor () const |
| get editor | |
| virtual IMouseObserver * | getMouseObserver () const |
| virtual void | setMouseObserver (IMouseObserver *observer) |
| VSTGUI_DEPRECATED (virtual bool getCurrentLocation(CPoint &where);) VSTGUI_DEPRECATED(virtual void mouse(CDrawContext *pContext | |
| VSTGUI_DEPRECATED (virtual CView *getCurrentView() const ;) VSTGUI_DEPRECATED(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. | |
| 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 | |
| virtual void | onDragEnter (CDragContainer *drag, const CPoint &where) |
| called if a drag is entering this view | |
| virtual void | onDragLeave (CDragContainer *drag, const CPoint &where) |
| called if a drag is leaving this view | |
| virtual void | onDragMove (CDragContainer *drag, const CPoint &where) |
| called if a drag is moved inside this view | |
| virtual void | looseFocus () |
| called if view should loose focus | |
| virtual void | takeFocus () |
| called if view should take focus | |
| virtual bool | isDirty () const |
| check if view is dirty | |
| virtual bool | invalidateDirtyViews () |
| virtual void | parentSizeChanged () |
| notification that one of the views parent has changed its size | |
| virtual CRect | getVisibleSize (const CRect rect) const |
| virtual bool | removed (CView *parent) |
| view is removed from parent view | |
| virtual bool | attached (CView *parent) |
| view is attached to a parent view | |
| virtual CPoint & | frameToLocal (CPoint &point) const |
| conversion from frame coordinates to local view coordinates | |
| virtual CPoint & | localToFrame (CPoint &point) const |
| conversion from local view coordinates to frame coordinates | |
| VSTGUI_DEPRECATED (virtual void mouse(CDrawContext *pContext, CPoint &where, long buttons=-1);) VSTGUI_DEPRECATED(virtual CView *getCurrentView() const | |
| VSTGUI_DEPRECATED (virtual void mouse(CDrawContext *pContext, CPoint &where, long buttons=-1);) VSTGUI_DEPRECATED(virtual void getMouseLocation(CDrawContext *context | |
| VSTGUI_DEPRECATED (virtual void setParentView(CView *pParentView){this->pParentView=pParentView;}) VSTGUI_DEPRECATED(virtual void setFrame(CFrame *pParent) | |
| < | |
| virtual void | setBackground (CBitmap *background) |
| set the background image of this view | |
| virtual CBitmap * | getBackground () const |
| get the background image of this view | |
| virtual void | setTransparency (bool val) |
| set views transparent state | |
| virtual bool | getTransparency () const |
| get views transparent state | |
| bool | isAttached () const |
| is view attached to a parentView | |
| virtual bool | isTypeOf (const char *s) const |
| virtual CView * | newCopy () const |
Public Attributes | |
| CPoint & | where |
| CPoint long | buttons = -1) |
| CPoint & | point |
| VSTGUI_DEPRECATED(virtual void getFrameTopLeftPos(CPoint &topLeft) const ;) protected CRect | mouseableArea |
| < | |
| CFrame * | pParentFrame |
| CView * | pParentView |
| bool | bDirty |
| bool | bMouseEnabled |
| bool | bTransparencyEnabled |
| bool | bWantsFocus |
| bool | bIsAttached |
| bool | bVisible |
| long | autosizeFlags |
| CBitmap * | pBackground |
| CAttributeListEntry * | pAttributeList |
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 |
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) | |
| virtual long | getKnobMode () const |
| get hosts knob mode | |
| 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 | |
| virtual long | getCurrentMouseButtons () const |
| get current mouse buttons and key modifiers | |
| virtual void | setCursor (CCursorType type) |
| set mouse cursor | |
| 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 | |
Sub View Methods | |
|
| |
| virtual bool | addView (CView *pView) |
| add a child view | |
| virtual bool | addView (CView *pView, CRect &mouseableArea, bool mouseEnabled=true) |
| add a child view | |
| virtual bool | addView (CView *pView, CView *pBefore) |
| add a child view before another view | |
| virtual bool | isChild (CView *pView) const |
| check if pView is a child view of this container | |
| virtual long | getNbViews () const |
| get the number of child views | |
| virtual CView * | getView (long index) const |
| get the child view at index | |
| virtual CView * | getViewAt (const CPoint &where, bool deep=false) const |
| get the view at point where | |
| virtual CViewContainer * | getContainerAt (const CPoint &where, bool deep=true) const |
| get the container at point where | |
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) | |
| virtual CColor | getBackgroundColor () const |
| get the background color | |
| virtual void | setBackgroundOffset (const CPoint &p) |
| set the offset of the background bitmap | |
| virtual const CPoint & | getBackgroundOffset () const |
| get the offset of the background bitmap | |
| virtual void | drawBackgroundRect (CDrawContext *pContext, CRect &_updateRect) |
| draw the background | |
View Size Methods | |
|
| |
| virtual CRect | getVisibleSize () const |
| returns the visible size of the view | |
| CCoord | getHeight () const |
| get the height of the view | |
| CCoord | getWidth () const |
| get the width of the view | |
| virtual CRect & | getViewSize (CRect &rect) const |
| returns the current view size | |
| virtual const CRect & | getViewSize () const |
| read only access to view size | |
| virtual void | setAutosizeFlags (long flags) |
| set autosize flags | |
| virtual long | getAutosizeFlags () const |
| get autosize flags | |
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 ! | |
| virtual void | setVisible (bool state) |
| set visibility state | |
| bool | isVisible () const |
| get visibility state | |
Mouse Methods | |
|
| |
| virtual CMouseEventResult | onMouseEntered (CPoint &where, const long &buttons) |
| called when the mouse enters this view | |
| virtual void | setMouseEnabled (const bool bEnable=true) |
| turn on/off mouse usage for this view | |
| virtual bool | getMouseEnabled () const |
| get the state of wheather this view uses the mouse or not | |
| virtual void | setMouseableArea (const CRect &rect) |
| set the area in which the view reacts to the mouse | |
| virtual CRect & | getMouseableArea (CRect &rect) const |
| get the area in which the view reacts to the mouse | |
| virtual const CRect & | getMouseableArea () const |
| read only access to the mouseable area | |
Focus Methods | |
|
| |
| virtual bool | wantsFocus () const |
| check if view supports focus | |
| virtual void | setWantsFocus (bool state) |
| set focus support on/off | |
Attribute Methods | |
|
| |
| bool | getAttributeSize (const CViewAttributeID id, long &outSize) const |
| get the size of an attribute | |
| bool | getAttribute (const CViewAttributeID id, const long inSize, void *outData, long &outSize) const |
| get an attribute | |
| bool | setAttribute (const CViewAttributeID id, const long inSize, const void *inData) |
| set an attribute | |
| bool | removeAttribute (const CViewAttributeID id) |
| remove an attribute | |
Parent Methods | |
|
| |
| CView * | getParentView () const |
| get parent view | |
| CFrame * | getFrame () const |
| get frame | |
Reference Counting Methods | |
|
| |
| virtual void | forget () |
| decrease refcount and delete object if refcount == 0 | |
| virtual void | remember () |
| increase refcount | |
| long | getNbReference () const |
| get refcount | |
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 |
| ~CFrame | ( | ) | [virtual] |
| virtual bool isOpen | ( | ) | const [inline, virtual] |
| void idle | ( | ) | [virtual] |
| void doIdleStuff | ( | ) | [virtual] |
| unsigned long getTicks | ( | ) | const [virtual] |
get the current time (in ms)
| long getKnobMode | ( | ) | const [virtual] |
get hosts knob mode
repositions the frame
| x | x coordinate | |
| y | y coordinate |
get global position of frame
| x | x coordinate | |
| y | y coordinate |
set size of frame (and the platform representation)
| width | new width | |
| height | new height |
| bool getSize | ( | CRect * | pRect | ) | const [virtual] |
get size relative to parent
| pRect | size |
| bool getSize | ( | CRect & | pSize | ) | const [virtual] |
| bool setModalView | ( | CView * | pView | ) | [virtual] |
| pView | the view which should be set to modal. |
| virtual CView* getModalView | ( | ) | const [inline, virtual] |
| void beginEdit | ( | long | index | ) | [virtual] |
| void endEdit | ( | long | index | ) | [virtual] |
| bool getCurrentMouseLocation | ( | CPoint & | where | ) | const [virtual] |
get current mouse location
| where | location of mouse |
| long getCurrentMouseButtons | ( | ) | const [virtual] |
get current mouse buttons and key modifiers
| void setCursor | ( | CCursorType | type | ) | [virtual] |
set mouse cursor
| type | cursor type see CCursorType |
| void setFocusView | ( | CView * | pView | ) | [virtual] |
| pView | new focus view |
| virtual CView* getFocusView | ( | ) | const [inline, virtual] |
| bool advanceNextFocusView | ( | CView * | oldFocus, | |
| bool | reverse = false | |||
| ) | [virtual] |
| oldFocus | old focus view | |
| reverse | search order |
Reimplemented from CViewContainer.
| void onViewRemoved | ( | CView * | pView | ) | [virtual] |
| pView | view which was removed |
| bool setDropActive | ( | bool | val | ) | [virtual] |
| virtual bool isDropActive | ( | ) | const [inline, virtual] |
| CDrawContext * createDrawContext | ( | ) |
| virtual void setOpenFlag | ( | bool | val | ) | [inline, virtual] |
| virtual bool getOpenFlag | ( | ) | const [inline, virtual] |
| void invalidate | ( | const CRect & | rect | ) | [virtual] |
scroll src rect by distance
| src | rect which to scroll | |
| distance | point of distance |
| void invalid | ( | ) | [inline, virtual] |
mark whole view as invalid
Reimplemented from CViewContainer.
| void invalidRect | ( | const CRect | rect | ) | [virtual] |
| void * getSystemWindow | ( | ) | const |
get platform window
| bool removeView | ( | CView * | pView, | |
| const bool & | withForget = true | |||
| ) | [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.
| bool removeAll | ( | const bool & | withForget = true |
) | [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.
| void draw | ( | CDrawContext * | pContext | ) | [virtual] |
| pContext | the context which to use to draw this container and its subviews |
Reimplemented from CViewContainer.
| void drawRect | ( | CDrawContext * | pContext, | |
| const CRect & | updateRect | |||
| ) | [virtual] |
| pContext | the context which to use to draw | |
| updateRect | the area which to draw |
Reimplemented from CViewContainer.
| CMouseEventResult onMouseDown | ( | CPoint & | where, | |
| const long & | buttons | |||
| ) | [virtual] |
called when a mouse down event occurs
| where | mouse location of mouse down | |
| buttons | button and modifier state |
Reimplemented from CViewContainer.
| CMouseEventResult onMouseUp | ( | CPoint & | where, | |
| const long & | buttons | |||
| ) | [virtual] |
called when a mouse up event occurs
| where | mouse location of mouse up | |
| buttons | button and modifier state |
Reimplemented from CViewContainer.
| CMouseEventResult onMouseMoved | ( | CPoint & | where, | |
| const long & | buttons | |||
| ) | [virtual] |
called when a mouse move event occurs
| where | mouse location of mouse move | |
| buttons | button and modifier state |
Reimplemented from CViewContainer.
| CMouseEventResult onMouseExited | ( | CPoint & | where, | |
| const long & | buttons | |||
| ) | [virtual] |
called when the mouse leaves this view
Reimplemented from CView.
| bool onWheel | ( | const CPoint & | where, | |
| const float & | distance, | |||
| const long & | buttons | |||
| ) | [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.
| bool onWheel | ( | const CPoint & | where, | |
| const CMouseWheelAxis & | axis, | |||
| const float & | distance, | |||
| const long & | buttons | |||
| ) | [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.
| long onKeyDown | ( | VstKeyCode & | keyCode | ) | [virtual] |
called if a key down event occurs and this view has focus
| keyCode | key code of pressed key |
Reimplemented from CViewContainer.
| long onKeyUp | ( | VstKeyCode & | keyCode | ) | [virtual] |
called if a key up event occurs and this view has focus
| keyCode | key code of pressed key |
Reimplemented from CViewContainer.
| void setViewSize | ( | CRect & | rect, | |
| bool | invalid = true | |||
| ) | [virtual] |
| rect | the new size of the container | |
| invalid | the views to dirty |
Reimplemented from CViewContainer.
| virtual VSTGUIEditorInterface* getEditor | ( | ) | const [inline, virtual] |
get editor
Reimplemented from CView.
| virtual IMouseObserver* getMouseObserver | ( | ) | const [inline, virtual] |
| virtual void setMouseObserver | ( | IMouseObserver * | observer | ) | [inline, virtual] |
| VSTGUI_DEPRECATED | ( | virtual CView *getCurrentView() const ; | ) | [pure virtual] |
<
| bool initFrame | ( | void * | pSystemWin | ) | [protected] |
<
| bool addView | ( | CView * | pView | ) | [virtual, inherited] |
add a child view
| pView | the view object to add to this container |
Reimplemented in CScrollView.
| bool addView | ( | CView * | pView, | |
| CRect & | mouseableArea, | |||
| bool | mouseEnabled = true | |||
| ) | [virtual, inherited] |
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 |
| bool isChild | ( | CView * | pView | ) | const [virtual, inherited] |
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.
| long getNbViews | ( | ) | const [virtual, inherited] |
| CView * getView | ( | long | index | ) | const [virtual, inherited] |
get the child view at index
| index | the index of the view to return |
Reimplemented in CScrollView.
get the view at point where
| virtual CViewContainer* getContainerAt | ( | const CPoint & | where, | |
| bool | deep = true | |||
| ) | const [virtual, inherited] |
get the container at point where
| void setBackgroundColor | ( | const CColor | color | ) | [virtual, inherited] |
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 |
| virtual CColor getBackgroundColor | ( | ) | const [inline, virtual, inherited] |
get the background color
| virtual void setBackgroundOffset | ( | const CPoint & | p | ) | [inline, virtual, inherited] |
set the offset of the background bitmap
| virtual const CPoint& getBackgroundOffset | ( | ) | const [inline, virtual, inherited] |
get the offset of the background bitmap
| void drawBackgroundRect | ( | CDrawContext * | pContext, | |
| CRect & | _updateRect | |||
| ) | [virtual, inherited] |
draw the background
| pContext | the context which to use to draw the background | |
| _updateRect | the area which to draw |
Reimplemented in CScrollView.
| virtual void useOffscreen | ( | bool | b | ) | [virtual, inherited] |
turn on/off using an offscreen. Not necessary with GDI+ on Windows, or on Mac OS X.
| void modifyDrawContext | ( | CCoord | save[4], | |
| CDrawContext * | pContext | |||
| ) | [inherited] |
| void restoreDrawContext | ( | CDrawContext * | pContext, | |
| CCoord | save[4] | |||
| ) | [inherited] |
| bool hitTest | ( | const CPoint & | where, | |
| const long | buttons = -1 | |||
| ) | [virtual, inherited] |
| where | point | |
| buttons | mouse button and modifier state |
Reimplemented from CView.
| CMessageResult notify | ( | CBaseObject * | sender, | |
| const char * | message | |||
| ) | [virtual, inherited] |
| sender | message sender | |
| message | message text |
Reimplemented from CView.
Reimplemented in CDataBrowser.
| bool onDrop | ( | CDragContainer * | drag, | |
| const CPoint & | where | |||
| ) | [virtual, inherited] |
called if a drag is dropped onto this view
Reimplemented from CView.
| void onDragEnter | ( | CDragContainer * | drag, | |
| const CPoint & | where | |||
| ) | [virtual, inherited] |
called if a drag is entering this view
Reimplemented from CView.
| void onDragLeave | ( | CDragContainer * | drag, | |
| const CPoint & | where | |||
| ) | [virtual, inherited] |
called if a drag is leaving this view
Reimplemented from CView.
| void onDragMove | ( | CDragContainer * | drag, | |
| const CPoint & | where | |||
| ) | [virtual, inherited] |
called if a drag is moved inside this view
Reimplemented from CView.
| void looseFocus | ( | ) | [virtual, inherited] |
called if view should loose focus
Reimplemented from CView.
| void takeFocus | ( | ) | [virtual, inherited] |
called if view should take focus
Reimplemented from CView.
| virtual bool isDirty | ( | ) | const [virtual, inherited] |
check if view is dirty
Reimplemented from CView.
| bool invalidateDirtyViews | ( | ) | [virtual, inherited] |
| void parentSizeChanged | ( | ) | [virtual, inherited] |
notification that one of the views parent has changed its size
Reimplemented from CView.
| rect | size to get visible size of |
| CRect getVisibleSize | ( | ) | const [virtual, inherited] |
returns the visible size of the view
| virtual bool removed | ( | CView * | parent | ) | [virtual, inherited] |
view is removed from parent view
| parent | parent view |
Reimplemented from CView.
| virtual bool attached | ( | CView * | parent | ) | [virtual, inherited] |
view is attached to a parent view
| parent | parent view |
Reimplemented from CView.
Reimplemented in CDataBrowser.
conversion from frame coordinates to local view coordinates
| point | location |
Reimplemented from CView.
conversion from local view coordinates to frame coordinates
| point | location |
Reimplemented from CView.
| VSTGUI_DEPRECATED | ( | virtual void mouse(CDrawContext *pContext, CPoint &where, long buttons=-1); | ) | const [inherited] |
| VSTGUI_DEPRECATED | ( | virtual void mouse(CDrawContext *pContext, CPoint &where, long buttons=-1); | ) | [inherited] |
| VSTGUI_DEPRECATED | ( | ) | [inline, inherited] |
<
<
check if view needs to be updated for rect
| view | view to check | |
| rect | update rect |
| bool hitTestSubViews | ( | const CPoint & | where, | |
| const long | buttons = -1 | |||
| ) | [protected, virtual, inherited] |
| where | point | |
| buttons | mouse button and modifier state |
| void drawBackToFront | ( | CDrawContext * | context, | |
| const CRect & | rect | |||
| ) | [protected, inherited] |
| virtual bool checkUpdate | ( | const CRect & | updateRect | ) | const [inline, virtual, inherited] |
| virtual void setDirty | ( | const bool | val = true |
) | [inline, virtual, inherited] |
| void setVisible | ( | bool | state | ) | [virtual, inherited] |
set visibility state
| bool isVisible | ( | ) | const [inline, inherited] |
get visibility state
| virtual CMouseEventResult onMouseEntered | ( | CPoint & | where, | |
| const long & | buttons | |||
| ) | [inline, virtual, inherited] |
called when the mouse enters this view
| virtual void setMouseEnabled | ( | const bool | bEnable = true |
) | [inline, virtual, inherited] |
turn on/off mouse usage for this view
| virtual bool getMouseEnabled | ( | ) | const [inline, virtual, inherited] |
get the state of wheather this view uses the mouse or not
| virtual void setMouseableArea | ( | const CRect & | rect | ) | [inline, virtual, inherited] |
set the area in which the view reacts to the mouse
get the area in which the view reacts to the mouse
| virtual const CRect& getMouseableArea | ( | ) | const [inline, virtual, inherited] |
read only access to the mouseable area
| CCoord getHeight | ( | ) | const [inline, inherited] |
get the height of the view
| CCoord getWidth | ( | ) | const [inline, inherited] |
get the width of the view
returns the current view size
| virtual const CRect& getViewSize | ( | ) | const [inline, virtual, inherited] |
read only access to view size
| virtual void setAutosizeFlags | ( | long | flags | ) | [inline, virtual, inherited] |
set autosize flags
| virtual long getAutosizeFlags | ( | ) | const [inline, virtual, inherited] |
get autosize flags
| virtual bool wantsFocus | ( | ) | const [inline, virtual, inherited] |
check if view supports focus
| virtual void setWantsFocus | ( | bool | state | ) | [inline, virtual, inherited] |
set focus support on/off
| bool getAttributeSize | ( | const CViewAttributeID | id, | |
| long & | outSize | |||
| ) | const [inherited] |
get the size of an attribute
| id | the ID of the Attribute | |
| outSize | on return the size of the attribute |
| bool getAttribute | ( | const CViewAttributeID | id, | |
| const long | inSize, | |||
| void * | outData, | |||
| long & | outSize | |||
| ) | const [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 |
| bool setAttribute | ( | const CViewAttributeID | id, | |
| const long | inSize, | |||
| const void * | inData | |||
| ) | [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 |
| bool removeAttribute | ( | const CViewAttributeID | id | ) | [inherited] |
remove an attribute
| void setBackground | ( | CBitmap * | background | ) | [virtual, inherited] |
set the background image of this view
| background | new background bitmap |
| virtual CBitmap* getBackground | ( | ) | const [inline, virtual, inherited] |
get the background image of this view
| virtual void setTransparency | ( | bool | val | ) | [inline, virtual, inherited] |
set views transparent state
Reimplemented in CScrollView.
| virtual bool getTransparency | ( | ) | const [inline, virtual, inherited] |
get views transparent state
| bool isAttached | ( | ) | const [inline, inherited] |
is view attached to a parentView
| CView* getParentView | ( | ) | const [inline, inherited] |
get parent view
| CFrame* getFrame | ( | ) | const [inline, inherited] |
get frame
| virtual bool isTypeOf | ( | const char * | s | ) | const [inline, virtual, inherited] |
| virtual CView* newCopy | ( | ) | const [inline, virtual, inherited] |
| virtual void forget | ( | ) | [inline, virtual, inherited] |
decrease refcount and delete object if refcount == 0
Reimplemented in CDrawContext.
| virtual void remember | ( | ) | [inline, virtual, inherited] |
increase refcount
| long getNbReference | ( | ) | const [inline, inherited] |
get refcount
VSTGUIEditorInterface* pEditor [protected] |
IMouseObserver* pMouseObserver [protected] |
void* pSystemWindow [protected] |
CView* pModalView [protected] |
CView* pFocusView [protected] |
CView* pMouseOverView [protected] |
bool bFirstDraw [protected] |
bool bOpenFlag [protected] |
bool bDropActive [protected] |
CCView* pFirstView [protected, inherited] |
CCView* pLastView [protected, inherited] |
COffscreenContext* pOffscreenContext [protected, inherited] |
CColor backgroundColor [protected, inherited] |
CPoint backgroundOffset [protected, inherited] |
bool bDrawInOffscreen [protected, inherited] |
CView* currentDragView [protected, inherited] |
CView* mouseDownView [protected, inherited] |
VSTGUI_DEPRECATED (virtual void getFrameTopLeftPos (CPoint& topLeft) const;) protected CRect mouseableArea [inherited] |
CFrame* pParentFrame [inherited] |
CView* pParentView [inherited] |
bool bDirty [inherited] |
bool bMouseEnabled [inherited] |
bool bTransparencyEnabled [inherited] |
bool bWantsFocus [inherited] |
bool bIsAttached [inherited] |
bool bVisible [inherited] |
long autosizeFlags [inherited] |
CBitmap* pBackground [inherited] |
CAttributeListEntry* pAttributeList [inherited] |
1.6.3