COptionMenu Class Reference
[Controls]

a popup menu control More...

#include <vstcontrols.h>

List of all members.

Public Member Functions

virtual ~COptionMenu ()
virtual void setValue (float val)
virtual void draw (CDrawContext *pContext)
 called if the view should draw itself
virtual CMouseEventResult onMouseDown (CPoint &where, const long &buttons)
 called when a mouse down event occurs
virtual void takeFocus ()
 called if view should take focus
virtual void looseFocus ()
 called if view should loose focus
virtual void doIdleStuff ()
virtual void setBackOffset (CPoint &offset)
virtual void copyBackOffset ()
virtual void setWheelInc (float val)
virtual float getWheelInc () const
bool isDirty () const
 check if view is dirty
void setDirty (const bool val=true)
 set the view to dirty so that it is redrawn in the next idle. Thread Safe !
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
virtual bool removed (CView *parent)
 view is removed from parent view
virtual bool attached (CView *parent)
 view is attached to a parent view
bool isAttached () const
 is view attached to a parentView
virtual bool isTypeOf (const char *s) const
virtual CViewnewCopy () const
CMessageResult notify (CBaseObject *sender, const char *message)
 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)
 <

Public Attributes

VSTGUI_DEPRECATED(bool
isDoubleClick();) protected
long 
tag
float oldValue
float defaultValue
float value
float vmin
float vmax
float wheelInc
long lastTicks
long delta
CPoint backOffset
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 Member Functions

COptionMenugetItemMenu (long idx, long &idxInMenu, long &offsetIdx)
void removeItems ()
void * appendItems (long &offsetIdx)
virtual void drawText (CDrawContext *pContext, const char *string, CBitmap *newBack=0)

Protected Attributes

void * platformControl
CMenuItemList * menuItems
long currentIndex
CBitmapbgWhenClick
long lastButton
long nbItemsPerColumn
long lastResult
long prefixNumbers
COptionMenulastMenu
COptionMenuSchemescheme
void(* stringConvert )(float value, char *string)
void(* stringConvert2 )(float value, char *string, void *userData)
void(* string2FloatConvert )(char *string, float &output)
void * userData
CHoriTxtAlign horiTxtAlign
long style
CFontRef fontID
CColor fontColor
CColor backColor
CColor frameColor
CColor shadowColor
bool bTextTransparencyEnabled
bool bAntialias

Constructor



 COptionMenu (const CRect &size, CControlListener *listener, long tag, CBitmap *background=0, CBitmap *bgWhenClick=0, const long style=0)
 COptionMenu (const COptionMenu &menu)

COptionMenu Methods



virtual CMenuItemaddEntry (CMenuItem *item, long index=-1)
 add a new entry
virtual CMenuItemaddEntry (COptionMenu *submenu, const char *title)
 add a new submenu entry
virtual CMenuItemaddEntry (const char *title, long index=-1, long itemFlags=CMenuItem::kNoFlags)
 add a new entry
virtual CMenuItemaddSeparator ()
 add a new separator entry
virtual CMenuItemgetCurrent () const
 get current entry
virtual long getCurrentIndex (bool countSeparator=false) const
virtual CMenuItemgetEntry (long index) const
 get entry at index position
virtual long getNbEntries () const
 get number of entries
virtual bool setCurrent (long index, bool countSeparator=true)
 set current entry
virtual bool removeEntry (long index)
 remove an entry
virtual bool removeAllEntry ()
 remove all entries
virtual bool checkEntry (long index, bool state)
 change check state of entry at index
virtual bool checkEntryAlone (long index)
 check entry at index and uncheck every other item
virtual bool isCheckEntry (long index) const
 get check state of entry at index
virtual void setNbItemsPerColumn (long val)
 Windows only.
virtual long getNbItemsPerColumn () const
 Windows only.
long getLastResult () const
 get last index of choosen entry
