Control which draws a segmented button. More...

Inheritance diagram for CSegmentButton:

Classes
struct	Segment

Public Types
enum	Style { kHorizontal, kVertical, kHorizontalInverse, kVerticalInverse }

enum	SelectionMode { kSingle, kSingleToggle, kMultiple }

using	Segments = std::vector< Segment >

Public Types inherited from CControl
using	CheckDefaultValueFuncT = bool()(CControl , CButtonState)

Public Types inherited from CView
enum	MouseListenerCall { MouseDown, MouseMoved, MouseUp, MouseCancel }

Public Member Functions
	CSegmentButton (const CRect &size, IControlListener *listener=nullptr, int32_t tag=-1)

bool	attached (CView *parent) override
	view is attached to a parent view More...

void	setViewSize (const CRect &rect, bool invalid=true) override
	set views size More...

CMouseEventResult	onMouseDown (CPoint &where, const CButtonState &buttons) override
	called when a mouse down event occurs More...

int32_t	onKeyDown (VstKeyCode &keyCode) override
	called if a key down event occurs and this view has focus More...

void	draw (CDrawContext *pContext) override
	called if the view should draw itself More...

void	drawRect (CDrawContext *pContext, const CRect &dirtyRect) override
	called if the view should draw itself 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...

void	valueChanged () override
	notifies listener and dependent objects More...

CBaseObject *	newCopy () const override

Segment Methods
bool	addSegment (const Segment &segment, uint32_t index=kPushBack)

bool	addSegment (Segment &&segment, uint32_t index=kPushBack)

void	removeSegment (uint32_t index)

void	removeAllSegments ()

const Segments &	getSegments () const

void	setSelectedSegment (uint32_t index)
	set the selected segment in single selection mode More...

uint32_t	getSelectedSegment () const
	get the selected segment in single selection mode More...

void	selectSegment (uint32_t index, bool state)
	set selection state for a segment in multiple selection mode More...

bool	isSegmentSelected (uint32_t index) const
	get selection state for a segment in multiple selection mode More...

CSegmentButton Style Methods
void	setStyle (Style newStyle)

Style	getStyle () const

void	setSelectionMode (SelectionMode mode)

SelectionMode	getSelectionMode () const

void	setTextTruncateMode (CDrawMethods::TextTruncateMode mode)

CDrawMethods::TextTruncateMode	getTextTruncateMode () const

void	setGradient (CGradient *newGradient)

CGradient *	getGradient () const

void	setGradientHighlighted (CGradient *newGradient)

CGradient *	getGradientHighlighted () const

void	setRoundRadius (CCoord newRoundRadius)

CCoord	getRoundRadius () const

void	setFont (CFontRef font)

CFontRef	getFont () const

void	setTextAlignment (CHoriTxtAlign alignment)

CHoriTxtAlign	getTextAlignment () const

void	setTextMargin (CCoord newMargin)

CCoord	getTextMargin () const

void	setTextColor (CColor newColor)

CColor	getTextColor () const

void	setTextColorHighlighted (CColor newColor)

CColor	getTextColorHighlighted () const

void	setFrameColor (CColor newColor)

CColor	getFrameColor () const

void	setFrameWidth (CCoord newWidth)

CCoord	getFrameWidth () 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...

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	setTag (int32_t val)

virtual int32_t	getTag () const

virtual void	beginEdit ()

virtual void	endEdit ()

bool	isEditing () const

virtual IControlListener *	getListener () 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 CViewContainer *	asViewContainer ()

virtual const CViewContainer *	asViewContainer () const

CMouseEventResult	callMouseListener (MouseListenerCall type, CPoint pos, CButtonState buttons)

void	callMouseListenerEnteredExited (bool mouseEntered)

CMessageResult	notify (CBaseObject *sender, IdStringPtr message) override

void	beforeDelete () override

CBaseObject *	newCopy () const override

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

CRect &	getMouseableArea (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< IDropTarget >	getDropTarget ()
	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...

virtual int32_t	onKeyUp (VstKeyCode &keyCode)
	called if a key up event occurs and this view has focus More...

CCoord	getHeight () const
	get the height of the view More...

CCoord	getWidth () const
	get the width of the view More...

const CRect &	getViewSize () 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 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 (int32_t flags)
	set autosize flags More...

int32_t	getAutosizeFlags () const
	get autosize flags More...

virtual bool	sizeToFit ()
	resize view to optimal size 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...

CBitmap *	getBackground () 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...

CBitmap *	getDisabledBackground () const
	get background image used when the mouse is not enabled More...

CBitmap *	getDrawBackground () 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	removed (CView *parent)
	view is removed from parent view More...

bool	isAttached () const
	is view attached to a parentView More...

CView *	getParentView () const
	get parent view More...

CFrame *	getFrame () const
	get frame More...

virtual VSTGUIEditorInterface *	getEditor () 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 >
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 >
T	translateToLocal (const T &t, bool ignoreFrame=false) const
	translates a local coordinate to a global one using parent transforms 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)

CBaseObject &	operator= (const CBaseObject &obj)

Public Member Functions inherited from ReferenceCounted< T >
	ReferenceCounted ()=default

virtual	~ReferenceCounted () noexcept=default

	ReferenceCounted (const ReferenceCounted &)

ReferenceCounted &	operator= (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

Static Public Member Functions
static bool	isHorizontalStyle (Style style)

static bool	isVerticalStyle (Style style)

static bool	isInverseStyle (Style style)

Static Public Attributes
static constexpr uint32_t	kPushBack = (std::numeric_limits<uint32_t>::max) ()

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

Additional Inherited Members
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 }

Protected Member Functions inherited from CControl
	~CControl () noexcept override

Protected Member Functions inherited from CView
	~CView () noexcept override

CGraphicsPath *	getHitTestPath () 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)

Static Protected Member Functions inherited from CControl
static int32_t	mapVstKeyModifier (int32_t vstModifier)

Protected Attributes inherited from CControl
IControlListener *	listener

int32_t	tag

float	value

Detailed Description

Control which draws a segmented button.

Member Typedef Documentation

◆ Segments

using Segments = std::vector<Segment>

Member Enumeration Documentation

◆ SelectionMode

enum SelectionMode

strong

Enumerator
kSingle	a single segment is selected at any time
kSingleToggle	a single segment is selected at any time, when a segment is clicked which is already selected, the next segment is selected
kMultiple	multiple segments may be selected

◆ Style

enum Style

strong

Enumerator
kHorizontal	horizontally layouted segments
kVertical	vertically layouted segments
kHorizontalInverse	horizontally inverse layouted segments
kVerticalInverse	vertically inverse layouted segments

Constructor & Destructor Documentation

◆ CSegmentButton()

CSegmentButton	(	const CRect &	size,
		IControlListener *	listener = `nullptr`,
		int32_t	tag = `-1`
	)

Member Function Documentation

◆ addSegment() [1/2]

bool addSegment	(	const Segment &	segment,
		uint32_t	index = `kPushBack`
	)

◆ addSegment() [2/2]

bool addSegment	(	Segment &&	segment,
		uint32_t	index = `kPushBack`
	)

◆ attached()

bool attached ( CView * parent )

overridevirtual

view is attached to a parent view

Parameters

parent parent view

Returns: true if view successfully attached to parent

Reimplemented from CView.

◆ draw()

void draw ( CDrawContext * pContext )

overridevirtual

called if the view should draw itself

Parameters

pContext draw context in which to draw

Implements CControl.

◆ drawFocusOnTop()

bool drawFocusOnTop ( )

overridevirtual

draw focus before view will be drawn or afterwards

Reimplemented from CControl.

◆ drawRect()

void drawRect	(	CDrawContext *	pContext,
		const CRect &	updateRect
	)

overridevirtual

called if the view should draw itself

Reimplemented from CView.

◆ getFocusPath()

bool getFocusPath ( CGraphicsPath & outPath )

overridevirtual

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

Reimplemented from CControl.

◆ getFont()

CFontRef getFont ( ) const

inline

◆ getFrameColor()

CColor getFrameColor ( ) const

inline

◆ getFrameWidth()

CCoord getFrameWidth ( ) const

inline

◆ getGradient()

CGradient* getGradient ( ) const

inline

◆ getGradientHighlighted()

CGradient* getGradientHighlighted ( ) const

inline

◆ getRoundRadius()

CCoord getRoundRadius ( ) const

inline

◆ getSegments()

const Segments& getSegments ( ) const

inline

◆ getSelectedSegment()

uint32_t getSelectedSegment ( ) const

get the selected segment in single selection mode

◆ getSelectionMode()

SelectionMode getSelectionMode ( ) const

inline

◆ getStyle()

Style getStyle ( ) const

inline

◆ getTextAlignment()

CHoriTxtAlign getTextAlignment ( ) const

inline

◆ getTextColor()

CColor getTextColor ( ) const

inline

◆ getTextColorHighlighted()

CColor getTextColorHighlighted ( ) const

inline

