VSTGUI  4.10
Graphical User Interface Framework not only for VST plugins
CTextButton Class Reference

a button which renders without bitmaps More...

+ Inheritance diagram for CTextButton:

Public Types

enum  Style { kKickStyle = 0, kOnOffStyle }
 CTextButton style. More...
 
- Public Types inherited from CControl
using CheckDefaultValueFuncT = bool(*)(CControl *, CButtonState)
 
- Public Types inherited from CView
enum  MouseListenerCall { MouseDown, MouseMoved, MouseUp, MouseCancel }
 

Public Member Functions

 CTextButton (const CRect &size, IControlListener *listener=nullptr, int32_t tag=-1, UTF8StringPtr title=nullptr, Style=kKickStyle)
 
void draw (CDrawContext *context) override
 called if the view should draw itself More...
 
bool getFocusPath (CGraphicsPath &outPath) override
 the graphics path will be drawn filled with the evenodd method and the color set in CFrame::setFocusColor() More...
 
bool drawFocusOnTop () override
 draw focus before view will be drawn or afterwards More...
 
void setViewSize (const CRect &rect, bool invalid=true) override
 set views size More...
 
bool removed (CView *parent) override
 view is removed from parent view More...
 
bool sizeToFit () override
 resize view to optimal size More...
 
CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 called when a mouse down event occurs More...
 
CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons) override
 called when a mouse up event occurs More...
 
CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons) override
 called when a mouse move event occurs More...
 
CMouseEventResult onMouseCancel () override
 called when mouse tracking should be canceled More...
 
int32_t onKeyDown (VstKeyCode &keyCode) override
 called if a key down event occurs and this view has focus More...
 
int32_t onKeyUp (VstKeyCode &keyCode) override
 called if a key up event occurs and this view has focus More...
 
CBaseObjectnewCopy () const override
 
CTextButton Methods
virtual void setTitle (const UTF8String &newTitle)
 
const UTF8StringgetTitle () const
 
virtual void setFont (CFontRef newFont)
 
CFontRef getFont () const
 
virtual void setTextColor (const CColor &color)
 
const CColorgetTextColor () const
 
virtual void setTextColorHighlighted (const CColor &color)
 
const CColorgetTextColorHighlighted () const
 
virtual void setGradient (CGradient *gradient)
 
CGradientgetGradient () const
 
virtual void setGradientHighlighted (CGradient *gradient)
 
CGradientgetGradientHighlighted () const
 
virtual void setFrameColor (const CColor &color)
 
const CColorgetFrameColor () const
 
virtual void setFrameColorHighlighted (const CColor &color)
 
const CColorgetFrameColorHighlighted () const
 
virtual void setFrameWidth (CCoord width)
 
CCoord getFrameWidth () const
 
virtual void setRoundRadius (CCoord radius)
 
CCoord getRoundRadius () const
 
virtual void setStyle (Style style)
 
Style getStyle () const
 
virtual void setIcon (CBitmap *bitmap)
 
CBitmapgetIcon () const
 
virtual void setIconHighlighted (CBitmap *bitmap)
 
CBitmapgetIconHighlighted () const
 
virtual void setIconPosition (CDrawMethods::IconPosition pos)
 
CDrawMethods::IconPosition getIconPosition () const
 
virtual void setTextMargin (CCoord margin)
 
CCoord getTextMargin () const
 
virtual void setTextAlignment (CHoriTxtAlign hAlign)
 
CHoriTxtAlign getTextAlignment () const
 
- Public Member Functions inherited from CControl
 CControl (const CRect &size, IControlListener *listener=nullptr, int32_t tag=0, CBitmap *pBackground=nullptr)
 
 CControl (const CControl &c)
 
bool isDirty () const override
 check if view is dirty More...
 
void setDirty (bool val=true) override
 set the view to dirty so that it is redrawn in the next idle. More...
 
bool drawFocusOnTop () override
 draw focus before view will be drawn or afterwards More...
 
bool getFocusPath (CGraphicsPath &outPath) override
 the graphics path will be drawn filled with the evenodd method and the color set in CFrame::setFocusColor() More...
 
virtual void setValue (float val)
 
virtual float getValue () const
 
virtual void setValueNormalized (float val)
 
virtual float getValueNormalized () const
 
