ASPiK SDK
Public Member Functions | List of all members
VSTGUI::TextButtonEx Class Reference
Custom-Controls

The TextButtonEx object extends the VSTGUI CTextButton object with extra functionality.
It is used in the PluginGUI object for creating custom views. More...

#include <customcontrols.h>

Inheritance diagram for VSTGUI::TextButtonEx:

Public Member Functions

 TextButtonEx (const CRect &size, IControlListener *listener, int32_t tag, UTF8StringPtr title=0, CTextButton::Style=kKickStyle)
 TextButtonEx constructor. More...
 
void draw (CDrawContext *context) override
 
virtual CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 handle mouse down event More...
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons) override
 handle mouse moved event More...
 
virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons) override
 handle mouse up event More...
 
void setMouseMode (unsigned int uMode)
 set the mouse behavior (down, up, or down/up) More...
 

Detailed Description

The TextButtonEx object extends the VSTGUI CTextButton object with extra functionality.
It is used in the PluginGUI object for creating custom views.

Author
Will Pirkle http://www.willpirkle.com
Remarks
This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle
Version
Revision : 1.0
Date
Date : 2018 / 09 / 7

Constructor & Destructor Documentation

◆ TextButtonEx()

VSTGUI::TextButtonEx::TextButtonEx ( const CRect &  size,
IControlListener *  listener,
int32_t  tag,
UTF8StringPtr  title = 0,
CTextButton::Style  = kKickStyle 
)

TextButtonEx constructor.

Parameters
size- the control rectangle
listener- the control's listener (usuall PluginGUI object)
tag- the control ID value
title- the button text
style- button style (see CTextButton::Style)

Member Function Documentation

◆ onMouseDown()

CMouseEventResult VSTGUI::TextButtonEx::onMouseDown ( CPoint &  where,
const CButtonState &  buttons 
)
overridevirtual

handle mouse down event

Parameters
where- coordinates of mouse event
buttons- button state during mouse event

◆ onMouseMoved()

CMouseEventResult VSTGUI::TextButtonEx::onMouseMoved ( CPoint &  where,
const CButtonState &  buttons 
)
overridevirtual

handle mouse moved event

Parameters
where- coordinates of mouse event
buttons- button state during mouse event

◆ onMouseUp()

CMouseEventResult VSTGUI::TextButtonEx::onMouseUp ( CPoint &  where,
const CButtonState &  buttons 
)
overridevirtual

handle mouse up event

Parameters
where- coordinates of mouse event
buttons- button state during mouse event

◆ setMouseMode()

void VSTGUI::TextButtonEx::setMouseMode ( unsigned int  uMode)
inline

set the mouse behavior (down, up, or down/up)

Parameters
mode- behavior flag (see mouseAction enumeration)
The documentation for this class was generated from the following files: