ASPiK SDK
VSTGUI::CKickButtonEx Class Reference

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

#include <customcontrols.h>

Inheritance diagram for VSTGUI::CKickButtonEx:

Public Member Functions

 CKickButtonEx (const CRect &size, IControlListener *listener, int32_t tag, CBitmap *background, const CPoint &offset=CPoint(0, 0))
 
virtual CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 handle mouse down event More...
 
virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons) override
 handle mouse up event More...
 
void setMouseMode (unsigned int mode)
 set the mouse behavior (down, up, or down/up) More...
 
 CKickButtonEx (const CRect &size, IControlListener *listener, int32_t tag, CBitmap *background, const CPoint &offset=CPoint(0, 0))
 
virtual CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 handle mouse down event More...
 
virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons) override
 handle mouse up event More...
 
void setMouseMode (unsigned int mode)
 set the mouse behavior (down, up, or down/up) More...
 

Detailed Description

The CKickButtonEx object extends the VSTGUI CKickButton 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

Member Function Documentation

◆ onMouseDown() [1/2]

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

handle mouse down event

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

◆ onMouseDown() [2/2]

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

handle mouse down event

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

◆ onMouseUp() [1/2]

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

handle mouse up event

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

◆ onMouseUp() [2/2]

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

handle mouse up event

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

◆ setMouseMode() [1/2]

void VSTGUI::CKickButtonEx::setMouseMode ( unsigned int  mode)
inline

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

Parameters
mode- behavior flag (see mouseAction enumeration)

◆ setMouseMode() [2/2]

void VSTGUI::CKickButtonEx::setMouseMode ( unsigned int  mode)
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: