CDataBrowser Class Reference
[Controls]

DataBrowser view. More...

#include <cdatabrowser.h>

List of all members.

Public Types

enum  CDataBrowserStyle { kDrawRowLines = 1 << 4, kDrawColumnLines = 1 << 5, kDrawHeader = 1 << 6 }
enum  { kNoSelection = -1 }
enum  CScrollViewStyle { kHorizontalScrollbar = 1 << 1, kVerticalScrollbar = 1 << 2, kDontDrawFrame = 1 << 3 }

Public Member Functions

 ~CDataBrowser ()
bool addView (CView *pView)
 add a child view
bool addView (CView *pView, CRect &mouseableArea, bool mouseEnabled=true)
 add a child view
bool removeView (CView *pView, const bool &withForget=true)
 remove a child view
bool removeAll (const bool &withForget=true)
 remove all child views
bool isChild (CView *pView) const
 check if pView is a child view of this container
long getNbViews () const
 get the number of child views
CViewgetView (long index) const
 get the child view at index
void drawBackgroundRect (CDrawContext *pContext, CRect &_updateRect)
 draw the background
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 onWheel (const CPoint &where, const float &distance, const long &buttons)
 called if a mouse wheel event is happening over this view
virtual void valueChanged (VSTGUI::CControl *pControl)=0
void setTransparency (bool val)
 set views transparent state
void setBackgroundColor (const CColor &color)
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 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 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)
 view is removed from 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
 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 CBitmapgetBackground () const
 get the background image of this view
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 CViewnewCopy () const

Public Attributes

CPointpoint
VSTGUI_DEPRECATED(virtual void
getFrameTopLeftPos(CPoint
&topLeft) const ;) protected
CRect 
mouseableArea
 <
CFramepParentFrame
CViewpParentView
bool bDirty
bool bMouseEnabled
bool bTransparencyEnabled
bool bWantsFocus
bool bIsAttached
bool bVisible
long autosizeFlags
CBitmappBackground
CAttributeListEntry * pAttributeList

Protected Types

enum  { kHSBTag, kVSBTag }

Protected Member Functions

void valueChanged (CControl *pControl)
CMessageResult notify (CBaseObject *sender, const char *message)
bool attached (CView *parent)
 view is attached to a parent view
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

IDataBrowserdb
CDataBrowserView * dbView
CDataBrowserHeader * dbHeader
CViewContainerdbHeaderContainer
long selectedRow
CScrollContainer * sc
CScrollbarvsb
CScrollbarhsb
CRect containerSize
long style
CCView * pFirstView
CCView * pLastView
COffscreenContextpOffscreenContext
CColor backgroundColor
CPoint backgroundOffset
bool bDrawInOffscreen
CViewcurrentDragView
CViewmouseDownView

Constructor



 CDataBrowser (const CRect &size, CFrame *pParent, IDataBrowser *db, long style=0, CCoord scrollbarWidth=16, CBitmap *pBackground=0)

CDataBrowser Methods



virtual void recalculateLayout (bool rememberSelection=false)
 trigger recalculation, call if numRows or numColumns changed
virtual void invalidate (long row, long column)
 invalidates an individual cell
virtual void invalidateRow (long row)
 invalidates a complete row
virtual void makeRowVisible (long row)
 scrolls the scrollview so that row is visible
virtual CRect getCellBounds (long row, long column)
 get bounds of a cell
virtual long getSelectedRow () const
 get selected row
virtual void setSelectedRow (long row, bool makeVisible=false)
 set the exclusive selected row
virtual void beginTextEdit (long row, long column, const char *initialText)
 starts a text edit for a cell

CScrollView Methods



virtual void setContainerSize (const CRect &cs, bool keepVisibleArea=false)
 set the virtual size of this container
const CPointgetScrollOffset () const
 get scroll offset
CScrollbargetVerticalScrollbar () const
 get the vertical scrollbar
CScrollbargetHorizontalScrollbar () const
 get the horizontal scrollbar
virtual void makeRectVisible (const CRect &rect)
 set scrollview to show rect

Sub View Methods



virtual bool addView (CView *pView, CView *pBefore)
 add a child view before another view
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

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

DataBrowser view.


Member Enumeration Documentation

Enumerator:
kDrawRowLines 
kDrawColumnLines 
kDrawHeader 
anonymous enum
Enumerator:
kNoSelection 
enum CScrollViewStyle [inherited]
Enumerator:
kHorizontalScrollbar 

add a horizontal scrollbar

kVerticalScrollbar 

add a vertical scrollbar

kDontDrawFrame 

don't draw frame

anonymous enum [protected, inherited]
Enumerator:
kHSBTag 
kVSBTag 

Constructor & Destructor Documentation

CDataBrowser ( const CRect size,
CFrame pParent,
IDataBrowser db,
long  style = 0,
CCoord  scrollbarWidth = 16,
CBitmap pBackground = 0 
)
Parameters:
size size of data browser
pParent frame
db data browser interface. If db is inheritated from CBaseObject it will be remembered and released if data browser is destroyed
style data browser and scroll view style see CDataBrowserStyle and CScrollViewStyle
scrollbarWidth width of scrollbars
pBackground background bitmap
~CDataBrowser (  ) 

Member Function Documentation

void recalculateLayout ( bool  rememberSelection = false  )  [virtual]

trigger recalculation, call if numRows or numColumns changed

Parameters:
rememberSelection if true selection will be remembered
void invalidate ( long  row,
long  column 
) [virtual]

invalidates an individual cell

currently this will invalidate the whole row

Parameters:
row row to invalidate
column column to invalidate
void invalidateRow ( long  row  )  [virtual]

invalidates a complete row

Parameters:
row row to invalidate
void makeRowVisible ( long  row  )  [virtual]

scrolls the scrollview so that row is visible

Parameters:
row row to make visible
CRect getCellBounds ( long  row,
long  column 
) [virtual]

get bounds of a cell

Parameters:
row row number
column column number
Returns:
bounds of cell
virtual long getSelectedRow (  )  const [inline, virtual]

get selected row

void setSelectedRow ( long  index,
bool  makeVisible = false 
) [virtual]

set the exclusive selected row

Parameters:
index row to select
makeVisible if true makes row visible
void beginTextEdit ( long  row,
long  column,
const char *  initialText 
) [virtual]

starts a text edit for a cell

Parameters:
row row number
column column number
initialText UTF-8 string the text edit field will be initialized with
void valueChanged ( CControl pControl  )  [protected]

Reimplemented from CScrollView.

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

Reimplemented from CViewContainer.

bool attached ( CView parent  )  [protected, virtual]

view is attached to a parent view

Parameters:
parent parent view
Returns:
true if view successfully attached to parent

Reimplemented from CViewContainer.

void setContainerSize ( const CRect cs,
bool  keepVisibleArea = false 
) [virtual, inherited]

set the virtual size of this container

const CPoint & getScrollOffset (  )  const [inherited]

get scroll offset

CScrollbar* getVerticalScrollbar (  )  const [inline, inherited]

get the vertical scrollbar

CScrollbar* getHorizontalScrollbar (  )  const [inline, inherited]

get the horizontal scrollbar

void makeRectVisible ( const CRect rect  )  [virtual, inherited]

set scrollview to show rect

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

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

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

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

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

long getNbViews (  )  const [virtual, inherited]

get the number of child views

Returns:
number of subviews

Reimplemented from CViewContainer.

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

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

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.

virtual void valueChanged ( VSTGUI::CControl *  pControl  )  [pure virtual, inherited]
void setTransparency ( bool  val  )  [virtual, inherited]

set views transparent state

Reimplemented from CView.

void setBackgroundColor ( const CColor color  )  [inherited]
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
void setViewSize ( CRect rect,
bool  invalid = true 
) [virtual, inherited]
Parameters:
rect the new size of the container
invalid the views to dirty

Reimplemented from CViewContainer.

virtual CView* getViewAt ( const CPoint where,
bool  deep = false 
) const [virtual, inherited]

get the view at point where

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

get the container at point where

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

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 advanceNextFocusView ( CView oldFocus,
bool  reverse = false 
) [virtual, inherited]
Parameters:
oldFocus old focus view
reverse search order
Returns:
true on success

Reimplemented in CFrame.

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

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.

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.

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.

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.

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.

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.

void invalid (  )  [virtual, inherited]

mark whole view as invalid

Reimplemented from CView.

Reimplemented in CFrame.

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

mark rect as invalid

Parameters:
rect rect to invalidate

Reimplemented from CView.

Reimplemented in CFrame.

bool invalidateDirtyViews (  )  [virtual, inherited]
void parentSizeChanged (  )  [virtual, inherited]

notification that one of the views parent has changed its size

Reimplemented from CView.

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

returns the visible size of the view

Returns:
visible size of view
virtual bool removed ( CView parent  )  [virtual, inherited]

view is removed from parent view

Parameters:
parent parent view
Returns:
true if view successfully removed from parent

Reimplemented from CView.

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

conversion from frame coordinates to local view coordinates

Parameters:
point location
Returns:
converted point

Reimplemented from CView.

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

conversion from local view coordinates to frame coordinates

Parameters:
point location
Returns:
converted point

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]

<

Deprecated:
use VSTGUI::CFrame::getCurrentMouseLocation and process the point with VSTGUI::CView::frameToLocal
bool checkUpdateRect ( CView view,
const CRect rect 
) [protected, virtual, inherited]

<

Deprecated:

check if view needs to be updated for rect

Parameters:
view view to check
rect update rect
Returns:
true if view needs update
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 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]

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

Reimplemented in CControl, and CVuMeter.

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 CMouseEventResult onMouseExited ( CPoint where,
const long &  buttons 
) [inline, virtual, inherited]

called when the mouse leaves this view

Reimplemented in CFrame.

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

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

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

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

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

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

remove an attribute

void setBackground ( CBitmap background  )  [virtual, inherited]

set the background image of this view

Parameters:
background new background bitmap
virtual CBitmap* getBackground (  )  const [inline, virtual, inherited]

get the background image of this view

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

VSTGUIEditorInterface * getEditor (  )  const [virtual, inherited]

get editor

Reimplemented in CFrame.

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


Member Data Documentation

IDataBrowser* db [protected]
CDataBrowserView* dbView [protected]
CDataBrowserHeader* dbHeader [protected]
long selectedRow [protected]
CScrollContainer* sc [protected, inherited]
CScrollbar* vsb [protected, inherited]
CScrollbar* hsb [protected, inherited]
CRect containerSize [protected, inherited]
long style [protected, inherited]
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]
CPoint& point [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]

The documentation for this class was generated from the following files:
Generated on Fri Apr 9 10:19:32 2010 for VSTGUI by  doxygen 1.6.3