CFrame Class Reference
[Container Views]

The CFrame is the parent container of all views. More...

#include <vstgui.h>

Inheritance diagram for CFrame:
Inheritance graph
[legend]

List of all members.

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 VSTGUIEditorInterfacegetEditor () const
 get editor
virtual IMouseObservergetMouseObserver () const
virtual void setMouseObserver (IMouseObserver *observer)
virtual bool isTypeOf (const char *s) const
virtual CViewnewCopy () const
virtual DEPRECATED_ATTRIBUTE bool getCurrentLocation (CPoint &where)
virtual DEPRECATED_ATTRIBUTE void mouse (CDrawContext *pContext, CPoint &where, long buttons=-1)
virtual DEPRECATED_ATTRIBUTE
CView
getCurrentView () const
DEPRECATED_ATTRIBUTE 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)
virtual bool removed (CView *parent)
 view is removed from parent view
virtual bool attached (CView *parent)
virtual bool attached (CView *parent)
 view is attached to a parent view
virtual CPointframeToLocal (CPoint &point) const
 conversion from frame coordinates to local view coordinates
virtual CPointlocalToFrame (CPoint &point) const
 conversion from local view coordinates to frame coordinates
virtual void setBackground (CBitmap *background)
 set the background image of this view
virtual CBitmapgetBackground () 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 DEPRECATED_ATTRIBUTE void getMouseLocation (CDrawContext *context, CPoint &point)
virtual DEPRECATED_ATTRIBUTE void setParentView (CView *pParentView)
virtual DEPRECATED_ATTRIBUTE void setFrame (CFrame *pParent)
virtual DEPRECATED_ATTRIBUTE 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

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 CViewgetModalView () 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 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

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 CViewgetView (long index) const
 get the child view at index
virtual CViewgetViewAt (const CPoint &where, bool deep=false) const
 get the view at point where
