CTabView Class Reference
[Container Views]

a tab view More...

#include <ctabview.h>

Inheritance diagram for CTabView:
Inheritance graph
[legend]

List of all members.

Public Types

enum  TabPosition { kPositionLeft = 0, kPositionRight, kPositionTop, kPositionBottom }
enum  TabAlignment {
  kAlignCenter = 0, kAlignLeft, kAlignRight, kAlignTop = kAlignLeft,
  kAlignBottom = kAlignRight
}

Public Member Functions

virtual ~CTabView ()
virtual void valueChanged (CControl *pControl)
virtual void setViewSize (CRect &rect, bool invalid=true)
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 advanceNextFocusView (CView *oldFocus, bool reverse=false)
virtual void draw (CDrawContext *pContext)
virtual void drawRect (CDrawContext *pContext, const CRect &updateRect)
virtual CMouseEventResult onMouseDown (CPoint &where, const long &buttons)
 called when a mouse down event occurs
virtual CMouseEventResult onMouseUp (CPoint &where, const long &buttons)
 called when a mouse up event occurs
virtual CMouseEventResult onMouseMoved (CPoint &where, const long &buttons)
 called when a mouse move event occurs
virtual bool onWheel (const CPoint &where, const float &distance, const long &buttons)
 called if a mouse wheel event is happening over this view
virtual bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const long &buttons)
 called if a mouse wheel event is happening over this view
virtual bool hitTest (const CPoint &where, const long buttons=-1)
virtual long onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus
virtual long onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus
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 void invalid ()
 mark whole view as invalid
virtual void invalidRect (const CRect rect)
 mark rect as invalid
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 bool isTypeOf (const char *s) const
virtual CViewnewCopy () const
virtual DEPRECATED_ATTRIBUTE void mouse (CDrawContext *pContext, CPoint &where, long buttons=-1)
virtual DEPRECATED_ATTRIBUTE
CView
getCurrentView () const
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
virtual void valueChanged (VSTGUI::CControl *pControl)=0
virtual long controlModifierClicked (VSTGUI::CControl *pControl, long button)
 return 1 if you want the control to not handle it, otherwise 0
virtual void controlBeginEdit (VSTGUI::CControl *pControl)
virtual void controlEndEdit (VSTGUI::CControl *pControl)

Protected Member Functions

void setCurrentChild (CTabChildView *childView)
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

long numberOfChilds
long currentTab
TabPosition tabPosition
long style
CRect tabSize
CBitmaptabBitmap
CTabChildView * firstChild
CTabChildView * lastChild
CTabChildView * currentChild
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

Tab View Constructors



 CTabView (const CRect &size, CFrame *parent, CBitmap *tabBitmap, CBitmap *background=0, TabPosition tabPosition=kPositionTop, long style=0)
 CTabView (const CRect &size, CFrame *parent, const CRect &tabSize, CBitmap *background=0, TabPosition tabPosition=kPositionTop, long style=0)

Tab View Functions



virtual bool addTab (CView *view, const char *name=0, CBitmap *tabBitmap=0)
 add a tab
virtual bool addTab (CView *view, CControl *button)
 add a tab
virtual bool removeTab (CView *view)
 remove a tab
virtual bool removeAllTabs ()
 remove all tabs
virtual bool selectTab (long index)
 select tab at index
virtual long getCurrentSelectedTab () const
 get current index of selected tab
virtual CRectgetTabViewSize (CRect &rect) const
 the the size of one tab
virtual void setTabFontStyle (const CFontRef font, CCoord fontSize=12, CColor selectedColor=kBlackCColor, CColor deselectedColor=kWhiteCColor)
 call this after the tabs are added. Tabs added after this call will have the default font style.
virtual void alignTabs (TabAlignment alignment=kAlignCenter)
 call this after you have added all tabs to align them according to alignment

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 removeView (CView *pView, const bool &withForget=true)
 remove a child view
virtual bool removeAll (const bool &withForget=true)
 remove all child views
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 CMouseEventResult onMouseExited (CPoint &where, const long &buttons)
 called when the mouse leaves 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
virtual VSTGUIEditorInterfacegetEditor () const
 get editor

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

a tab view


Member Enumeration Documentation

Enumerator:
kAlignCenter 
kAlignLeft 
kAlignRight 
kAlignTop 
kAlignBottom 
Enumerator:
kPositionLeft 
kPositionRight 
kPositionTop 
kPositionBottom 

Constructor & Destructor Documentation

CTabView ( const CRect size,
CFrame parent,
CBitmap tabBitmap,
CBitmap background = 0,
TabPosition  tabPosition = kPositionTop,
long  style = 0 
)
CTabView ( const CRect size,
CFrame parent,
const CRect tabSize,
CBitmap background = 0,
TabPosition  tabPosition = kPositionTop,
long  style = 0 
)
~CTabView (  )  [virtual]

Member Function Documentation

bool addTab ( CView view,
CControl button 
) [virtual]

add a tab

bool addTab ( CView view,
const char *  name = 0,
CBitmap tabBitmap = 0 
) [virtual]