COptionMenugetLastItemMenu (long &idxInMenu) const
 get last menu and index of choosen entry
 VSTGUI_DEPRECATED (void setScheme(COptionMenuScheme *s){scheme=s;}) VSTGUI_DEPRECATED(virtual COptionMenuScheme *getScheme() const
virtual void setPrefixNumbers (long preCount)
 < get menu scheme
long getPrefixNumbers () const
 get prefix numbering
COptionMenugetSubMenu (long idx) const
 get a submenu

CParamDisplay Methods



virtual void setFont (CFontRef fontID)
const CFontRef getFont () const
virtual void setFontColor (CColor color)
CColor getFontColor () const
virtual void setBackColor (CColor color)
CColor getBackColor () const
virtual void setFrameColor (CColor color)
CColor getFrameColor () const
virtual void setShadowColor (CColor color)
CColor getShadowColor () const
virtual void setAntialias (bool state)
bool getAntialias () const
virtual void setHoriAlign (CHoriTxtAlign hAlign)
CHoriTxtAlign getHoriAlign () const
virtual void setStringConvert (void(*convert)(float value, char *string))
virtual void setStringConvert (void(*convert)(float value, char *string, void *userDta), void *userData)
virtual void setString2FloatConvert (void(*convert)(char *string, float &output))
virtual void setStyle (long val)
long getStyle () const
virtual void setTextTransparency (bool val)
bool getTextTransparency () const

Value Methods



virtual float getValue () const
virtual void setMin (float val)
virtual float getMin () const
virtual void setMax (float val)
virtual float getMax () const
virtual void setOldValue (float val)
virtual float getOldValue (void) const
virtual void setDefaultValue (float val)
virtual float getDefaultValue (void) const
virtual void bounceValue ()
virtual bool checkDefaultValue (long button)

Editing Methods



virtual void setTag (long val)
virtual long getTag () const
virtual void beginEdit ()
virtual void endEdit ()
virtual CControlListenergetListener () const
virtual void setListener (CControlListener *l)

Draw and Update Methods



virtual void drawRect (CDrawContext *pContext, const CRect &updateRect)
 called if the view should draw itself
virtual bool checkUpdate (const CRect &updateRect) const
virtual void invalidRect (const CRect rect)
 mark rect as invalid
virtual void invalid ()
 mark whole view as invalid
virtual void setVisible (bool state)
 set visibility state
bool isVisible () const
 get visibility state

Mouse Methods



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 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 bool hitTest (const CPoint &where, const long buttons=-1)
 check if where hits 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 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 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

Drag & Drop Methods



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

Keyboard Methods



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

View Size Methods



CCoord getHeight () const
 get the height of the view
CCoord getWidth () const
 get the width of the view
virtual void setViewSize (CRect &rect, bool invalid=true)
 set views size
virtual CRectgetViewSize (CRect &rect) const
 returns the current view size
virtual const CRectgetViewSize () const
 read only access to view size
virtual CRect getVisibleSize () const
 returns the visible size of the view
virtual void parentSizeChanged ()
 notification that one of the views parent has changed its size
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 setAutosizeFlags (long flags)
 set autosize flags
virtual long getAutosizeFlags () const
 get autosize flags

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 popup menu control

Define a rectangle view where a text-value can be displayed with a given font and color. The text-value is centered in the given rect. A bitmap can be used as background, a second bitmap can be used when the option menu is popuped. There are 2 styles with or without a shadowed text. When a mouse click occurs, a popup menu is displayed.


Constructor & Destructor Documentation

COptionMenu ( const CRect size,
CControlListener listener,
long  tag,
CBitmap background = 0,
CBitmap bgWhenClick = 0,
const long  style = 0 
)

COptionMenu constructor.

Parameters:
size the size of this view
listener the listener
tag the control tag
background the background bitmap
bgWhenClick the background bitmap if the option menu is displayed
style the style of the display (see CParamDisplay for styles)
COptionMenu ( const COptionMenu menu  ) 
~COptionMenu (  )  [virtual]

Member Function Documentation

CMenuItem * addEntry ( CMenuItem item,
long  index = -1 
) [virtual]

add a new entry

Parameters:
item menu item to add. Takes ownership of item.
index position of insertation. -1 appends the item
CMenuItem * addEntry ( COptionMenu submenu,
const char *  title 
) [virtual]

add a new submenu entry

CMenuItem * addEntry ( const char *  title,
long  index = -1,
long  itemFlags = CMenuItem::kNoFlags 
) [virtual]

add a new entry

CMenuItem * addSeparator (  )  [virtual]

add a new separator entry

CMenuItem * getCurrent (  )  const [virtual]

get current entry

long getCurrentIndex ( bool  countSeparator = false  )  const [virtual]
CMenuItem * getEntry ( long  index  )  const [virtual]

get entry at index position

long getNbEntries (  )  const [virtual]

get number of entries

bool setCurrent ( long  index,
bool  countSeparator = true 
) [virtual]

set current entry

bool removeEntry ( long  index  )  [virtual]

remove an entry

bool removeAllEntry (  )  [virtual]

remove all entries

bool checkEntry ( long  index,
bool  state 
) [virtual]

change check state of entry at index

bool checkEntryAlone ( long  index  )  [virtual]

check entry at index and uncheck every other item

bool isCheckEntry ( long  index  )  const [virtual]

get check state of entry at index

virtual void setNbItemsPerColumn ( long  val  )  [inline, virtual]

Windows only.

virtual long getNbItemsPerColumn (  )  const [inline, virtual]

Windows only.

long getLastResult (  )  const [inline]

get last index of choosen entry

COptionMenu * getLastItemMenu ( long &  idxInMenu  )  const

get last menu and index of choosen entry

VSTGUI_DEPRECATED (  )  const [inline]
void setPrefixNumbers ( long  preCount  )  [virtual]

< get menu scheme

Deprecated:

set prefix numbering

long getPrefixNumbers (  )  const [inline]

get prefix numbering

COptionMenu * getSubMenu ( long  idx  )  const

get a submenu

void setValue ( float  val  )  [virtual]

Reimplemented from CControl.

void draw ( CDrawContext pContext  )  [virtual]

called if the view should draw itself

Parameters:
pContext draw context in which to draw

Reimplemented from CParamDisplay.

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

void takeFocus (  )  [virtual]

called if view should take focus

Reimplemented from CView.

void looseFocus (  )  [virtual]

called if view should loose focus

Reimplemented from CView.

COptionMenu * getItemMenu ( long  idx,
long &  idxInMenu,
long &  offsetIdx 
) [protected]
void removeItems (  )  [protected]
void * appendItems ( long &  offsetIdx  )  [protected]
void setFont ( CFontRef  fontID  )  [virtual, inherited]
const CFontRef getFont (  )  const [inline, inherited]
void setFontColor ( CColor  color  )  [virtual, inherited]
CColor getFontColor (  )  const [inline, inherited]
void setBackColor ( CColor  color  )  [virtual, inherited]
CColor getBackColor (  )  const [inline, inherited]
void setFrameColor ( CColor  color  )  [virtual, inherited]
CColor getFrameColor (  )  const [inline, inherited]
void setShadowColor ( CColor  color  )  [virtual, inherited]
CColor getShadowColor (  )  const [inline, inherited]
virtual void setAntialias ( bool  state  )  [inline, virtual, inherited]
bool getAntialias (  )  const [inline, inherited]
void setHoriAlign ( CHoriTxtAlign  hAlign  )  [virtual, inherited]
CHoriTxtAlign getHoriAlign (  )  const [inline, inherited]
void setStringConvert ( void(*)(float value, char *string)  convert  )  [virtual, inherited]
void setStringConvert ( void(*)(float value, char *string, void *userDta)  convert,
void *  userData 
) [virtual, inherited]
void setString2FloatConvert ( void(*)(char *string, float &output)  convert  )  [virtual, inherited]
void setStyle ( long  val  )  [virtual, inherited]
long getStyle (  )  const [inline, inherited]
virtual void setTextTransparency ( bool  val  )  [inline, virtual, inherited]
bool getTextTransparency (  )  const [inline, inherited]
void drawText ( CDrawContext pContext,
const char *  string,
CBitmap newBack = 0 
) [protected, virtual, inherited]
virtual void doIdleStuff (  )  [inline, virtual, inherited]
virtual float getValue (  )  const [inline, virtual, inherited]
virtual void setMin ( float  val  )  [inline, virtual, inherited]
virtual float getMin (  )  const [inline, virtual, inherited]
virtual void setMax ( float  val  )  [inline, virtual, inherited]
virtual float getMax (  )  const [inline, virtual, inherited]
virtual void setOldValue ( float  val  )  [inline, virtual, inherited]
virtual float getOldValue ( void   )  const [inline, virtual, inherited]
virtual void setDefaultValue ( float  val  )  [inline, virtual, inherited]
virtual float getDefaultValue ( void   )  const [inline, virtual, inherited]
void bounceValue (  )  [virtual, inherited]
bool checkDefaultValue ( long  button  )  [virtual, inherited]
virtual void setTag ( long  val  )  [inline, virtual, inherited]
virtual long getTag (  )  const [inline, virtual, inherited]
void beginEdit (  )  [virtual, inherited]
void endEdit (  )  [virtual, inherited]
virtual CControlListener* getListener (  )  const [inline, virtual, inherited]
virtual void setListener ( CControlListener l  )  [inline, virtual, inherited]
void setBackOffset ( CPoint offset  )  [virtual, inherited]
void copyBackOffset (  )  [virtual, inherited]
virtual void setWheelInc ( float  val  )  [inline, virtual, inherited]
virtual float getWheelInc (  )  const [inline, virtual, inherited]
bool isDirty (  )  const [virtual, inherited]

check if view is dirty

Reimplemented from CView.

Reimplemented in CAnimKnob.

void setDirty ( const bool  val = true  )  [virtual, inherited]

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

Reimplemented from CView.

Reimplemented in CVuMeter.

virtual void drawRect ( CDrawContext pContext,
const CRect updateRect 
) [inline, virtual, inherited]

called if the view should draw itself

Reimplemented in CViewContainer, and CFrame.

virtual bool checkUpdate ( const CRect updateRect  )  const [inline, virtual, inherited]
void invalidRect ( const CRect  rect  )  [virtual, inherited]

mark rect as invalid

Parameters:
rect rect to invalidate

Reimplemented in CViewContainer, and CFrame.

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

mark whole view as invalid

Reimplemented in CViewContainer, and CFrame.

void setVisible ( bool  state  )  [virtual, inherited]

set visibility state

bool isVisible (  )  const [inline, inherited]

get visibility state

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 in CScrollbar, CKnob, CVerticalSwitch, CHorizontalSwitch, CRockerSwitch, CMovieButton, CSlider, CKickButton, CViewContainer, and 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 in CScrollbar, CKnob, CVerticalSwitch, CHorizontalSwitch, CRockerSwitch, CMovieButton, CSlider, CKickButton, CViewContainer, and 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.

virtual bool hitTest ( const CPoint where,
const long  buttons = -1 
) [inline, virtual, inherited]

check if where hits this view

Reimplemented in CSplashScreen, and 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 in CKnob, CRockerSwitch, CSlider, CViewContainer, and 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 in CScrollView, CScrollbar, CViewContainer, and 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

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

called if a drag is dropped onto this view

Reimplemented in CViewContainer.

virtual void onDragEnter ( CDragContainer drag,
const CPoint where 
) [inline, virtual, inherited]

called if a drag is entering this view

Reimplemented in CViewContainer.

virtual void onDragLeave ( CDragContainer drag,
const CPoint where 
) [inline, virtual, inherited]

called if a drag is leaving this view

Reimplemented in CViewContainer.

virtual void onDragMove ( CDragContainer drag,
const CPoint where 
) [inline, virtual, inherited]

called if a drag is moved inside this view

Reimplemented in CViewContainer.

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 in CKnob, CSlider, CViewContainer, and 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 in CViewContainer, and CFrame.

CCoord getHeight (  )  const [inline, inherited]

get the height of the view

CCoord getWidth (  )  const [inline, inherited]

get the width of the view

void setViewSize ( CRect newSize,
bool  invalid = true 
) [virtual, inherited]

set views size

Parameters:
newSize rect of new size of view
invalid if true set view dirty

Reimplemented in CScrollView, CScrollbar, CTabView, CTextEdit, CSlider, CViewContainer, and CFrame.

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

CRect getVisibleSize (  )  const [virtual, inherited]

returns the visible size of the view

Returns:
visible size of view
virtual void parentSizeChanged (  )  [inline, virtual, inherited]

notification that one of the views parent has changed its size

Reimplemented in CTextEdit, and CViewContainer.

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

conversion from frame coordinates to local view coordinates

Parameters:
point location
Returns:
converted point

Reimplemented in CViewContainer.

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

conversion from local view coordinates to frame coordinates

Parameters:
point location
Returns:
converted point

Reimplemented in CViewContainer.

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 void setTransparency ( bool  val  )  [inline, virtual, inherited]

set views transparent state

Reimplemented in CScrollView.

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

get views transparent state

bool removed ( CView parent  )  [virtual, inherited]

view is removed from parent view

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

Reimplemented in CVuMeter, and 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

Reimplemented in CDataBrowser, CVuMeter, and CViewContainer.

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

Reimplemented in CDataBrowser, CScrollbar, and CViewContainer.

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

void* platformControl [protected]
CMenuItemList* menuItems [protected]
long currentIndex [protected]
CBitmap* bgWhenClick [protected]
long lastButton [protected]
long nbItemsPerColumn [protected]
long lastResult [protected]
long prefixNumbers [protected]
COptionMenu* lastMenu [protected]
COptionMenuScheme* scheme [protected]
void(* stringConvert)(float value, char *string) [protected, inherited]
void(* stringConvert2)(float value, char *string, void *userData) [protected, inherited]
void(* string2FloatConvert)(char *string, float &output) [protected, inherited]
void* userData [protected, inherited]
CHoriTxtAlign horiTxtAlign [protected, inherited]
long style [protected, inherited]
CFontRef fontID [protected, inherited]
CColor fontColor [protected, inherited]
CColor backColor [protected, inherited]
CColor frameColor [protected, inherited]
CColor shadowColor [protected, inherited]
bool bTextTransparencyEnabled [protected, inherited]
bool bAntialias [protected, inherited]
VSTGUI_DEPRECATED (bool isDoubleClick ();) protected long tag [inherited]
float oldValue [inherited]
float defaultValue [inherited]
float value [inherited]
float vmin [inherited]
float vmax [inherited]
float wheelInc [inherited]
long lastTicks [inherited]
long delta [inherited]
CPoint backOffset [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