virtual CViewContainergetContainerAt (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 CPointgetBackgroundOffset () const
 get the offset of the background bitmap
virtual void drawBackgroundRect (CDrawContext *pContext, CRect &_updateRect)
 draw the background

Message Methods



virtual CMessageResult notify (CBaseObject *sender, const char *message)

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 CRectgetViewSize (CRect &rect) const
 returns the current view size
virtual const CRectgetViewSize () 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 CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse
virtual const CRectgetMouseableArea () 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



CViewgetParentView () const
 get parent view
CFramegetFrame () 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

Detailed Description

The CFrame is the parent container of all views.


Constructor & Destructor Documentation

CFrame ( const CRect inSize,
void *  inSystemWindow,
VSTGUIEditorInterface inEditor 
)
Parameters:
inSize size of frame
inSystemWindow parent platform window
inEditor editor
~CFrame (  )  [virtual]

Member Function Documentation

bool addView ( CView pView,
CView pBefore 
) [virtual, inherited]

add a child view before another view

Parameters:
pView the view object to add to this container
pBefore the view object
Returns:
true on success. false if view was already attached
bool addView ( CView pView,
CRect mouseableArea,
bool  mouseEnabled = true 
) [virtual, inherited]

add a child view

Parameters:
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
Returns:
true on success. false if view was already attached

Reimplemented in CScrollView.

bool addView ( CView pView  )  [virtual, inherited]

add a child view

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

Reimplemented in CScrollView.

bool advanceNextFocusView ( CView oldFocus,
bool  reverse = false 
) [virtual]
Parameters:
oldFocus old focus view
reverse search order
Returns:
true on success

Reimplemented from CViewContainer.

bool attached ( CView parent  )  [virtual, inherited]

view is attached to a parent view

Parameters:
parent parent view
Returns:
true if view successfully attached to parent
bool attached ( CView parent  )  [virtual, inherited]

Reimplemented in CDataBrowser.

void beginEdit ( long  index  )  [virtual]
virtual bool checkUpdate ( const CRect updateRect  )  const [inline, virtual, inherited]
bool checkUpdateRect ( CView view,
const CRect rect 
) [protected, virtual, inherited]

check if view needs to be updated for rect

Parameters:
view view to check
rect update rect
Returns:
true if view needs update
CDrawContext * createDrawContext (  ) 
void doIdleStuff (  )  [virtual]
void draw ( CView pView = 0  ) 
Deprecated:
use pView->invalid () instead
void draw ( CDrawContext pContext  )  [virtual]
Parameters:
pContext the context which to use to draw this container and its subviews

Reimplemented from CViewContainer.

void drawBackgroundRect ( CDrawContext pContext,
CRect _updateRect 
) [virtual, inherited]

draw the background

Parameters:
pContext the context which to use to draw the background
_updateRect the area which to draw

Reimplemented in CScrollView.

void drawBackToFront ( CDrawContext context,
const CRect rect 
) [protected, inherited]
void drawRect ( CDrawContext pContext,
const CRect updateRect 
) [virtual]
Parameters:
pContext the context which to use to draw
updateRect the area which to draw

Reimplemented from CViewContainer.

void endEdit ( long  index  )  [virtual]
virtual void forget (  )  [inline, virtual, inherited]

decrease refcount and delete object if refcount == 0

Reimplemented in CDrawContext.

CPoint & frameToLocal ( CPoint point  )  const [virtual, inherited]

conversion from frame coordinates to local view coordinates

Parameters:
point location
Returns:
converted point

Reimplemented from CView.

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

get an attribute

Parameters:
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
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:
id the ID of the Attribute
outSize on return the size of the attribute
Returns:
true if attribute exists. outSize is valid then.
virtual long getAutosizeFlags (  )  const [inline, virtual, inherited]

get autosize flags

virtual CBitmap* getBackground (  )  const [inline, virtual, inherited]

get the background image of this view

virtual CColor getBackgroundColor (  )  const [inline, virtual, inherited]

get the background color

virtual const CPoint& getBackgroundOffset (  )  const [inline, virtual, inherited]

get the offset of the background bitmap

CViewContainer * getContainerAt ( const CPoint p,
bool  deep = true 
) const [virtual, inherited]

get the container at point where

Parameters:
p location
deep search 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:
where location of mouse
Returns:
true on success
CView * getCurrentView (  )  const [virtual]
Deprecated:

Reimplemented from CViewContainer.

virtual VSTGUIEditorInterface* getEditor (  )  const [inline, virtual]

get editor

Reimplemented from CView.

virtual CView* getFocusView (  )  const [inline, virtual]
CFrame* getFrame (  )  const [inline, inherited]

get frame

void getFrameTopLeftPos ( CPoint topLeft  )  const [virtual, inherited]
CCoord getHeight (  )  const [inline, inherited]

get the height of the view

long getKnobMode (  )  const [virtual]

get hosts knob mode

virtual CView* getModalView (  )  const [inline, virtual]
virtual const CRect& getMouseableArea (  )  const [inline, virtual, inherited]

read only access to the mouseable area

virtual CRect& getMouseableArea ( CRect rect  )  const [inline, virtual, inherited]

get the area in which the view reacts to the mouse

virtual bool getMouseEnabled (  )  const [inline, virtual, inherited]

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

void getMouseLocation ( CDrawContext context,
CPoint point 
) [virtual, inherited]
virtual IMouseObserver* getMouseObserver (  )  const [inline, virtual]
long getNbReference (  )  const [inline, inherited]

get refcount

long getNbViews (  )  const [virtual, inherited]

get the number of child views

Returns:
number of subviews

Reimplemented in CScrollView.

virtual bool getOpenFlag (  )  const [inline, virtual]
CView* getParentView (  )  const [inline, inherited]

get parent view

bool getPosition ( CCoord x,
CCoord y 
) const [virtual]

get global position of frame

Parameters:
x x coordinate
y y coordinate
Returns:
true on success
bool getSize ( CRect pSize  )  const [virtual]
bool getSize ( CRect pRect  )  const [virtual]

get size relative to parent

Parameters:
pRect size
Returns:
true on success
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 [inline, virtual, inherited]

get views transparent state

CView * getView ( long  index  )  const [virtual, inherited]

get the child view at index

Parameters:
index the 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 [virtual, inherited]

get the view at point where

Parameters:
p location
deep search deep
Returns:
view at position p
virtual const CRect& getViewSize (  )  const [inline, virtual, inherited]

read only access to view size

virtual CRect& getViewSize ( CRect rect  )  const [inline, virtual, inherited]

returns the current view size

CRect getVisibleSize (  )  const [virtual, inherited]

returns the visible size of the view

Returns:
visible size of view
CRect getVisibleSize ( const CRect  rect  )  const [virtual, inherited]
Parameters:
rect size to get visible size of
Returns:
visible size of rect
CCoord getWidth (  )  const [inline, inherited]

get the width of the view

bool hitTest ( const CPoint where,
const long  buttons = -1 
) [virtual, inherited]
Parameters:
where point
buttons mouse button and modifier state
Returns:
true if container accepts the hit

Reimplemented from CView.

bool hitTestSubViews ( const CPoint where,
const long  buttons = -1 
) [protected, virtual, inherited]
Parameters:
where point
buttons mouse button and modifier state
Returns:
true if any sub view accepts the hit
void idle (  )  [virtual]
bool initFrame ( void *  pSystemWin  )  [protected]
void invalid (  )  [inline, virtual]

mark whole view as invalid

Reimplemented from CViewContainer.

void invalidate ( const CRect rect  )  [virtual]
bool invalidateDirtyViews (  )  [virtual, inherited]
void invalidRect ( const CRect  rect  )  [virtual]

mark rect as invalid

Parameters:
rect rect to invalidate

Reimplemented from CViewContainer.

bool isAttached (  )  const [inline, inherited]

is view attached to a parentView

bool isChild ( CView pView  )  const [virtual, inherited]

check if pView is a child view of this container

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

Reimplemented in CScrollView.

bool isDirty (  )  const [virtual, inherited]

check if view is dirty

Reimplemented from CView.

virtual bool isDropActive (  )  const [inline, virtual]
virtual bool isOpen (  )  const [inline, virtual]
virtual bool isTypeOf ( const char *  s  )  const [inline, virtual]

Reimplemented from CViewContainer.

bool isVisible (  )  const [inline, inherited]

get visibility state

CPoint & localToFrame ( CPoint point  )  const [virtual, inherited]

conversion from local view coordinates to frame coordinates

Parameters:
point location
Returns:
converted point

Reimplemented from CView.

void looseFocus (  )  [virtual, inherited]

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 [inline, virtual]

Reimplemented from CViewContainer.

virtual CMessageResult notify ( CBaseObject sender,
const char *  message 
) [inline, virtual, inherited]
CMessageResult notify ( CBaseObject sender,
const char *  message 
) [virtual, inherited]
Parameters:
sender message sender
message message text
Returns:
message handled or not. See CMessageResult

Reimplemented from CView.

Reimplemented in CDataBrowser.

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.

bool onDrop ( CDragContainer drag,
const CPoint where 
) [virtual, inherited]

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:
keyCode key 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:
keyCode key 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:
where mouse location of mouse down
buttons button and modifier state
Returns:
event result. see CMouseEventResult

Reimplemented from CViewContainer.

virtual CMouseEventResult onMouseEntered ( CPoint where,
const long &  buttons 
) [inline, virtual, inherited]

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:
where mouse location of mouse move
buttons button 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:
where mouse location of mouse up
buttons button and modifier state
Returns:
event result. see CMouseEventResult

Reimplemented from CViewContainer.

void onViewRemoved ( CView pView  )  [virtual]
Parameters:
pView view which was removed
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:
where location
axis mouse wheel axis
distance wheel distance
buttons button and modifier state
Returns:
true if handled

Reimplemented from CViewContainer.

bool onWheel ( const CPoint where,
const float &  distance,
const long &  buttons 
) [virtual]

called if a mouse wheel event is happening over this view

Parameters:
where location
distance wheel distance
buttons button and modifier state
Returns:
true if handled

Reimplemented from CViewContainer.

void parentSizeChanged (  )  [virtual, inherited]

notification that one of the views parent has changed its size

Reimplemented from CView.

virtual void remember (  )  [inline, virtual, inherited]

increase refcount

bool removeAll ( const bool &  withForget = true  )  [virtual]

remove all child views

Parameters:
withForget bool 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  )  [virtual, inherited]

