ParameterButton Class Reference

#include <parameterbutton.h>

Public Member Functions
virtual void	setValue (const Parameter &value) override
void	setPressed (bool pressed)
bool	isPressed () const
Public Member Functions inherited from Parameter
const std::string	getDisplayName () const
Public Member Functions inherited from Resource
	Resource ()
Public Member Functions inherited from Object
	Object ()
virtual	~Object ()
virtual bool	init (utility::ErrorState &errorState)
virtual void	onDestroy ()
	Object (Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&)=delete
Object &	operator= (Object &&)=delete

Public Attributes
Signal	click
	Signal that's raised when the button is active. More...
Signal	press
	Signal that's raised when the button is pressed. More...
Signal	release
	Signal that's raised when the button is released. More...
Public Attributes inherited from Parameter
std::string	mName
	Property 'Name': The name of this property. The name is separate from the ID and doesn't have to be unique. More...
Public Attributes inherited from Object
std::string	mID
	Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Additional Inherited Members
Static Public Member Functions inherited from Object
static bool	isIDProperty (rtti::Instance &object, const rtti::Property &property)

Description

Button parameter

Inheritance diagram for ParameterButton:

Collaboration diagram for ParameterButton:

Member Function Documentation

isPressed()

bool isPressed

(

)

const

Returns

whether the button is currently pressed

setPressed()

void setPressed

(

bool

pressed

)

Set the pressed state of this parameter. Raises the "press" signal if the state changed to pressed. Raises the "release" signal if the state changed to not pressed.

Parameters

pressed

The pressed state to set

setValue()

virtual void setValue ( const Parameter &  value )

overridevirtual

Set the value for this parameter from another parameter

Parameters

value

The parameter to set the value from

Implements Parameter.

Member Data Documentation

click

Signal click

Signal that's raised when the button is active.

press

Signal press

Signal that's raised when the button is pressed.

release

Signal release

Signal that's raised when the button is released.