VSTGUI  4.3
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
COptionMenu Class Reference

a popup menu control More...

+ Inheritance diagram for COptionMenu:
+ Collaboration diagram for COptionMenu:

Public Member Functions

 COptionMenu ()
 
 COptionMenu (const CRect &size, IControlListener *listener, int32_t tag, CBitmap *background=0, CBitmap *bgWhenClick=0, const int32_t style=0)
 
 COptionMenu (const COptionMenu &menu)
 
 ~COptionMenu ()
 
virtual void setValue (float val)
 
virtual void setMin (float val)
 
virtual float getMin () const
 
virtual void setMax (float val)
 
virtual float getMax () const
 
virtual void draw (CDrawContext *pContext)
 called if the view should draw itself More...
 
virtual CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons)
 called when a mouse down event occurs More...
 
virtual int32_t onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus More...
 
virtual void takeFocus ()
 called if view should take focus More...
 
virtual void looseFocus ()
 called if view should loose focus More...
 
virtual bool isTypeOf (IdStringPtr s) const
 
virtual CBaseObjectnewCopy () const
 
bool getFocusPath (CGraphicsPath &outPath)
 
bool removed (CView *parent)
 view is removed from parent view More...
 
bool isDirty () const
 check if view is dirty More...
 
void setDirty (bool val=true)
 set the view to dirty so that it is redrawn in the next idle. Thread Safe ! More...
 
bool drawFocusOnTop ()
 
void setSubviewState (bool state)
 
bool isSubview () const
 
CGraphicsTransform getGlobalTransform () const
 
template<typename T >
T & translateToGlobal (T &t) const
 
template<typename T >
translateToGlobal (const T &t) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
T & translateToLocal (T &t) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
translateToLocal (const T &t) const
 translates a global coordinate to a local one using parent transforms More...
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message)
 translates a local coordinate to a global one using parent transforms More...
 
void beforeDelete ()
 
virtual void addDependency (CBaseObject *obj)
 
virtual void removeDependency (CBaseObject *obj)
 
virtual void changed (IdStringPtr message)
 
virtual void deferChanges (bool state)
 
COptionMenu Methods
virtual CMenuItemaddEntry (CMenuItem *item, int32_t index=-1)
 add a new entry More...
 
virtual CMenuItemaddEntry (COptionMenu *submenu, UTF8StringPtr title)
 add a new submenu entry More...
 
virtual CMenuItemaddEntry (UTF8StringPtr title, int32_t index=-1, int32_t itemFlags=CMenuItem::kNoFlags)
 add a new entry More...
 
virtual CMenuItemaddSeparator (int32_t index=-1)
 add a new separator entry More...
 
virtual CMenuItemgetCurrent () const
 get current entry More...
 
virtual int32_t getCurrentIndex (bool countSeparator=false) const
 
virtual CMenuItemgetEntry (int32_t index) const
 get entry at index position More...
 
virtual int32_t getNbEntries () const
 get number of entries More...
 
virtual bool setCurrent (int32_t index, bool countSeparator=true)
 set current entry More...
 
virtual bool removeEntry (int32_t index)
 remove an entry More...
 
virtual bool removeAllEntry ()
 remove all entries More...
 
virtual bool checkEntry (int32_t index, bool state)
 change check state of entry at index More...
 
virtual bool checkEntryAlone (int32_t index)
 check entry at index and uncheck every other item More...
 
virtual bool isCheckEntry (int32_t index) const
 get check state of entry at index More...
 
virtual void setNbItemsPerColumn (int32_t val)
 Windows only. More...
 
virtual int32_t getNbItemsPerColumn () const
 Windows only. More...
 
int32_t getLastResult () const
 get last index of choosen entry More...
 
COptionMenugetLastItemMenu (int32_t &idxInMenu) const
 get last menu and index of choosen entry More...
 
virtual void setPrefixNumbers (int32_t preCount)
 set prefix numbering More...
 
int32_t getPrefixNumbers () const
 get prefix numbering More...
 
COptionMenugetSubMenu (int32_t idx) const
 get a submenu More...
 
bool popup ()
 pops up menu More...
 
bool popup (CFrame *frame, const CPoint &frameLocation)
 pops up menu at frameLocation More...
 
CMenuItemListgetItems () const
 
Value Methods
virtual float getValue () const
 
virtual void setValueNormalized (float val)
 
virtual float getValueNormalized () const
 
float getRange () 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 (CButtonState button)
 
virtual void valueChanged ()
 notifies listener and dependent objects More...
 
Editing Methods
virtual void setTag (int32_t val)
 
virtual int32_t getTag () const
 
virtual void beginEdit ()
 
virtual void endEdit ()
 
bool isEditing () const
 
virtual IControlListenergetListener () const
 get main listener More...
 
virtual void setListener (IControlListener *l)
 set main listener More...
 
void registerControlListener (IControlListener *listener)
 register a sub listener More...
 
void unregisterControlListener (IControlListener *listener)
 unregister a sub listener More...
 
Misc
virtual void setBackOffset (const CPoint &offset)
 
virtual const CPointgetBackOffset () const
 
virtual void copyBackOffset ()
 
virtual void setWheelInc (float val)
 
virtual float getWheelInc () const
 
virtual void doIdleStuff ()
 
Mouse Methods
virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons)
 called when a mouse up event occurs More...
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons)
 called when a mouse move event occurs More...
 
virtual CMouseEventResult onMouseCancel ()
 called when mouse tracking should be canceled More...
 
virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 called when the mouse enters this view More...
 
virtual CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons)
 called when the mouse leaves this view More...
 
void setHitTestPath (CGraphicsPath *path)
 
virtual bool hitTest (const CPoint &where, const CButtonState &buttons=-1)
 check if where hits this view More...
 
virtual bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view More...
 
virtual bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view More...
 
virtual void setMouseEnabled (bool bEnable=true)
 turn on/off mouse usage for this view More...
 
virtual bool getMouseEnabled () const
 get the state of wheather this view uses the mouse or not More...
 
virtual void setMouseableArea (const CRect &rect)
 set the area in which the view reacts to the mouse More...
 
virtual CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse More...
 
virtual const CRectgetMouseableArea () const
 read only access to the mouseable area More...
 
Drag & Drop Methods
virtual DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=0)
 start a drag operation. See CDropSource to create the source data package More...
 
virtual bool onDrop (IDataPackage *drag, const CPoint &where)
 called if a drag is dropped onto this view More...
 
virtual void onDragEnter (IDataPackage *drag, const CPoint &where)
 called if a drag is entering this view More...
 
virtual void onDragLeave (IDataPackage *drag, const CPoint &where)
 called if a drag is leaving this view More...
 
virtual void onDragMove (IDataPackage *drag, const CPoint &where)
 called if a drag is moved inside this view More...
 
Keyboard Methods
virtual int32_t onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus More...
 
View Size Methods
CCoord getHeight () const
 get the height of the view More...
 
CCoord getWidth () const
 get the width of the view More...
 
virtual void setViewSize (const CRect &rect, bool invalid=true)
 set views size More...
 
CRectgetViewSize (CRect &rect) const
 returns the current view size More...
 
const CRectgetViewSize () const
 read only access to view size More...
 
virtual CRect getVisibleViewSize () const
 returns the visible size of the view More...
 
virtual void parentSizeChanged ()
 notification that one of the views parent has changed its size More...
 
virtual CPointframeToLocal (CPoint &point) const
 conversion from frame coordinates to local view coordinates More...
 
virtual CPointlocalToFrame (CPoint &point) const
 conversion from local view coordinates to frame coordinates More...
 
virtual void setAutosizeFlags (int32_t flags)
 set autosize flags More...
 
virtual int32_t getAutosizeFlags () const
 get autosize flags More...
 
virtual bool sizeToFit ()
 resize view to optimal size More...
 
Focus Methods
virtual bool wantsFocus () const
 check if view supports focus More...
 
virtual void setWantsFocus (bool state)
 set focus support on/off More...
 
Attribute Methods
bool getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
 get the size of an attribute More...
 
bool getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
 get an attribute More...
 
bool setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
 set an attribute More...
 
bool removeAttribute (const CViewAttributeID id)
 remove an attribute More...
 
Background Methods
virtual void setBackground (CBitmap *background)
 set the background image of this view More...
 
CBitmapgetBackground () const
 get the background image of this view More...
 
virtual void setDisabledBackground (CBitmap *background)
 set background image used when the mouse is not enabled More...
 
CBitmapgetDisabledBackground () const
 get background image used when the mouse is not enabled More...
 
CBitmapgetDrawBackground () const
 
Transparency Methods
virtual void setTransparency (bool val)
 set views transparent state More...
 
virtual bool getTransparency () const
 get views transparent state More...
 
virtual void setAlphaValue (float alpha)
 set alpha value which will be applied when drawing this view More...
 
float getAlphaValue () const
 get alpha value More...
 
Attaching Methods
virtual bool attached (CView *parent)
 view is attached to a parent view More...
 
bool isAttached () const
 is view attached to a parentView More...
 
Parent Methods
CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () const
 get frame More...
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor More...
 
Animation Methods
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=0)
 
void removeAnimation (IdStringPtr name)
 
void removeAllAnimations ()
 
View Listener Methods
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
Reference Counting Methods
virtual void forget ()
 decrease refcount and delete object if refcount == 0 More...
 
virtual void remember ()
 increase refcount More...
 
virtual int32_t getNbReference () const
 get refcount More...
 

Static Public Attributes

static IdStringPtr kMsgBeforePopup = "kMsgBeforePopup"
 
static int32_t kZoomModifier = kShift
 zoom modifier key, per default is the shift key More...
 
static int32_t kDefaultValueModifier = kControl
 default value modifier key, per default is the control key More...
 
static IdStringPtr kMessageTagWillChange = "kMessageTagWillChange"
 
static IdStringPtr kMessageTagDidChange = "kMessageTagDidChange"
 
static IdStringPtr kMessageValueChanged = "kMessageValueChanged"
 
static IdStringPtr kMessageBeginEdit = "kMessageBeginEdit"
 
static IdStringPtr kMessageEndEdit = "kMessageEndEdit"
 

Protected Types

typedef DispatchList
< IControlListener
SubListenerDispatcher
 
enum  {
  kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3,
  kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kIsSubview = 1 << 7,
  kLastCViewFlag = 7
}
 
typedef std::set< IdStringPtrDeferedChangesSet
 
typedef std::list< CBaseObject * > DependentList
 

Protected Member Functions

void beforePopup ()
 