view is removed from parent view

Parameters:
parent parent view
Returns:
true if view successfully removed from parent
bool removed ( CView parent  )  [virtual, inherited]
bool removeView ( CView pView,
const bool &  withForget = true 
) [virtual]

remove a child view

Parameters:
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
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:
src rect which to scroll
distance point 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:
id the ID of the Attribute
inSize the size of the outData pointer
inData a pointer to the data
Returns:
true if attribute was set
virtual void setAutosizeFlags ( long  flags  )  [inline, virtual, inherited]

set autosize flags

void setBackground ( CBitmap background  )  [virtual, inherited]

set the background image of this view

Parameters:
background new background bitmap
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)

Parameters:
color the new background color of the container
virtual void setBackgroundOffset ( const CPoint p  )  [inline, virtual, inherited]

set the offset of the background bitmap

void setCursor ( CCursorType  type  )  [virtual]

set mouse cursor

Parameters:
type cursor type see CCursorType
virtual void setDirty ( const bool  val = true  )  [inline, virtual, inherited]

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

Reimplemented in CControl, and CVuMeter.

bool setDropActive ( bool  val  )  [virtual]
void setFocusView ( CView pView  )  [virtual]
Parameters:
pView new focus view
virtual DEPRECATED_ATTRIBUTE void setFrame ( CFrame pParent  )  [inline, virtual, inherited]
bool setModalView ( CView pView  )  [virtual]
Parameters:
pView the 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  )  [inline, virtual, inherited]