virtual void setMin (float val)
 
virtual float getMin () const
 
virtual void setMax (float val)
 
virtual float getMax () const
 
float getRange () const
 
virtual void setOldValue (float val)
 
virtual float getOldValue () const
 
virtual void setDefaultValue (float val)
 
virtual float getDefaultValue () const
 
virtual void bounceValue ()
 
virtual bool checkDefaultValue (CButtonState button)
 
virtual void valueChanged ()
 notifies listener and dependent objects More...
 
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...
 
virtual void setWheelInc (float val)
 
virtual float getWheelInc () const
 
- Public Member Functions inherited from CView
 CView (const CRect &size)
 
 CView (const CView &view)
 
void setSubviewState (bool state)
 
bool isSubview () const
 
virtual bool wantsWindowActiveStateChangeNotification () const
 whether this view wants to be informed if the window's active state changes More...
 
virtual void onWindowActivate (bool state)
 called when the active state of the window changes More...
 
void setTooltipText (UTF8StringPtr text)
 
virtual CViewContainerasViewContainer ()
 
virtual const CViewContainerasViewContainer () const
 
CMouseEventResult callMouseListener (MouseListenerCall type, CPoint pos, CButtonState buttons)
 
void callMouseListenerEnteredExited (bool mouseEntered)
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message) override
 
void beforeDelete () override
 
CBaseObjectnewCopy () const override
 
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) final
 
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...
 
bool getMouseEnabled () const
 get the state of wheather this view uses the mouse or not More...
 
void setMouseableArea (const CRect &rect)
 set the area in which the view reacts to the mouse More...
 
CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse More...
 
CRect getMouseableArea () const
 get the area in which the view reacts to the mouse More...
 
bool doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})
 start a drag operation More...
 
virtual SharedPointer< IDropTargetgetDropTarget ()
 get the drag target for drag and drop handling More...
 
void setDropTarget (const SharedPointer< IDropTarget > &dt)
 set a custom drop target More...
 
DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
 a drag can only be started from within onMouseDown More...
 
CCoord getHeight () const
 get the height of the view More...
 
CCoord getWidth () const
 get the width of the view 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...
 
int32_t getAutosizeFlags () const
 get autosize flags More...
 
virtual void looseFocus ()
 called if view should loose focus More...
 
virtual void takeFocus ()
 called if view should take focus More...
 
virtual bool wantsFocus () const
 check if view supports focus More...
 
virtual void setWantsFocus (bool state)
 set focus support on/off More...
 
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...
 
template<typename T >
bool setAttribute (const CViewAttributeID id, const T &data)
 set an attribute More...
 
template<typename T >
bool getAttribute (const CViewAttributeID id, T &data) const
 get an attribute More...
 
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
 get the bitmap which is drawn depending on the enabled state. More...
 
virtual void setTransparency (bool val)
 set views transparent state More...
 
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...
 
virtual bool attached (CView *parent)
 view is attached to a parent view More...
 
bool isAttached () const
 is view attached to a parentView More...
 
CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () const
 get frame More...
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor More...
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject)
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, const Animation::DoneFunction &doneFunc=nullptr)
 
void removeAnimation (IdStringPtr name)
 
void removeAllAnimations ()
 
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
void registerViewMouseListener (IViewMouseListener *listener)
 
void unregisterViewMouseListener (IViewMouseListener *listener)
 
CGraphicsTransform getGlobalTransform (bool ignoreFrame=false) const
 get the active global transform for this view More...
 