virtual void drawBack (CDrawContext *pContext, CBitmap *newBack=0)
 
void drawText (CDrawContext *pContext, UTF8StringPtr string)
 
void drawText (CDrawContext *pContext, UTF8StringPtr string, const CRect &size)
 
virtual void drawPlatformText (CDrawContext *pContext, IPlatformString *string)
 
virtual void drawPlatformText (CDrawContext *pContext, IPlatformString *string, const CRect &size)
 
virtual void drawStyleChanged ()
 
CGraphicsPathgetHitTestPath () const
 

Static Protected Member Functions

static int32_t mapVstKeyModifier (int32_t vstModifier)
 
static void rememberObject (CBaseObject *obj)
 
static void forgetObject (CBaseObject *obj)
 

Protected Attributes

CMenuItemListmenuItems
 
bool inPopup
 
int32_t currentIndex
 
CButtonState lastButton
 
int32_t nbItemsPerColumn
 
int32_t lastResult
 
int32_t prefixNumbers
 
CBitmapbgWhenClick
 
COptionMenulastMenu
 
CParamDisplayValueToStringProc valueToString
 
void * valueToStringUserData
 
CHoriTxtAlign horiTxtAlign
 
int32_t style
 
uint8_t valuePrecision
 
CFontRef fontID
 
CColor fontColor
 
CColor backColor
 
CColor frameColor
 
CColor shadowColor
 
CPoint textInset
 
CCoord roundRectRadius
 
CCoord frameWidth
 
double textRotation
 
bool bAntialias
 
IControlListenerlistener
 
SubListenerDispatcher subListeners
 
int32_t tag
 
float oldValue
 
float defaultValue
 
float value
 
float vmin
 
float vmax
 
float wheelInc
 
int32_t editing
 
CPoint backOffset
 
CRect size
 
CRect mouseableArea
 
CFramepParentFrame
 
CViewpParentView
 
int32_t viewFlags
 
int32_t autosizeFlags
 
float alphaValue
 
int32_t deferChangeCount
 
DeferedChangesSet deferedChanges
 
DependentList dependents
 

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 setTextInset (const CPoint &p)
 
CPoint getTextInset () const
 
virtual void setTextRotation (double angle)
 
double getTextRotation () const
 
virtual void setRoundRectRadius (const CCoord &radius)
 
CCoord getRoundRectRadius () const
 
virtual void setFrameWidth (const CCoord &width)
 
CCoord getFrameWidth () const
 
virtual void setValueToStringProc (CParamDisplayValueToStringProc proc, void *userData=0)
 deprecated use setValueToStringFunction instead if you use c++11 More...
 
virtual void setStyle (int32_t val)
 
int32_t getStyle () const
 
virtual void setPrecision (uint8_t precision)
 
uint8_t getPrecision () const
 
typedef void ValueToStringUserData
 

Draw and Update Methods

static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false. More...
 
virtual void drawRect (CDrawContext *pContext, const CRect &updateRect)
 called if the view should draw itself More...
 
virtual bool checkUpdate (const CRect &updateRect) const
 
virtual void invalidRect (const CRect &rect)
 mark rect as invalid More...
 
virtual void invalid ()
 mark whole view as invalid More...
 
virtual void setVisible (bool state)
 set visibility state More...
 
bool isVisible () const
 get visibility state More...
 

Idle Methods

Should be used when a view needs to do a task periodically. The onIdle() method will be called only if the view is attached.

static uint32_t idleRate
 global idle rate in Hz, defaults to 30 Hz More...
 
virtual void onIdle ()
 called on idle when view wants idle More...
 
void setWantsIdle (bool state)
 enable/disable onIdle() callback More...
 
bool wantsIdle () const
 returns if the view wants idle callback or not More...
 

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.

Member Typedef Documentation

typedef std::set<IdStringPtr> DeferedChangesSet
protectedinherited
typedef std::list<CBaseObject*> DependentList
protectedinherited
typedef void ValueToStringUserData
inherited

Member Enumeration Documentation

anonymous enum
protectedinherited
Enumerator
kMouseEnabled 
kTransparencyEnabled 
kWantsFocus 
kIsAttached 
kVisible 
kDirty 
kWantsIdle 
kIsSubview 
kLastCViewFlag 

Constructor & Destructor Documentation

+ Here is the call graph for this function:

COptionMenu ( const CRect size,
IControlListener listener,
int32_t  tag,
CBitmap background = 0,
CBitmap bgWhenClick = 0,
const int32_t  style = 0 
)

COptionMenu constructor.

Parameters
sizethe size of this view
listenerthe listener
tagthe control tag
backgroundthe background bitmap
bgWhenClickthe background bitmap if the option menu is displayed
stylethe style of the display (see CParamDisplay for styles)

+ Here is the call graph for this function:

COptionMenu ( const COptionMenu menu)

+ Here is the call graph for this function:

+ Here is the call graph for this function:

Member Function Documentation

void addAnimation ( IdStringPtr  name,
Animation::IAnimationTarget target,
Animation::ITimingFunction timingFunction,
CBaseObject notificationObject = 0 
)
inherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void addDependency ( CBaseObject obj)
inlinevirtualinherited

add a dependent object

+ Here is the caller graph for this function:

CMenuItem * addEntry ( CMenuItem item,
int32_t  index = -1 
)
virtual

