|
VSTGUI
3.6
|
a popup menu control More...
#include <vstcontrols.h>
Inheritance diagram for COptionMenu:Public Member Functions | |
| virtual | ~COptionMenu () |
| virtual void | setValue (float val) |
| virtual void | draw (CDrawContext *pContext) |
| called if the view should draw itself More... | |
| virtual void | mouse (CDrawContext *pContext, CPoint &where, long button=-1) |
| virtual CMouseEventResult | onMouseDown (CPoint &where, const long &buttons) |
| called when a mouse down event occurs More... | |
| virtual void | takeFocus () |
| called if view should take focus More... | |
| virtual void | looseFocus () |
| called if view should loose focus More... | |
| virtual bool | isTypeOf (const char *s) const |
| virtual CView * | newCopy () const |
| 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 More... | |
| void | setDirty (const bool val=true) |
| set the view to dirty so that it is redrawn in the next idle. Thread Safe ! More... | |
| bool | isDoubleClick () |
| virtual void | setBackground (CBitmap *background) |
| set the background image of this view More... | |
| virtual CBitmap * | getBackground () const |
| get the background image of this view More... | |
| virtual void | setTransparency (bool val) |
| set views transparent state More... | |
| virtual bool | getTransparency () const |
| get views transparent state More... | |
| virtual bool | removed (CView *parent) |
| view is removed from parent view More... | |
| virtual bool | attached (CView *parent) |
| view is attached to a parent view More... | |
| bool | isAttached () const |
| is view attached to a parentView More... | |
| CMessageResult | notify (CBaseObject *sender, const char *message) |
| virtual void | getMouseLocation (CDrawContext *context, CPoint &point) |
| virtual void | setParentView (CView *pParentView) |
| virtual void | setFrame (CFrame *pParent) |
| virtual void | getFrameTopLeftPos (CPoint &topLeft) const |
Protected Member Functions | |
| COptionMenu * | getItemMenu (long idx, long &idxInMenu, long &offsetIdx) |
| void | removeItems () |
| void * | appendItems (long &offsetIdx) |
| virtual void | drawText (CDrawContext *pContext, const char *string, CBitmap *newBack=0) |
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 CControlListener * | getListener () const |
| virtual void | setListener (CControlListener *l) |
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 |
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 CMenuItem * | addEntry (CMenuItem *item, long index=-1) |
| add a new entry More... | |
| virtual CMenuItem * | addEntry (COptionMenu *submenu, const char *title) |
| add a new submenu entry More... | |
| virtual CMenuItem * | addEntry (const char *title, long index=-1, long itemFlags=CMenuItem::kNoFlags) |
| add a new entry More... | |
| virtual CMenuItem * | addSeparator () |
| add a new separator entry More... | |
| virtual CMenuItem * | getCurrent () const |
| get current entry More... | |
| virtual long | getCurrentIndex (bool countSeparator=false) const |
| virtual CMenuItem * | getEntry (long index) const |
| get entry at index position More... | |
| virtual long | getNbEntries () const |
| get number of entries More... | |
| virtual bool | setCurrent (long index, bool countSeparator=true) |
| set current entry More... | |
| virtual bool | removeEntry (long index) |
| remove an entry More... | |
| virtual bool | removeAllEntry () |
| remove all entries More... | |
| virtual bool | checkEntry (long index, bool state) |
| change check state of entry at index More... | |
| virtual bool | checkEntryAlone (long index) |
| check entry at index and uncheck every other item More... | |
| virtual bool | isCheckEntry (long index) const |
| get check state of entry at index More... | |
| virtual void | setNbItemsPerColumn (long val) |
| Windows only. More... | |
| virtual long | getNbItemsPerColumn () const |
| Windows only. More... | |
| long | getLastResult () const |
| get last index of choosen entry More... | |
| COptionMenu * | getLastItemMenu (long &idxInMenu) const |
| get last menu and index of choosen entry More... | |
| void | setScheme (COptionMenuScheme *s) |
| set menu scheme More... | |
| virtual COptionMenuScheme * | getScheme () const |
| get menu scheme More... | |
| virtual void | setPrefixNumbers (long preCount) |
| set prefix numbering More... | |
| long | getPrefixNumbers () const |
| get prefix numbering More... | |
| COptionMenu * | getSubMenu (long idx) const |
| get a submenu More... | |
Reference Counting Methods | |
| virtual void | forget () |
| decrease refcount and delete object if refcount == 0 More... | |
| virtual void | remember () |
| increase refcount More... | |
| long | getNbReference () const |
| get refcount More... | |
Draw and Update Methods | |
| 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... | |
Mouse Methods | |
| virtual CMouseEventResult | onMouseUp (CPoint &where, const long &buttons) |
| called when a mouse up event occurs More... | |
| virtual CMouseEventResult | onMouseMoved (CPoint &where, const long &buttons) |
| called when a mouse move event occurs More... | |
| virtual CMouseEventResult | onMouseEntered (CPoint &where, const long &buttons) |
| called when the mouse enters this view More... | |
| virtual CMouseEventResult | onMouseExited (CPoint &where, const long &buttons) |
| called when the mouse leaves this view More... | |
| virtual bool | hitTest (const CPoint &where, const long buttons=-1) |
| check if where hits this view More... | |
| virtual bool | onWheel (const CPoint &where, const float &distance, const long &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 long &buttons) |
| called if a mouse wheel event is happening over this view More... | |
| virtual void | setMouseEnabled (const 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 CRect & | getMouseableArea (CRect &rect) const |
| get the area in which the view reacts to the mouse More... | |
| virtual const CRect & | getMouseableArea () const |
| read only access to the mouseable area More... | |
Drag & Drop Methods | |
| virtual bool | onDrop (CDragContainer *drag, const CPoint &where) |
| called if a drag is dropped onto this view More... | |
| virtual void | onDragEnter (CDragContainer *drag, const CPoint &where) |
| called if a drag is entering this view More... | |
| virtual void | onDragLeave (CDragContainer *drag, const CPoint &where) |
| called if a drag is leaving this view More... | |
| virtual void | onDragMove (CDragContainer *drag, const CPoint &where) |
| called if a drag is moved inside this view More... | |
Keyboard Methods | |
| virtual long | onKeyDown (VstKeyCode &keyCode) |
| called if a key down event occurs and this view has focus More... | |
| virtual long | 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 (CRect &rect, bool invalid=true) |
| set views size More... | |
| virtual CRect & | getViewSize (CRect &rect) const |
| returns the current view size More... | |
| virtual const CRect & | getViewSize () const |
| read only access to view size More... | |
| virtual CRect | getVisibleSize () 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 CPoint & | frameToLocal (CPoint &point) const |
| conversion from frame coordinates to local view coordinates More... | |
| virtual CPoint & | localToFrame (CPoint &point) const |
| conversion from local view coordinates to frame coordinates More... | |
| virtual void | setAutosizeFlags (long flags) |
| set autosize flags More... | |
| virtual long | getAutosizeFlags () const |
| get autosize flags 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, long &outSize) const |
| get the size of an attribute More... | |
| bool | getAttribute (const CViewAttributeID id, const long inSize, void *outData, long &outSize) const |
| get an attribute More... | |
| bool | setAttribute (const CViewAttributeID id, const long inSize, const void *inData) |
| set an attribute More... | |
| bool | removeAttribute (const CViewAttributeID id) |
| remove an attribute More... | |
Parent Methods | |
| CView * | getParentView () const |
| get parent view More... | |
| CFrame * | getFrame () const |
| get frame More... | |
| virtual VSTGUIEditorInterface * | getEditor () const |
| get editor More... | |
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.
| COptionMenu | ( | const CRect & | size, |
| CControlListener * | listener, | ||
| long | tag, | ||
| CBitmap * | background = 0, |
||
| CBitmap * | bgWhenClick = 0, |
||
| const long | style = 0 |
||
| ) |
COptionMenu constructor.
| 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 | ) |
|
virtual |
add a new entry
| item | menu item to add. Takes ownership of item. |
| index | position of insertation. -1 appends the item |
|
virtual |
add a new submenu entry
|
virtual |
add a new entry
|
virtual |
add a new separator entry
|
protected |
|
virtualinherited |
view is attached to a parent view
| parent | parent view |
Reimplemented in CViewContainer, CVuMeter, and CDataBrowser.
|
virtualinherited |
|
virtualinherited |
|
virtualinherited |
|
virtual |
change check state of entry at index
|
virtual |
check entry at index and uncheck every other item
|
inlinevirtualinherited |
|
virtualinherited |
|
inlinevirtualinherited |
|
virtual |
called if the view should draw itself
| pContext | draw context in which to draw |
Reimplemented from CParamDisplay.
|
inlinevirtualinherited |
called if the view should draw itself
Reimplemented in CFrame, and CViewContainer.
|
protectedvirtualinherited |
|
virtualinherited |
|
inlinevirtualinherited |
decrease refcount and delete object if refcount == 0
Reimplemented in CDrawContext.
conversion from frame coordinates to local view coordinates
| point | location |
Reimplemented in CViewContainer.
|
inlineinherited |
|
inherited |
get an attribute
| 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 |
|
inherited |
get the size of an attribute
| id | the ID of the Attribute |
| outSize | on return the size of the attribute |
|
inlinevirtualinherited |
get autosize flags
|
inlineinherited |
|
inlinevirtualinherited |
get the background image of this view
|
virtual |
get current entry
|
virtual |
|
inlinevirtualinherited |
|
virtualinherited |
get editor
Reimplemented in CFrame.
|
virtual |
get entry at index position
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
get frame
|
inlineinherited |
|
virtualinherited |
|
inlineinherited |
get the height of the view
|
inlineinherited |
|
protected |
| COptionMenu * getLastItemMenu | ( | long & | idxInMenu | ) | const |
get last menu and index of choosen entry
|
inline |
get last index of choosen entry
|
inlinevirtualinherited |
|
inlinevirtualinherited |
|
inlinevirtualinherited |
get the area in which the view reacts to the mouse
|
inlinevirtualinherited |
read only access to the mouseable area
|
inlinevirtualinherited |
get the state of wheather this view uses the mouse or not
|
virtualinherited |
|
virtual |
get number of entries
|
inlinevirtual |
Windows only.
|
inlineinherited |
get refcount
|
inlinevirtualinherited |
|
inlineinherited |
get parent view
|
inline |
get prefix numbering
|
inlinevirtual |
get menu scheme
|
inlineinherited |
|
inlineinherited |
| COptionMenu * getSubMenu | ( | long | idx | ) | const |
get a submenu
|
inlinevirtualinherited |
|
inlineinherited |
|
inlinevirtualinherited |
get views transparent state
|
inlinevirtualinherited |
returns the current view size
|
inlinevirtualinherited |
read only access to view size
|
virtualinherited |
returns the visible size of the view
|
inlinevirtualinherited |
|
inlineinherited |
get the width of the view
|
inlinevirtualinherited |
check if where hits this view
Reimplemented in CViewContainer, and CSplashScreen.
|
inlinevirtualinherited |
mark whole view as invalid
Reimplemented in CFrame, and CViewContainer.
|
virtualinherited |
|
inlineinherited |
is view attached to a parentView
|
virtual |
get check state of entry at index
|
virtualinherited |
|
inherited |
|
inlinevirtual |
Reimplemented from CParamDisplay.
|
inlineinherited |
get visibility state
conversion from local view coordinates to frame coordinates
| point | location |
Reimplemented in CViewContainer.
|
virtual |
called if view should loose focus
Reimplemented from CView.
|
virtual |
Reimplemented from CView.
|
inlinevirtual |
Reimplemented from CParamDisplay.
|
virtualinherited |
| sender | message sender |
| message | message text |
Reimplemented from CBaseObject.
Reimplemented in CViewContainer.
|
inlinevirtualinherited |
called if a drag is entering this view
Reimplemented in CViewContainer.
|
inlinevirtualinherited |
called if a drag is leaving this view
Reimplemented in CViewContainer.
|
inlinevirtualinherited |
called if a drag is moved inside this view
Reimplemented in CViewContainer.
|
inlinevirtualinherited |
called if a drag is dropped onto this view
Reimplemented in CViewContainer.
|
virtualinherited |
called if a key down event occurs and this view has focus
| keyCode | key code of pressed key |
Reimplemented in CFrame, CViewContainer, CSlider, and CKnob.
|
virtualinherited |
called if a key up event occurs and this view has focus
| keyCode | key code of pressed key |
Reimplemented in CFrame, and CViewContainer.
|
virtual |
called when a mouse down event occurs
| where | mouse location of mouse down |
| buttons | button and modifier state |
Reimplemented from CView.
|
inlinevirtualinherited |
called when the mouse enters this view
|
inlinevirtualinherited |
called when the mouse leaves this view
Reimplemented in CFrame.
|
virtualinherited |
called when a mouse move event occurs
| where | mouse location of mouse move |
| buttons | button and modifier state |
Reimplemented in CFrame, CViewContainer, CKickButton, CSlider, CMovieButton, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CKnob, and CScrollbar.
|
virtualinherited |
called when a mouse up event occurs
| where | mouse location of mouse up |
| buttons | button and modifier state |
Reimplemented in CFrame, CViewContainer, CKickButton, CSlider, CMovieButton, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CKnob, and CScrollbar.
|
virtualinherited |
called if a mouse wheel event is happening over this view
| where | location |
| distance | wheel distance |
| buttons | button and modifier state |
Reimplemented in CFrame, CViewContainer, CSlider, CRockerSwitch, and CKnob.
|
virtualinherited |
called if a mouse wheel event is happening over this view
| where | location |
| axis | mouse wheel axis |
| distance | wheel distance |
| buttons | button and modifier state |
Reimplemented in CFrame, CViewContainer, CScrollbar, and CScrollView.
|
inlinevirtualinherited |
notification that one of the views parent has changed its size
Reimplemented in CViewContainer, and CTextEdit.
|
inlinevirtualinherited |
increase refcount
|
virtual |
remove all entries
|
inherited |
remove an attribute
|
virtualinherited |
view is removed from parent view
| parent | parent view |
Reimplemented in CViewContainer, and CVuMeter.
|
virtual |
remove an entry
|
protected |
|
inlinevirtualinherited |
|
inherited |
set an attribute
copies data into the attribute. If it does not exist, creates a new attribute.
| id | the ID of the Attribute |
| inSize | the size of the outData pointer |
| inData | a pointer to the data |
|
inlinevirtualinherited |
set autosize flags
|
virtualinherited |
|
virtualinherited |
set the background image of this view
| background | new background bitmap |
|
virtualinherited |
|
virtual |
set current entry
|
inlinevirtualinherited |
|
virtualinherited |
|
virtualinherited |
|
virtualinherited |
|
inlinevirtualinherited |
|
virtualinherited |
|
virtualinherited |
|
inlinevirtualinherited |
|
inlinevirtualinherited |
|
inlinevirtualinherited |
|
inlinevirtualinherited |
set the area in which the view reacts to the mouse
|
inlinevirtualinherited |
turn on/off mouse usage for this view
|
inlinevirtual |
Windows only.
|
inlinevirtualinherited |
|
inlinevirtualinherited |
|
virtual |
set prefix numbering
|
inline |
set menu scheme
|
virtualinherited |
|
virtualinherited |
|
virtualinherited |
|
virtualinherited |
|
virtualinherited |
|
inlinevirtualinherited |
|
inlinevirtualinherited |
|
inlinevirtualinherited |
set views transparent state
Reimplemented in CScrollView.
|
virtual |
Reimplemented from CControl.
|
virtualinherited |
set views size
| newSize | rect of new size of view |
| invalid | if true set view dirty |
Reimplemented in CFrame, CViewContainer, CSlider, CTextEdit, CScrollbar, CScrollView, and CTabView.
|
virtualinherited |
set visibility state
|
inlinevirtualinherited |
set focus support on/off
|
inlinevirtualinherited |
|
virtual |
called if view should take focus
Reimplemented from CView.
|
inlinevirtualinherited |
check if view supports focus
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protected |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protectedinherited |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
1.8.7