template<typename T >
T & translateToGlobal (T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
translateToGlobal (const T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
T & translateToLocal (T &t, bool ignoreFrame=false) const
 translates a global coordinate to a local one using parent transforms More...
 
template<typename T >
translateToLocal (const T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms 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...
 
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...
 
- Public Member Functions inherited from CBaseObject
 CBaseObject ()=default
 
 ~CBaseObject () noexcept override=default
 
 CBaseObject (const CBaseObject &o)
 
CBaseObjectoperator= (const CBaseObject &obj)
 
- Public Member Functions inherited from ReferenceCounted< T >
 ReferenceCounted ()=default
 
virtual ~ReferenceCounted () noexcept=default
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0 More...
 
void remember () override
 increase refcount More...
 
virtual int32_t getNbReference () const
 get refcount More...
 
- Public Member Functions inherited from IFocusDrawing
virtual ~IFocusDrawing () noexcept=default
 

Protected Member Functions

 ~CTextButton () noexcept override=default
 
void invalidPath ()
 
CGraphicsPathgetPath (CDrawContext *context, CCoord lineWidth)
 
- Protected Member Functions inherited from CControl
 ~CControl () noexcept override
 
- Protected Member Functions inherited from CView
 ~CView () noexcept override
 
CGraphicsPathgetHitTestPath () const
 
bool hasViewFlag (int32_t bit) const
 
void setViewFlag (int32_t bit, bool state)
 
void setAlphaValueNoInvalidate (float value)
 
void setParentFrame (CFrame *frame)
 
void setParentView (CView *parent)
 

Protected Attributes

SharedPointer< CFontDescfont
 
SharedPointer< CGraphicsPath_path
 
SharedPointer< CBitmapicon
 
SharedPointer< CBitmapiconHighlighted
 
SharedPointer< CGradientgradient
 
SharedPointer< CGradientgradientHighlighted
 
CColor textColor
 
CColor frameColor
 
CColor textColorHighlighted
 
CColor frameColorHighlighted
 
CCoord frameWidth
 
CCoord roundRadius
 
CCoord textMargin
 
CHoriTxtAlign horiTxtAlign
 
CDrawMethods::IconPosition iconPosition
 
Style style
 
UTF8String title
 
- Protected Attributes inherited from CControl
IControlListenerlistener
 
int32_t tag
 
float value
 

Additional Inherited Members

- Static Public Attributes inherited from CControl
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 CheckDefaultValueFuncT CheckDefaultValueFunc
 Function to check if the button state is the state to set the control value to its default value. More...
 
- Static Public Attributes inherited from CView
static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle. More...
 
static uint32_t idleRate
 global idle rate in Hz, defaults to 30 Hz More...
 
- Protected Types inherited from CView
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,
  kHasAlpha = 1 << 8, kHasBackground = 1 << 9, kHasDisabledBackground = 1 << 10, kHasMouseableArea = 1 << 11,
  kLastCViewFlag = 11
}
 
- Static Protected Member Functions inherited from CControl
static int32_t mapVstKeyModifier (int32_t vstModifier)
 

Detailed Description

a button which renders without bitmaps

Member Enumeration Documentation

◆ Style

enum Style

CTextButton style.

Enumerator
kKickStyle 
kOnOffStyle 

Constructor & Destructor Documentation

◆ CTextButton()

CTextButton ( const CRect size,
IControlListener listener = nullptr,
int32_t  tag = -1,
UTF8StringPtr  title = nullptr,
Style  style = kKickStyle 
)

◆ ~CTextButton()

~CTextButton ( )
overrideprotecteddefaultnoexcept

Member Function Documentation

◆ draw()

void draw ( CDrawContext pContext)
overridevirtual

called if the view should draw itself

Parameters
pContextdraw context in which to draw

Implements CControl.

◆ drawFocusOnTop()

bool drawFocusOnTop ( )
overridevirtual

draw focus before view will be drawn or afterwards

Implements IFocusDrawing.

◆ getFocusPath()

bool getFocusPath ( CGraphicsPath outPath)
overridevirtual

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

Implements IFocusDrawing.

◆ getFont()

CFontRef getFont ( ) const
inline

◆ getFrameColor()

const CColor& getFrameColor ( ) const
inline

◆ getFrameColorHighlighted()

const CColor& getFrameColorHighlighted ( ) const
inline

◆ getFrameWidth()

CCoord getFrameWidth ( ) const
inline

◆ getGradient()

CGradient * getGradient ( ) const

◆ getGradientHighlighted()

CGradient * getGradientHighlighted ( ) const

◆ getIcon()

CBitmap * getIcon ( ) const

◆ getIconHighlighted()

CBitmap * getIconHighlighted ( ) const

◆ getIconPosition()

CDrawMethods::IconPosition getIconPosition ( ) const
inline

◆ getPath()

CGraphicsPath * getPath ( CDrawContext context,
CCoord  lineWidth 
)
protected

◆ getRoundRadius()

CCoord getRoundRadius ( ) const
inline

◆ getStyle()

Style getStyle ( ) const
inline

◆ getTextAlignment()

CHoriTxtAlign getTextAlignment ( ) const
inline

◆ getTextColor()

const CColor& getTextColor ( ) const
inline

◆ getTextColorHighlighted()

const CColor& getTextColorHighlighted ( ) const
inline

◆ getTextMargin()

CCoord getTextMargin ( ) const
inline

◆ getTitle()

const UTF8String& getTitle ( ) const
inline

◆ invalidPath()

void invalidPath ( )
protected

◆ newCopy()

CBaseObject* newCopy ( ) const
inlineoverridevirtual

Implements CControl.

◆ onKeyDown()

int32_t onKeyDown ( VstKeyCode keyCode)
overridevirtual

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.

◆ onKeyUp()

int32_t onKeyUp ( VstKeyCode keyCode)
overridevirtual

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

◆ onMouseCancel()

CMouseEventResult onMouseCancel ( )
overridevirtual

called when mouse tracking should be canceled

Reimplemented from CView.

◆ onMouseDown()

CMouseEventResult onMouseDown ( CPoint where,
const CButtonState buttons 
)
overridevirtual

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.

◆ onMouseMoved()

CMouseEventResult onMouseMoved ( CPoint where,
const CButtonState buttons 
)
overridevirtual

called when a mouse move event occurs

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

Reimplemented from CView.

◆ onMouseUp()

CMouseEventResult onMouseUp ( CPoint where,
const CButtonState buttons 
)
overridevirtual

called when a mouse up event occurs

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

Reimplemented from CView.

◆ removed()

bool removed ( CView parent)
overridevirtual

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented from CView.

◆ setFont()

void setFont ( CFontRef  newFont)
virtual

◆ setFrameColor()

void setFrameColor ( const CColor color)
virtual

◆ setFrameColorHighlighted()

void setFrameColorHighlighted ( const CColor color)
virtual

◆ setFrameWidth()

void setFrameWidth ( CCoord  width)
virtual

◆ setGradient()

void setGradient ( CGradient gradient)
virtual

◆ setGradientHighlighted()

void setGradientHighlighted ( CGradient gradient)
virtual

◆ setIcon()

void setIcon ( CBitmap bitmap)
virtual

◆ setIconHighlighted()

void setIconHighlighted ( CBitmap bitmap)
virtual

◆ setIconPosition()

void setIconPosition ( CDrawMethods::IconPosition  pos)
virtual

◆ setRoundRadius()

void setRoundRadius ( CCoord  radius)
virtual

◆ setStyle()

void setStyle ( Style  style)
virtual

◆ setTextAlignment()

void setTextAlignment ( CHoriTxtAlign  hAlign)
virtual

◆ setTextColor()

void setTextColor ( const CColor color)
virtual

◆ setTextColorHighlighted()

void setTextColorHighlighted ( const CColor color)
virtual

◆ setTextMargin()

void setTextMargin ( CCoord  margin)
virtual

◆ setTitle()

void setTitle ( const UTF8String newTitle)
virtual

◆ setViewSize()

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

set views size

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

Reimplemented from CView.

◆ sizeToFit()

bool sizeToFit ( )
overridevirtual

resize view to optimal size

Reimplemented from CView.

Member Data Documentation

◆ _path

SharedPointer<CGraphicsPath> _path
protected

◆ font

SharedPointer<CFontDesc> font
protected

◆ frameColor

CColor frameColor
protected

◆ frameColorHighlighted

CColor frameColorHighlighted
protected

◆ frameWidth

CCoord frameWidth
protected

◆ gradient

SharedPointer<CGradient> gradient
protected

◆ gradientHighlighted

SharedPointer<CGradient> gradientHighlighted
protected

◆ horiTxtAlign

CHoriTxtAlign horiTxtAlign
protected

◆ icon

SharedPointer<CBitmap> icon
protected

◆ iconHighlighted

SharedPointer<CBitmap> iconHighlighted
protected

◆ iconPosition

CDrawMethods::IconPosition iconPosition
protected

◆ roundRadius

CCoord roundRadius
protected

◆ style

Style style
protected

◆ textColor

CColor textColor
protected

◆ textColorHighlighted

CColor textColorHighlighted
protected

◆ textMargin

CCoord textMargin
protected

◆ title

UTF8String title
protected

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