add a new entry

Parameters
itemmenu item to add. Takes ownership of item.
indexposition of insertation. -1 appends the item

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CMenuItem * addEntry ( COptionMenu submenu,
UTF8StringPtr  title 
)
virtual

add a new submenu entry

+ Here is the call graph for this function:

CMenuItem * addEntry ( UTF8StringPtr  title,
int32_t  index = -1,
int32_t  itemFlags = CMenuItem::kNoFlags 
)
virtual

add a new entry

+ Here is the call graph for this function:

CMenuItem * addSeparator ( int32_t  index = -1)
virtual

add a new separator entry

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool attached ( CView parent)
virtualinherited

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

Reimplemented in CDataBrowser, CViewContainer, CFrame, CSegmentButton, CFontChooser, CSplitView, COpenGLView, CShadowViewContainer, UIViewSwitchContainer, CLayeredViewContainer, and CAutoLayoutContainerView.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void beforeDelete ( )
virtualinherited

Reimplemented from CBaseObject.

+ Here is the call graph for this function:

void beforePopup ( )
protected

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void beginEdit ( )
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void bounceValue ( )
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void changed ( IdStringPtr  message)
inlinevirtualinherited

notify dependent objects of change with message.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool checkDefaultValue ( CButtonState  button)
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool checkEntry ( int32_t  index,
bool  state 
)
virtual

change check state of entry at index

+ Here is the call graph for this function:

bool checkEntryAlone ( int32_t  index)
virtual

check entry at index and uncheck every other item

virtual bool checkUpdate ( const CRect updateRect) const
inlinevirtualinherited

+ Here is the call graph for this function:

void copyBackOffset ( )
virtualinherited

+ Here is the call graph for this function:

void deferChanges ( bool  state)
inlinevirtualinherited

defer changes until later. can be nested. If you use this, you must make sure that all message pointers are valid the whole time.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

DragResult doDrag ( IDataPackage source,
const CPoint offset = CPoint (0, 0),
CBitmap dragBitmap = 0 
)
virtualinherited

start a drag operation. See CDropSource to create the source data package

a drag can only be started from within onMouseDown

Parameters
sourcesource drop
offsetbitmap offset
dragBitmapbitmap to drag
Returns
0 on failure, negative if source was moved and positive if source was copied

Reimplemented in CFrame.

+ Here is the call graph for this function:

void doIdleStuff ( )
virtualinherited

+ Here is the call graph for this function:

void draw ( CDrawContext pContext)
virtual

called if the view should draw itself

Parameters
pContextdraw context in which to draw

Implements CControl.

+ Here is the call graph for this function:

void drawBack ( CDrawContext pContext,
CBitmap newBack = 0 
)
protectedvirtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool drawFocusOnTop ( )
virtualinherited

draw focus before view will be drawn or afterwards

Implements IFocusDrawing.

Reimplemented in CSegmentButton, and CKnob.

+ Here is the caller graph for this function:

void drawPlatformText ( CDrawContext pContext,
IPlatformString *  string 
)
protectedvirtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void drawPlatformText ( CDrawContext pContext,
IPlatformString *  string,
const CRect size 
)
protectedvirtualinherited

+ Here is the call graph for this function:

virtual void drawRect ( CDrawContext pContext,
const CRect updateRect 
)
inlinevirtualinherited

called if the view should draw itself

Reimplemented in CFrame, CViewContainer, CSegmentButton, CShadowViewContainer, and CLayeredViewContainer.

+ Here is the call graph for this function:

void drawStyleChanged ( )
protectedvirtualinherited

Reimplemented in CTextLabel.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void drawText ( CDrawContext pContext,
UTF8StringPtr  string 
)
protectedinherited

+ Here is the call graph for this function:

void drawText ( CDrawContext pContext,
UTF8StringPtr  string,
const CRect size 
)
protectedinherited

+ Here is the call graph for this function:

void endEdit ( )
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void forget ( )
inlinevirtualinherited

decrease refcount and delete object if refcount == 0

+ Here is the call graph for this function:

static void forgetObject ( CBaseObject obj)
inlinestaticprotectedinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CPoint & frameToLocal ( CPoint point) const
virtualinherited

conversion from frame coordinates to local view coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented in CViewContainer.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

float getAlphaValue ( ) const
inlineinherited

get alpha value

+ Here is the caller graph for this function:

bool getAntialias ( ) const
inlineinherited
bool getAttribute ( const CViewAttributeID  aId,
const uint32_t  inSize,
void *  outData,
uint32_t &  outSize 
) const
inherited

get an attribute

Parameters
aIdthe ID of the Attribute
inSizethe size of the outData pointer
outDataa pointer where to copy the attribute data
outSizethe size in bytes which was copied into outData
Returns
true if attribute exists and outData was big enough. outSize and outData is valid then.

+ Here is the caller graph for this function:

bool getAttributeSize ( const CViewAttributeID  aId,
uint32_t &  outSize 
) const
inherited

get the size of an attribute

Parameters
aIdthe ID of the Attribute
outSizeon return the size of the attribute
Returns
true if attribute exists. outSize is valid then.

+ Here is the caller graph for this function:

virtual int32_t getAutosizeFlags ( ) const
inlinevirtualinherited

get autosize flags

+ Here is the caller graph for this function:

CColor getBackColor ( ) const
inlineinherited