set the area in which the view reacts to the mouse

virtual void setMouseEnabled ( const bool  bEnable = true  )  [inline, virtual, inherited]

turn on/off mouse usage for this view

virtual void setMouseObserver ( IMouseObserver observer  )  [inline, virtual]
virtual void setOpenFlag ( bool  val  )  [inline, virtual]
virtual DEPRECATED_ATTRIBUTE void setParentView ( CView pParentView  )  [inline, virtual, inherited]
bool setPosition ( CCoord  x,
CCoord  y 
) [virtual]

repositions the frame

Parameters:
x x coordinate
y y coordinate
Returns:
true on success
bool setSize ( CCoord  width,
CCoord  height 
) [virtual]

set size of frame (and the platform representation)

Parameters:
width new width
height new height
Returns:
true on success
virtual void setTransparency ( bool  val  )  [inline, virtual, inherited]

set views transparent state

Reimplemented in CScrollView.

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

Reimplemented from CViewContainer.

void setVisible ( bool  state  )  [virtual, inherited]

set visibility state

virtual void setWantsFocus ( bool  state  )  [inline, virtual, inherited]

set focus support on/off

void takeFocus (  )  [virtual, inherited]

called if view should take focus

Reimplemented from CView.

void useOffscreen ( bool  b  )  [virtual, inherited]

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

virtual bool wantsFocus (  )  const [inline, virtual, inherited]

check if view supports focus


Member Data Documentation

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

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on Tue Sep 25 18:22:44 2012 for VSTGUI by  doxygen 1.6.1