VSTGUI  3.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CFrame Class Reference

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 VSTGUIEditorInterfacegetEditor () const
 get editor More...
 
virtual IMouseObservergetMouseObserver () const
 
virtual void setMouseObserver (IMouseObserver *observer)
 
virtual bool isTypeOf (const char *s) const
 
virtual CViewnewCopy () const
 
virtual bool getCurrentLocation (CPoint &where)
 
virtual void mouse (CDrawContext *pContext, CPoint &where, long buttons=-1)
 
virtual CViewgetCurrentView () 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 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 setBackground (CBitmap *background)
 set the background image of this view More...
 
virtual CBitmapgetBackground () 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

VSTGUIEditorInterfacepEditor
 
IMouseObserverpMouseObserver
 
void * pSystemWindow
 
CViewpModalView
 
CViewpFocusView
 
CViewpMouseOverView
 
bool bFirstDraw
 
bool bOpenFlag
 
bool bDropActive
 
CCView * pFirstView
 
CCView * pLastView
 
COffscreenContextpOffscreenContext
 
CColor backgroundColor
 
CPoint backgroundOffset
 
bool bDrawInOffscreen
 
CViewcurrentDragView
 
CViewmouseDownView
 
CRect size
 
CRect mouseableArea
 
CFramepParentFrame
 
CViewpParentView
 
bool bDirty
 
bool bMouseEnabled
 
bool bTransparencyEnabled
 
bool bWantsFocus
 
bool bIsAttached
 
bool bVisible
 
long autosizeFlags
 
CBitmappBackground
 
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 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...
 

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 CRectgetViewSize (CRect &rect) const
 returns the current view size More...
 
virtual const CRectgetViewSize () 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

CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () 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 CViewgetView (long index) const
 get the child view at index More...
 
virtual CViewgetViewAt (const CPoint &where, bool deep=false) const
 get the view at point where More...
 