+ Here is the caller graph for this function:

CBitmap* getBackground ( ) const
inlineinherited

get the background image of this view

+ Here is the caller graph for this function:

virtual const CPoint& getBackOffset ( ) const
inlinevirtualinherited
CMenuItem * getCurrent ( ) const
virtual

get current entry

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int32_t getCurrentIndex ( bool  countSeparator = false) const
virtual
virtual float getDefaultValue ( void  ) const
inlinevirtualinherited

+ Here is the caller graph for this function:

CBitmap* getDisabledBackground ( ) const
inlineinherited

get background image used when the mouse is not enabled

CBitmap* getDrawBackground ( ) const
inlineinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

VSTGUIEditorInterface * getEditor ( ) const
virtualinherited

get editor

Reimplemented in CFrame.

+ Here is the call graph for this function:

CMenuItem * getEntry ( int32_t  index) const
virtual

get entry at index position

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool getFocusPath ( CGraphicsPath outPath)
virtualinherited

the graphics path will be drawn filled with the evenodd method and the color set in CFrame::setFocusColor()

Reimplemented from CControl.

+ Here is the call graph for this function:

const CFontRef getFont ( ) const
inlineinherited

+ Here is the caller graph for this function:

CColor getFontColor ( ) const
inlineinherited

+ Here is the caller graph for this function:

CFrame* getFrame ( ) const
inlineinherited

get frame

+ Here is the caller graph for this function:

CColor getFrameColor ( ) const
inlineinherited
CCoord getFrameWidth ( ) const
inlineinherited
CGraphicsTransform getGlobalTransform ( ) const
inherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CCoord getHeight ( ) const
inlineinherited

get the height of the view

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CGraphicsPath* getHitTestPath ( ) const
inlineprotectedinherited
CHoriTxtAlign getHoriAlign ( ) const
inlineinherited

+ Here is the caller graph for this function:

CMenuItemList* getItems ( ) const
inline
COptionMenu * getLastItemMenu ( int32_t &  idxInMenu) const

get last menu and index of choosen entry

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int32_t getLastResult ( ) const
inline

get last index of choosen entry

virtual IControlListener* getListener ( ) const
inlinevirtualinherited

get main listener

+ Here is the caller graph for this function:

virtual float getMax ( ) const
inlinevirtual

Reimplemented from CControl.

virtual float getMin ( ) const
inlinevirtual

Reimplemented from CControl.

virtual CRect& getMouseableArea ( CRect rect) const
inlinevirtualinherited

get the area in which the view reacts to the mouse

+ Here is the caller graph for this function:

virtual const CRect& getMouseableArea ( ) const
inlinevirtualinherited

read only access to the mouseable area

virtual bool getMouseEnabled ( ) const
inlinevirtualinherited

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

+ Here is the caller graph for this function:

int32_t getNbEntries ( ) const
virtual

get number of entries

+ Here is the caller graph for this function:

virtual int32_t getNbItemsPerColumn ( ) const
inlinevirtual

Windows only.

virtual int32_t getNbReference ( ) const
inlinevirtualinherited

get refcount

virtual float getOldValue ( void  ) const
inlinevirtualinherited

+ Here is the caller graph for this function:

CView* getParentView ( ) const
inlineinherited

get parent view

+ Here is the caller graph for this function:

uint8_t getPrecision ( ) const
inlineinherited
int32_t getPrefixNumbers ( ) const
inline

get prefix numbering

float getRange ( ) const
inlineinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CCoord getRoundRectRadius ( ) const
inlineinherited

+ Here is the caller graph for this function:

CColor getShadowColor ( ) const
inlineinherited
int32_t getStyle ( ) const
inlineinherited

+ Here is the caller graph for this function:

COptionMenu * getSubMenu ( int32_t  idx) const

get a submenu

+ Here is the call graph for this function:

virtual int32_t getTag ( ) const
inlinevirtualinherited

+ Here is the caller graph for this function:

CPoint getTextInset ( ) const
inlineinherited

+ Here is the caller graph for this function:

double getTextRotation ( ) const
inlineinherited
virtual bool getTransparency ( ) const
inlinevirtualinherited

get views transparent state

+ Here is the caller graph for this function:

virtual float getValue ( ) const
inlinevirtualinherited

+ Here is the caller graph for this function:

float getValueNormalized ( ) const
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CRect& getViewSize ( CRect rect) const
inlineinherited

returns the current view size

+ Here is the caller graph for this function:

const CRect& getViewSize ( ) const
inlineinherited

read only access to view size

CRect getVisibleViewSize ( ) const
virtualinherited

returns the visible size of the view

Returns
visible size of view

+ Here is the caller graph for this function:

virtual float getWheelInc ( ) const
inlinevirtualinherited
CCoord getWidth ( ) const
inlineinherited

get the width of the view

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool hitTest ( const CPoint where,
const CButtonState buttons = -1 
)
virtualinherited

check if where hits this view

Parameters
wherelocation
buttonsbutton and modifier state
Returns
true if point hits this view

Reimplemented in CViewContainer, and CSplashScreen.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void invalid ( )
inlinevirtualinherited

mark whole view as invalid

Reimplemented in CViewContainer, CFrame, and CLayeredViewContainer.

+ Here is the call graph for this function:

void invalidRect ( const CRect rect)
virtualinherited

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented in CViewContainer, CFrame, COpenGLView, and CLayeredViewContainer.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool isAttached ( ) const
inlineinherited

is view attached to a parentView

+ Here is the caller graph for this function:

bool isCheckEntry ( int32_t  index) const
virtual

get check state of entry at index

+ Here is the call graph for this function:

bool isDirty ( ) const
virtualinherited

check if view is dirty

Reimplemented from CView.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool isEditing ( ) const
inlineinherited

+ Here is the caller graph for this function:

bool isSubview ( ) const
inlineinherited

+ Here is the caller graph for this function:

virtual bool isTypeOf ( IdStringPtr  s) const
inlinevirtual

Reimplemented from CParamDisplay.

bool isVisible ( ) const
inlineinherited

get visibility state

+ Here is the caller graph for this function:

CPoint & localToFrame ( CPoint point) const
virtualinherited

conversion from local view coordinates to frame coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented in CViewContainer.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void looseFocus ( )
virtual

called if view should loose focus

Reimplemented from CView.

+ Here is the call graph for this function:

int32_t mapVstKeyModifier ( int32_t  vstModifier)
staticprotectedinherited

+ Here is the caller graph for this function:

virtual CBaseObject* newCopy ( ) const
inlinevirtual

Reimplemented from CParamDisplay.

CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
)
virtualinherited

translates a local coordinate to a global one using parent transforms

Parameters
sendermessage sender
messagemessage text
Returns
message handled or not. See CMessageResult

Reimplemented from CBaseObject.

Reimplemented in CViewContainer.

+ Here is the caller graph for this function:

virtual void onDragEnter ( IDataPackage drag,
const CPoint where 
)
inlinevirtualinherited

called if a drag is entering this view

Reimplemented in CViewContainer.

virtual void onDragLeave ( IDataPackage drag,
const CPoint where 
)
inlinevirtualinherited

called if a drag is leaving this view

Reimplemented in CViewContainer.

virtual void onDragMove ( IDataPackage drag,
const CPoint where 
)
inlinevirtualinherited

called if a drag is moved inside this view

Reimplemented in CViewContainer.

virtual bool onDrop ( IDataPackage drag,
const CPoint where 
)
inlinevirtualinherited

called if a drag is dropped onto this view

Reimplemented in CViewContainer.

virtual void onIdle ( )
inlinevirtualinherited

called on idle when view wants idle

Reimplemented in CVuMeter.

int32_t onKeyDown ( VstKeyCode keyCode)
virtual

called if a key down event occurs and this view has focus

Parameters
keyCodekey code of pressed key
Returns
-1 if not handled and 1 if handled

Reimplemented from CView.

+ Here is the call graph for this function:

int32_t onKeyUp ( VstKeyCode keyCode)
virtualinherited

called if a key up event occurs and this view has focus

Parameters
keyCodekey code of pressed key
Returns
-1 if not handled and 1 if handled

Reimplemented in CTextButton, CFrame, CKickButton, and CRockerSwitch.

+ Here is the caller graph for this function:

CMouseEventResult onMouseCancel ( )
virtualinherited

called when mouse tracking should be canceled

Reimplemented in CTextButton, CKickButton, CViewContainer, CCheckBox, CSlider, and COnOffButton.

CMouseEventResult onMouseDown ( CPoint where,
const CButtonState buttons 
)
virtual

called when a mouse down event occurs

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

Reimplemented from CView.

+ Here is the call graph for this function:

virtual CMouseEventResult onMouseEntered ( CPoint where,
const CButtonState buttons 
)
inlinevirtualinherited

called when the mouse enters this view

Reimplemented in CScrollbar.

virtual CMouseEventResult onMouseExited ( CPoint where,
const CButtonState buttons 
)
inlinevirtualinherited

called when the mouse leaves this view

Reimplemented in CFrame, and CScrollbar.

+ Here is the caller graph for this function:

CMouseEventResult onMouseMoved ( CPoint where,
const CButtonState buttons 
)
virtualinherited

called when a mouse move event occurs

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

Reimplemented in CTextButton, CFrame, CKickButton, CViewContainer, CCheckBox, CRockerSwitch, CKnob, CSlider, CHorizontalSwitch, COnOffButton, CScrollbar, CMovieButton, CVerticalSwitch, and CXYPad.

+ Here is the caller graph for this function:

CMouseEventResult onMouseUp ( CPoint where,
const CButtonState buttons 
)
virtualinherited

called when a mouse up event occurs

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

Reimplemented in CTextButton, CFrame, CKickButton, CViewContainer, CCheckBox, CRockerSwitch, CKnob, CSlider, CHorizontalSwitch, COnOffButton, CScrollbar, CMovieButton, CVerticalSwitch, and CXYPad.

bool onWheel ( const CPoint where,
const float &  distance,
const CButtonState buttons 
)
virtualinherited

called if a mouse wheel event is happening over this view

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

Reimplemented in CFrame, CViewContainer, CRockerSwitch, CSlider, CKnob, and CTextLabel.

+ Here is the caller graph for this function:

bool onWheel ( const CPoint where,
const CMouseWheelAxis axis,
const float &  distance,
const CButtonState buttons 
)
virtualinherited

called if a mouse wheel event is happening over this view

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

Reimplemented in CFrame, CViewContainer, CScrollView, CTextLabel, and CScrollbar.