add a tab

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, inherited]
Parameters:
oldFocus old focus view
reverse search order
Returns:
true on success

Reimplemented in CFrame.

void alignTabs ( TabAlignment  alignment = kAlignCenter  )  [virtual]

call this after you have added all tabs to align them according to alignment

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.

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
virtual void controlBeginEdit ( VSTGUI::CControl *  pControl  )  [inline, virtual, inherited]
virtual void controlEndEdit ( VSTGUI::CControl *  pControl  )  [inline, virtual, inherited]
virtual long controlModifierClicked ( VSTGUI::CControl *  pControl,
long  button 
) [inline, virtual, inherited]

return 1 if you want the control to not handle it, otherwise 0

void draw ( CDrawContext pContext  )  [virtual, inherited]
Parameters:
pContext the context which to use to draw this container and its subviews

Reimplemented from CView.

Reimplemented in CFrame.

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, inherited]
Parameters:
pContext the context which to use to draw
updateRect the area which to draw

Reimplemented from CView.

Reimplemented in CFrame.

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
virtual long getCurrentSelectedTab (  )  const [inline, virtual]

get current index of selected tab

CView * getCurrentView (  )  const [virtual, inherited]
Deprecated:

Reimplemented in CFrame.

VSTGUIEditorInterface * getEditor (  )  const [virtual, inherited]

get editor

Reimplemented in CFrame.

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

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]
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.

CView* getParentView (  )  const [inline, inherited]

get parent view

CRect & getTabViewSize ( CRect rect  )  const [virtual]

the the size of one tab

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 invalid (  )  [virtual, inherited]

mark whole view as invalid

Reimplemented from CView.

Reimplemented in CFrame.

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

mark rect as invalid

Parameters:
rect rect to invalidate

Reimplemented from CView.

Reimplemented in CFrame.

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 isTypeOf ( const char *  s  )  const [inline, virtual, inherited]

Reimplemented from CView.

Reimplemented in CFrame.

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, inherited]
Deprecated:
use the new mouse methods instead

Reimplemented from CView.

Reimplemented in CFrame.

virtual CView* newCopy (  )  const [inline, virtual, inherited]

Reimplemented from CView.

Reimplemented in CFrame.

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, inherited]

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 CView.

Reimplemented in CFrame.

long onKeyUp ( VstKeyCode keyCode  )  [virtual, inherited]

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 CView.

Reimplemented in CFrame.

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

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 CView.

Reimplemented in CFrame.

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

called when the mouse enters this view

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

called when the mouse leaves this view

Reimplemented in CFrame.

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

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 CView.

Reimplemented in CFrame.

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

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 CView.

Reimplemented in CFrame.

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

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 CView.

Reimplemented in CScrollView, and CFrame.

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

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 CView.

Reimplemented in CFrame.

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, inherited]

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 in CScrollView, and CFrame.

bool removeAllTabs (  )  [virtual]

remove all tabs

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 removeTab ( CView view  )  [virtual]

remove a tab

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

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 in CScrollView, and CFrame.

void restoreDrawContext ( CDrawContext pContext,
CCoord  save[4] 
) [inherited]
bool selectTab ( long  index  )  [virtual]

select tab at index

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 setCurrentChild ( CTabChildView *  childView  )  [protected]
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.

virtual DEPRECATED_ATTRIBUTE void setFrame ( CFrame pParent  )  [inline, virtual, inherited]
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 DEPRECATED_ATTRIBUTE void setParentView ( CView pParentView  )  [inline, virtual, inherited]
void setTabFontStyle ( const CFontRef  font,
CCoord  fontSize = 12,
CColor  selectedColor = kBlackCColor,
CColor  deselectedColor = kWhiteCColor 
) [virtual]

call this after the tabs are added. Tabs added after this call will have the default font style.

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 void valueChanged ( VSTGUI::CControl *  pControl  )  [pure virtual, inherited]
void valueChanged ( CControl pControl  )  [virtual]
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 bIsAttached [protected, inherited]
bool bMouseEnabled [protected, inherited]
bool bTransparencyEnabled [protected, inherited]
bool bVisible [protected, inherited]
bool bWantsFocus [protected, inherited]
CTabChildView* currentChild [protected]
CView* currentDragView [protected, inherited]
long currentTab [protected]
CTabChildView* firstChild [protected]
CTabChildView* lastChild [protected]
CRect mouseableArea [protected, inherited]
CView* mouseDownView [protected, inherited]
long numberOfChilds [protected]
CAttributeListEntry* pAttributeList [protected, inherited]
CBitmap* pBackground [protected, inherited]
CCView* pFirstView [protected, inherited]
CCView* pLastView [protected, inherited]
COffscreenContext* pOffscreenContext [protected, inherited]
CFrame* pParentFrame [protected, inherited]
CView* pParentView [protected, inherited]
CRect size [protected, inherited]
long style [protected]
CBitmap* tabBitmap [protected]
TabPosition tabPosition [protected]
CRect tabSize [protected]

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:41 2012 for VSTGUI by  doxygen 1.6.1