virtual CViewContainergetContainerAt (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 CPointgetBackgroundOffset () 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 CViewgetModalView () 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 CViewgetFocusView () const
 
virtual bool advanceNextFocusView (CView *oldFocus, bool reverse=false)
 
virtual void onViewRemoved (CView *pView)
 
virtual bool setDropActive (bool val)
 
virtual bool isDropActive () const
 
CDrawContextcreateDrawContext ()
 
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...
 

Detailed Description

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.

Constructor & Destructor Documentation

CFrame ( const CRect inSize,
void *  inSystemWindow,
VSTGUIEditorInterface inEditor 
)
Parameters
inSizesize of frame
inSystemWindowparent platform window
inEditoreditor
~CFrame ( )
virtual

Member Function Documentation

bool addView ( CView pView)
virtualinherited

add a child view

Parameters
pViewthe view object to add to this container
Returns
true on success. false if view was already attached

Reimplemented in CScrollView.

bool addView ( CView pView,
CRect mouseableArea,
bool  mouseEnabled = true 
)
virtualinherited

add a child view

Parameters
pViewthe view object to add to this container
mouseableAreathe view area in where the view will get mouse events
mouseEnabledbool to set if view will get mouse events
Returns
true on success. false if view was already attached

Reimplemented in CScrollView.

bool addView ( CView pView,
CView pBefore 
)
virtualinherited

add a child view before another view

Parameters
pViewthe view object to add to this container
pBeforethe view object
Returns
true on success. false if view was already attached
bool advanceNextFocusView ( CView oldFocus,
bool  reverse = false 
)
virtual
Parameters
oldFocusold focus view
reversesearch order
Returns
true on success

Reimplemented from CViewContainer.

bool attached ( CView parent)
virtualinherited

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

Reimplemented from CView.

Reimplemented in CDataBrowser.

void beginEdit ( long  index)
virtual
virtual bool checkUpdate ( const CRect updateRect) const
inlinevirtualinherited
bool checkUpdateRect ( CView view,
const CRect rect 
)
protectedvirtualinherited

check if view needs to be updated for rect

Parameters
viewview to check
rectupdate rect
Returns
true if view needs update
CDrawContext * createDrawContext ( )
void doIdleStuff ( )
virtual
void draw ( CDrawContext pContext)
virtual
Parameters
pContextthe context which to use to draw this container and its subviews

Reimplemented from CViewContainer.

void draw ( CView pView = 0)
Deprecated:
use pView->invalid () instead
void drawBackgroundRect ( CDrawContext pContext,
CRect _updateRect 
)
virtualinherited

draw the background

Parameters
pContextthe context which to use to draw the background
_updateRectthe area which to draw

Reimplemented in CScrollView.

void drawBackToFront ( CDrawContext context,
const CRect rect 
)
protectedinherited
void drawRect ( CDrawContext pContext,
const CRect updateRect 
)
virtual
Parameters
pContextthe context which to use to draw
updateRectthe area which to draw

Reimplemented from CViewContainer.

void endEdit ( long  index)
virtual
virtual void forget ( )
inlinevirtualinherited

decrease refcount and delete object if refcount == 0

Reimplemented in CDrawContext.

CPoint & frameToLocal ( CPoint point) const
virtualinherited

conversion from frame coordinates to local view coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented from CView.

bool getAttribute ( const CViewAttributeID  id,
const long  inSize,
void *  outData,
long &  outSize 
) const
inherited

get an attribute

Parameters
idthe 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.
bool getAttributeSize ( const CViewAttributeID  id,
long &  outSize 
) const
inherited

get the size of an attribute

Parameters
idthe ID of the Attribute
outSizeon return the size of the attribute
Returns
true if attribute exists. outSize is valid then.
virtual long getAutosizeFlags ( ) const
inlinevirtualinherited

get autosize flags

virtual CBitmap* getBackground ( ) const
inlinevirtualinherited

get the background image of this view

virtual CColor getBackgroundColor ( ) const
inlinevirtualinherited

get the background color

virtual const CPoint& getBackgroundOffset ( ) const
inlinevirtualinherited

get the offset of the background bitmap

CViewContainer * getContainerAt ( const CPoint p,
bool  deep = true 
) const
virtualinherited

get the container at point where

Parameters
plocation
deepsearch deep
Returns
view container at position p
bool getCurrentLocation ( CPoint where)
virtual
long getCurrentMouseButtons ( ) const
virtual

get current mouse buttons and key modifiers

Returns
mouse and modifier state
bool getCurrentMouseLocation ( CPoint where) const
virtual

get current mouse location

Parameters
wherelocation of mouse
Returns
true on success
CView * getCurrentView ( ) const
virtual
Deprecated:

Reimplemented from CViewContainer.

virtual VSTGUIEditorInterface* getEditor ( ) const
inlinevirtual

get editor

Reimplemented from CView.

virtual CView* getFocusView ( ) const
inlinevirtual
CFrame* getFrame ( ) const
inlineinherited

get frame

void getFrameTopLeftPos ( CPoint topLeft) const
virtualinherited
CCoord getHeight ( ) const
inlineinherited

get the height of the view

long getKnobMode ( ) const
virtual

get hosts knob mode

virtual CView* getModalView ( ) const
inlinevirtual
virtual CRect& getMouseableArea ( CRect rect) const
inlinevirtualinherited

get the area in which the view reacts to the mouse

virtual const CRect& getMouseableArea ( ) const
inlinevirtualinherited

read only access to the mouseable area

virtual bool getMouseEnabled ( ) const
inlinevirtualinherited

get the state of wheather this view uses the mouse or not

void getMouseLocation ( CDrawContext context,
CPoint point 
)
virtualinherited
virtual IMouseObserver* getMouseObserver ( ) const
inlinevirtual
long getNbReference ( ) const
inlineinherited

get refcount

long getNbViews ( ) const
virtualinherited

get the number of child views

Returns
number of subviews

Reimplemented in CScrollView.

virtual bool getOpenFlag ( ) const
inlinevirtual
CView* getParentView ( ) const
inlineinherited

get parent view

bool getPosition ( CCoord x,
CCoord y 
) const
virtual

get global position of frame

Parameters
xx coordinate
yy coordinate
Returns
true on success
bool getSize ( CRect pRect) const
virtual

get size relative to parent

Parameters
pRectsize
Returns
true on success
bool getSize ( CRect pSize) const
virtual
void * getSystemWindow ( ) const

get platform window

unsigned long getTicks ( ) const
virtual

get the current time (in ms)

Returns
tick count in milliseconds
virtual bool getTransparency ( ) const
inlinevirtualinherited

get views transparent state

CView * getView ( long  index) const
virtualinherited

get the child view at index

Parameters
indexthe index of the view to return
Returns
view at index. NULL if view at index does not exist.

Reimplemented in CScrollView.

CView * getViewAt ( const CPoint p,
bool  deep = false 
) const
virtualinherited

get the view at point where

Parameters
plocation
deepsearch deep
Returns
view at position p
virtual CRect& getViewSize ( CRect rect) const
inlinevirtualinherited

returns the current view size

virtual const CRect& getViewSize ( ) const
inlinevirtualinherited

read only access to view size

CRect getVisibleSize ( ) const
virtualinherited

returns the visible size of the view

Returns
visible size of view
CRect getVisibleSize ( const CRect  rect) const
virtualinherited
Parameters
rectsize to get visible size of
Returns
visible size of rect
CCoord getWidth ( ) const
inlineinherited

get the width of the view

bool hitTest ( const CPoint where,
const long  buttons = -1 
)
virtualinherited
Parameters
wherepoint
buttonsmouse button and modifier state
Returns
true if container accepts the hit

Reimplemented from CView.

bool hitTestSubViews ( const CPoint where,
const long  buttons = -1 
)
protectedvirtualinherited
Parameters
wherepoint
buttonsmouse button and modifier state
Returns
true if any sub view accepts the hit
void idle ( )
virtual
bool initFrame ( void *  pSystemWin)
protected
void invalid ( )
inlinevirtual

mark whole view as invalid

Reimplemented from CViewContainer.

void invalidate ( const CRect rect)
virtual
bool invalidateDirtyViews ( )
virtualinherited
void invalidRect ( const CRect  rect)
virtual

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented from CViewContainer.

bool isAttached ( ) const
inlineinherited

is view attached to a parentView

bool isChild ( CView pView) const
virtualinherited

check if pView is a child view of this container

Parameters
pViewthe view which should be checked if it is a child of this container
Returns
true on success

Reimplemented in CScrollView.

bool isDirty ( ) const
virtualinherited

check if view is dirty

Reimplemented from CView.

virtual bool isDropActive ( ) const
inlinevirtual
virtual bool isOpen ( ) const
inlinevirtual
virtual bool isTypeOf ( const char *  s) const
inlinevirtual

Reimplemented from CViewContainer.

bool isVisible ( ) const
inlineinherited

get visibility state

CPoint & localToFrame ( CPoint point) const
virtualinherited

conversion from local view coordinates to frame coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented from CView.

void looseFocus ( )
virtualinherited

called if view should loose focus

Reimplemented from CView.

void modifyDrawContext ( CCoord  save[4],
CDrawContext pContext 
)
inherited
void mouse ( CDrawContext pContext,
CPoint where,
long  buttons = -1 
)
virtual
Deprecated:
use the new mouse methods

Reimplemented from CViewContainer.

virtual CView* newCopy ( ) const
inlinevirtual

Reimplemented from CViewContainer.

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

Reimplemented from CView.

Reimplemented in CDataBrowser.

void onDragEnter ( CDragContainer drag,
const CPoint where 
)
virtualinherited

called if a drag is entering this view

Reimplemented from CView.

void onDragLeave ( CDragContainer drag,
const CPoint where 
)
virtualinherited

called if a drag is leaving this view

Reimplemented from CView.

void onDragMove ( CDragContainer drag,
const CPoint where 
)
virtualinherited

called if a drag is moved inside this view

Reimplemented from CView.

bool onDrop ( CDragContainer drag,
const CPoint where 
)
virtualinherited

called if a drag is dropped onto this view

Reimplemented from CView.

long onKeyDown ( VstKeyCode keyCode)
virtual

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 from CViewContainer.

long onKeyUp ( VstKeyCode keyCode)
virtual

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 from CViewContainer.

CMouseEventResult onMouseDown ( CPoint where,
const long &  buttons 
)
virtual

called when a mouse down event occurs

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

Reimplemented from CViewContainer.

virtual CMouseEventResult onMouseEntered ( CPoint where,
const long &  buttons 
)
inlinevirtualinherited

called when the mouse enters this view

CMouseEventResult onMouseExited ( CPoint where,
const long &  buttons 
)
virtual

called when the mouse leaves this view

Reimplemented from CView.

CMouseEventResult onMouseMoved ( CPoint where,
const long &  buttons 
)
virtual

called when a mouse move event occurs

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

Reimplemented from CViewContainer.

CMouseEventResult onMouseUp ( CPoint where,
const long &  buttons 
)
virtual

called when a mouse up event occurs

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

Reimplemented from CViewContainer.

void onViewRemoved ( CView pView)
virtual
Parameters
pViewview which was removed
bool onWheel ( const CPoint where,
const float &  distance,
const long &  buttons 
)
virtual

called if a mouse wheel event is happening over this view

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

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

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

Reimplemented from CViewContainer.

void parentSizeChanged ( )
virtualinherited

notification that one of the views parent has changed its size

Reimplemented from CView.

virtual void remember ( )
inlinevirtualinherited

increase refcount

bool removeAll ( const bool &  withForget = true)
virtual

remove all child views

Parameters
withForgetbool to indicate if the view's reference counter should be decreased after removed from the container
Returns
true on success

Reimplemented from CViewContainer.

bool removeAttribute ( const CViewAttributeID  id)
inherited

remove an attribute

bool removed ( CView parent)
virtualinherited

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented from CView.

bool removeView ( CView pView,
const bool &  withForget = true 
)
virtual

remove a child view

Parameters
pViewthe view which should be removed from the container
withForgetbool to indicate if the view's reference counter should be decreased after removed from the container
Returns
true on success

Reimplemented from CViewContainer.

void restoreDrawContext ( CDrawContext pContext,
CCoord  save[4] 
)
inherited
void scrollRect ( const CRect src,
const CPoint distance 
)

scroll src rect by distance

Parameters
srcrect which to scroll
distancepoint of distance
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.

Parameters
idthe ID of the Attribute
inSizethe size of the outData pointer
inDataa pointer to the data
Returns
true if attribute was set
virtual void setAutosizeFlags ( long  flags)
inlinevirtualinherited

set autosize flags

void setBackground ( CBitmap background)
virtualinherited

set the background image of this view

Parameters
backgroundnew background bitmap
void setBackgroundColor ( const CColor  color)
virtualinherited

set the background color (will only be drawn if this container is not set to transparent and does not have a background bitmap)

Parameters
colorthe new background color of the container
virtual void setBackgroundOffset ( const CPoint p)
inlinevirtualinherited

set the offset of the background bitmap

void setCursor ( CCursorType  type)
virtual

set mouse cursor

Parameters
typecursor type see CCursorType
virtual void setDirty ( const bool  val = true)
inlinevirtualinherited

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

Reimplemented in CVuMeter, and CControl.

bool setDropActive ( bool  val)
virtual
void setFocusView ( CView pView)
virtual
Parameters
pViewnew focus view
virtual void setFrame ( CFrame pParent)
inlinevirtualinherited
bool setModalView ( CView pView)
virtual
Parameters
pViewthe view which should be set to modal.
Returns
true if view could be set as the modal view. false if there is a already a modal view or the view to be set as modal is already attached.
virtual void setMouseableArea ( const CRect rect)
inlinevirtualinherited

set the area in which the view reacts to the mouse

virtual void setMouseEnabled ( const bool  bEnable = true)
inlinevirtualinherited

turn on/off mouse usage for this view

virtual void setMouseObserver ( IMouseObserver observer)
inlinevirtual
virtual void setOpenFlag ( bool  val)
inlinevirtual
virtual void setParentView ( CView pParentView)
inlinevirtualinherited
bool setPosition ( CCoord  x,
CCoord  y 
)
virtual

repositions the frame

Parameters
xx coordinate
yy coordinate
Returns
true on success
bool setSize ( CCoord  width,
CCoord  height 
)
virtual

set size of frame (and the platform representation)

Parameters
widthnew width
heightnew height
Returns
true on success
virtual void setTransparency ( bool  val)
inlinevirtualinherited

set views transparent state

Reimplemented in CScrollView.

void setViewSize ( CRect rect,
bool  invalid = true 
)
virtual
Parameters
rectthe new size of the container
invalidthe views to dirty

Reimplemented from CViewContainer.

void setVisible ( bool  state)
virtualinherited

set visibility state

virtual void setWantsFocus ( bool  state)
inlinevirtualinherited

set focus support on/off

void takeFocus ( )
virtualinherited

called if view should take focus

Reimplemented from CView.

void useOffscreen ( bool  b)
virtualinherited

turn on/off using an offscreen. Not necessary with GDI+ on Windows, or on Mac OS X.

virtual bool wantsFocus ( ) const
inlinevirtualinherited

check if view supports focus

Member Data Documentation

long autosizeFlags
protectedinherited
CColor backgroundColor
protectedinherited
CPoint backgroundOffset
protectedinherited
bool bDirty
protectedinherited
bool bDrawInOffscreen
protectedinherited
bool bDropActive
protected
bool bFirstDraw
protected
bool bIsAttached
protectedinherited
bool bMouseEnabled
protectedinherited
bool bOpenFlag
protected
bool bTransparencyEnabled
protectedinherited
bool bVisible
protectedinherited
bool bWantsFocus
protectedinherited
CView* currentDragView
protectedinherited
CRect mouseableArea
protectedinherited
CView* mouseDownView
protectedinherited
CAttributeListEntry* pAttributeList
protectedinherited
CBitmap* pBackground
protectedinherited
VSTGUIEditorInterface* pEditor
protected
CCView* pFirstView
protectedinherited
CView* pFocusView
protected
CCView* pLastView
protectedinherited
CView* pModalView
protected
IMouseObserver* pMouseObserver
protected
CView* pMouseOverView
protected
COffscreenContext* pOffscreenContext
protectedinherited
CFrame* pParentFrame
protectedinherited
CView* pParentView
protectedinherited
void* pSystemWindow
protected
CRect size
protectedinherited

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