+ Here is the call graph for this function:

virtual void parentSizeChanged ( )
inlinevirtualinherited

notification that one of the views parent has changed its size

Reimplemented in CViewContainer, CTextEdit, COpenGLView, and CLayeredViewContainer.

+ Here is the caller graph for this function:

bool popup ( )

pops up menu

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool popup ( CFrame frame,
const CPoint frameLocation 
)

pops up menu at frameLocation

+ Here is the call graph for this function:

void registerControlListener ( IControlListener listener)
inherited

register a sub listener

+ Here is the call graph for this function:

void registerViewListener ( IViewListener listener)
inherited

+ Here is the call graph for this function:

virtual void remember ( )
inlinevirtualinherited

increase refcount

+ Here is the caller graph for this function:

static void rememberObject ( CBaseObject obj)
inlinestaticprotectedinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void removeAllAnimations ( )
inherited

+ Here is the call graph for this function:

bool removeAllEntry ( )
virtual

remove all entries

+ Here is the caller graph for this function:

void removeAnimation ( IdStringPtr  name)
inherited

+ Here is the call graph for this function:

bool removeAttribute ( const CViewAttributeID  id)
inherited

remove an attribute

+ Here is the caller graph for this function:

bool removed ( CView parent)
virtualinherited

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented from CView.

+ Here is the call graph for this function:

void removeDependency ( CBaseObject obj)
inlinevirtualinherited

remove a dependent object.

+ Here is the caller graph for this function:

bool removeEntry ( int32_t  index)
virtual

remove an entry

+ Here is the call graph for this function:

void setAlphaValue ( float  alpha)
virtualinherited

set alpha value which will be applied when drawing this view

Reimplemented in CLayeredViewContainer.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void setAntialias ( bool  state)
inlinevirtualinherited
bool setAttribute ( const CViewAttributeID  aId,
const uint32_t  inSize,
const void *  inData 
)
inherited

set an attribute

copies data into the attribute. If it does not exist, creates a new attribute.

Parameters
aIdthe ID of the Attribute
inSizethe size of the outData pointer
inDataa pointer to the data
Returns
true if attribute was set

+ Here is the caller graph for this function:

virtual void setAutosizeFlags ( int32_t  flags)
inlinevirtualinherited

set autosize flags

Reimplemented in CDataBrowser, CScrollView, and CTabView.

+ Here is the caller graph for this function:

void setBackColor ( CColor  color)
virtualinherited

+ Here is the call graph for this function:

void setBackground ( CBitmap background)
virtualinherited

set the background image of this view

Parameters
backgroundnew background bitmap

Reimplemented in CAnimKnob, and CCheckBox.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setBackOffset ( const CPoint offset)
virtualinherited
bool setCurrent ( int32_t  index,
bool  countSeparator = true 
)
virtual

set current entry

+ Here is the call graph for this function:

virtual void setDefaultValue ( float  val)
inlinevirtualinherited

+ Here is the caller graph for this function:

void setDirty ( bool  val = true)
virtualinherited

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

Reimplemented from CView.

Reimplemented in CVuMeter.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setDisabledBackground ( CBitmap background)
virtualinherited

set background image used when the mouse is not enabled

Parameters
backgroundnew disabled background bitmap

+ Here is the call graph for this function:

void setFont ( CFontRef  fontID)
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setFontColor ( CColor  color)
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setFrameColor ( CColor  color)
virtualinherited

+ Here is the call graph for this function:

void setFrameWidth ( const CCoord width)
virtualinherited

+ Here is the call graph for this function:

void setHitTestPath ( CGraphicsPath path)
inherited
Parameters
paththe path to use for hit testing. The path will be translated by this views origin, so that the path must not be set again, if the view is moved. Otherwise when the size of the view changes, the path must also be set again.
void setHoriAlign ( CHoriTxtAlign  hAlign)
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void setListener ( IControlListener l)
inlinevirtualinherited

set main listener

+ Here is the caller graph for this function:

virtual void setMax ( float  val)
inlinevirtual

Reimplemented from CControl.

virtual void setMin ( float  val)
inlinevirtual

Reimplemented from CControl.

virtual void setMouseableArea ( const CRect rect)
inlinevirtualinherited

set the area in which the view reacts to the mouse

+ Here is the caller graph for this function:

void setMouseEnabled ( bool  bEnable = true)
virtualinherited

turn on/off mouse usage for this view

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void setNbItemsPerColumn ( int32_t  val)
inlinevirtual

Windows only.

virtual void setOldValue ( float  val)
inlinevirtualinherited

+ Here is the caller graph for this function:

void setPrecision ( uint8_t  precision)
virtualinherited

+ Here is the call graph for this function:

void setPrefixNumbers ( int32_t  preCount)
virtual

set prefix numbering

void setRoundRectRadius ( const CCoord radius)
virtualinherited

+ Here is the call graph for this function:

void setShadowColor ( CColor  color)
virtualinherited

+ Here is the call graph for this function:

void setStyle ( int32_t  val)
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setSubviewState ( bool  state)
inherited

+ Here is the call graph for this function:

void setTag ( int32_t  val)
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setTextInset ( const CPoint p)
virtualinherited

+ Here is the call graph for this function:

void setTextRotation ( double  angle)
virtualinherited

Reimplemented in CTextEdit.

+ Here is the call graph for this function:

void setTransparency ( bool  val)
virtualinherited

set views transparent state

Reimplemented in CScrollView.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setValue ( float  val)
virtual

Reimplemented from CControl.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setValueNormalized ( float  val)
virtualinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setValueToStringProc ( CParamDisplayValueToStringProc  proc,
void *  userData = 0 
)
virtualinherited

deprecated use setValueToStringFunction instead if you use c++11

+ Here is the caller graph for this function:

void setViewSize ( const CRect newSize,
bool  doInvalid = true 
)
virtualinherited

set views size

Parameters
newSizerect of new size of view
invalidif true set view dirty

Reimplemented in CTextButton, CDataBrowser, CFrame, CViewContainer, CSegmentButton, CSlider, CScrollView, CKnob, CTabView, CTextEdit, CSplitView, CGradientView, CShadowViewContainer, CTextLabel, CVuMeter, COpenGLView, CLayeredViewContainer, CScrollbar, and CAutoLayoutContainerView.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setVisible ( bool  state)
virtualinherited

set visibility state

Reimplemented in COpenGLView.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setWantsFocus ( bool  state)
virtualinherited

set focus support on/off

Reimplemented in CDataBrowser.

+ Here is the caller graph for this function:

void setWantsIdle ( bool  state)
inherited

enable/disable onIdle() callback

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void setWheelInc ( float  val)
inlinevirtualinherited

+ Here is the caller graph for this function:

void takeFocus ( )
virtual

called if view should take focus

Reimplemented from CView.

+ Here is the call graph for this function:

T& translateToGlobal ( T &  t) const
inlineinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

T translateToGlobal ( const T &  t) const
inlineinherited

translates a local coordinate to a global one using parent transforms

+ Here is the call graph for this function:

T& translateToLocal ( T &  t) const
inlineinherited

translates a local coordinate to a global one using parent transforms

+ Here is the call graph for this function:

T translateToLocal ( const T &  t) const
inlineinherited

translates a global coordinate to a local one using parent transforms

+ Here is the call graph for this function:

void unregisterControlListener ( IControlListener listener)
inherited

unregister a sub listener

+ Here is the call graph for this function:

void unregisterViewListener ( IViewListener listener)
inherited

+ Here is the call graph for this function:

void valueChanged ( )
virtualinherited

notifies listener and dependent objects

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual bool wantsFocus ( ) const
inlinevirtualinherited

check if view supports focus

Reimplemented in CTextEdit.

+ Here is the caller graph for this function:

bool wantsIdle ( ) const
inlineinherited

returns if the view wants idle callback or not

+ Here is the caller graph for this function:

Member Data Documentation

float alphaValue
protectedinherited
int32_t autosizeFlags
protectedinherited
CColor backColor
protectedinherited
CPoint backOffset
protectedinherited
bool bAntialias
protectedinherited
CBitmap* bgWhenClick
protected
int32_t currentIndex
protected
float defaultValue
protectedinherited
int32_t deferChangeCount
protectedinherited
DeferedChangesSet deferedChanges
protectedinherited
DependentList dependents
protectedinherited
int32_t editing
protectedinherited
CColor fontColor
protectedinherited
CFontRef fontID
protectedinherited
CColor frameColor
protectedinherited
CCoord frameWidth
protectedinherited
CHoriTxtAlign horiTxtAlign
protectedinherited
uint32_t idleRate
staticinherited

global idle rate in Hz, defaults to 30 Hz

bool inPopup
protected
int32_t kDefaultValueModifier = kControl
staticinherited

default value modifier key, per default is the control key

bool kDirtyCallAlwaysOnMainThread = false
staticinherited

if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false.

IdStringPtr kMessageBeginEdit = "kMessageBeginEdit"
staticinherited
IdStringPtr kMessageEndEdit = "kMessageEndEdit"
staticinherited
IdStringPtr kMessageTagDidChange = "kMessageTagDidChange"
staticinherited
IdStringPtr kMessageTagWillChange = "kMessageTagWillChange"
staticinherited
IdStringPtr kMessageValueChanged = "kMessageValueChanged"
staticinherited
IdStringPtr kMsgBeforePopup = "kMsgBeforePopup"
static
int32_t kZoomModifier = kShift
staticinherited

zoom modifier key, per default is the shift key

CButtonState lastButton
protected
COptionMenu* lastMenu
protected
int32_t lastResult
protected
IControlListener* listener
protectedinherited
CMenuItemList* menuItems
protected
CRect mouseableArea
protectedinherited
int32_t nbItemsPerColumn
protected
float oldValue
protectedinherited
CFrame* pParentFrame
protectedinherited
CView* pParentView
protectedinherited
int32_t prefixNumbers
protected
CCoord roundRectRadius
protectedinherited
CColor shadowColor
protectedinherited
CRect size
protectedinherited
int32_t style
protectedinherited
SubListenerDispatcher subListeners
protectedinherited
int32_t tag
protectedinherited
CPoint textInset
protectedinherited
double textRotation
protectedinherited
float value
protectedinherited
uint8_t valuePrecision
protectedinherited
CParamDisplayValueToStringProc valueToString
protectedinherited
void* valueToStringUserData
protectedinherited
int32_t viewFlags
protectedinherited
float vmax
protectedinherited
float vmin
protectedinherited
float wheelInc
protectedinherited

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