◆ getTextMargin()

CCoord getTextMargin ( ) const

inline

◆ getTextTruncateMode()

CDrawMethods::TextTruncateMode getTextTruncateMode ( ) const

inline

◆ isHorizontalStyle()

static bool isHorizontalStyle ( Style style )

inlinestatic

◆ isInverseStyle()

static bool isInverseStyle ( Style style )

inlinestatic

◆ isSegmentSelected()

bool isSegmentSelected ( uint32_t index ) const

get selection state for a segment in multiple selection mode

◆ isVerticalStyle()

static bool isVerticalStyle ( Style style )

inlinestatic

◆ 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

keyCode key code of pressed key

Returns: -1 if not handled and 1 if handled

Reimplemented from CView.

◆ onMouseDown()

CMouseEventResult onMouseDown	(	CPoint &	where,
		const CButtonState &	buttons
	)

overridevirtual

called when a mouse down event occurs

Parameters

where	mouse location of mouse down
buttons	button and modifier state

Returns: event result. see CMouseEventResult

Reimplemented from CView.

◆ removeAllSegments()

void removeAllSegments ( )

◆ removeSegment()

void removeSegment ( uint32_t index )

◆ selectSegment()

void selectSegment	(	uint32_t	index,
		bool	state
	)

set selection state for a segment in multiple selection mode

◆ setFont()

void setFont ( CFontRef font )

◆ setFrameColor()

void setFrameColor ( CColor newColor )

◆ setFrameWidth()

void setFrameWidth ( CCoord newWidth )

◆ setGradient()

void setGradient ( CGradient * newGradient )

◆ setGradientHighlighted()

void setGradientHighlighted ( CGradient * newGradient )

◆ setRoundRadius()

void setRoundRadius ( CCoord newRoundRadius )

◆ setSelectedSegment()

void setSelectedSegment ( uint32_t index )

set the selected segment in single selection mode

◆ setSelectionMode()

void setSelectionMode ( SelectionMode mode )

◆ setStyle()

void setStyle ( Style newStyle )

◆ setTextAlignment()

void setTextAlignment ( CHoriTxtAlign alignment )

◆ setTextColor()

void setTextColor ( CColor newColor )

◆ setTextColorHighlighted()

void setTextColorHighlighted ( CColor newColor )

◆ setTextMargin()

void setTextMargin ( CCoord newMargin )

◆ setTextTruncateMode()

void setTextTruncateMode ( CDrawMethods::TextTruncateMode mode )

◆ setViewSize()

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

overridevirtual

set views size

Parameters

newSize	rect of new size of view
doInvalid	if true set view dirty

Reimplemented from CView.

◆ valueChanged()

void valueChanged ( )

overridevirtual

notifies listener and dependent objects

Reimplemented from CControl.

Member Data Documentation

◆ kPushBack

constexpr uint32_t kPushBack = (std::numeric_limits<uint32_t>::max) ()

static

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

csegmentbutton.h
csegmentbutton.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Segments

Member Enumeration Documentation

◆ SelectionMode

◆ Style

Constructor & Destructor Documentation

◆ CSegmentButton()

Member Function Documentation

◆ addSegment() [1/2]

◆ addSegment() [2/2]

◆ attached()

◆ draw()

◆ drawFocusOnTop()

◆ drawRect()

◆ getFocusPath()

◆ getFont()

◆ getFrameColor()

◆ getFrameWidth()

◆ getGradient()

◆ getGradientHighlighted()

◆ getRoundRadius()

◆ getSegments()

◆ getSelectedSegment()

◆ getSelectionMode()

◆ getStyle()

◆ getTextAlignment()

◆ getTextColor()

◆ getTextColorHighlighted()

◆ getTextMargin()

◆ getTextTruncateMode()

◆ isHorizontalStyle()

◆ isInverseStyle()

◆ isSegmentSelected()

◆ isVerticalStyle()

◆ newCopy()

◆ onKeyDown()

◆ onMouseDown()

◆ removeAllSegments()

◆ removeSegment()

◆ selectSegment()

◆ setFont()

◆ setFrameColor()

◆ setFrameWidth()

◆ setGradient()

◆ setGradientHighlighted()

◆ setRoundRadius()

◆ setSelectedSegment()

◆ setSelectionMode()

◆ setStyle()

◆ setTextAlignment()

◆ setTextColor()

◆ setTextColorHighlighted()

◆ setTextMargin()

◆ setTextTruncateMode()

◆ setViewSize()

◆ valueChanged()

Member Data Documentation

◆ kPushBack