kanzi::ButtonConcept Class Reference

Button concept class. More...

#include <kanzi/ui/node/concept/button.hpp>

Inheritance diagram for kanzi::ButtonConcept:

Classes
class	CanceledMessageArguments
class	ClickedMessageArguments
class	LongPressMessageArguments
class	PointerEnteredMessageArguments
class	PointerLeftMessageArguments
class	PressedMessageArguments
class	ToggledOffMessageArguments
class	ToggledOnMessageArguments
class	ToggleStateChangedMessageArguments

Public Member Functions
optional< int >	getEffectiveButtonGroupId () const

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
Properties
static PropertyType< bool >	IsPressedProperty
	IsPressed property. More...
static PropertyType< float >	LongPressIntervalProperty
	LongPressInterval property. More...
static PropertyType< bool >	PressOnHoverProperty
	PressOnHover property. More...
static PropertyType< float >	AutoClickIntervalProperty
	AutoClickInterval property. More...
static PropertyType< int >	ToggleStateProperty
	ToggleState property. More...
static PropertyType< int >	ToggleStateCountProperty
	ToggleStateCount property. More...
static PropertyType< int >	IndexInGroupProperty
	IndexInGroup property. More...
Messages
static MessageType< ClickedMessageArguments >	ClickedMessage
static MessageType< PressedMessageArguments >	PressedMessage
static MessageType< CanceledMessageArguments >	CanceledMessage
static MessageType< PointerEnteredMessageArguments >	PointerEnteredMessage
static MessageType< PointerLeftMessageArguments >	PointerLeftMessage
static MessageType< LongPressMessageArguments >	LongPressMessage
static MessageType< ToggledOnMessageArguments >	ToggledOnMessage
static MessageType< ToggledOffMessageArguments >	ToggledOffMessage
static MessageType< ToggleStateChangedMessageArguments >	ToggleStateChangedMessage

Static Protected Member Functions
static Vector2	measure2D (Node2D *button, Vector2 availableSize)
	Measure function for a Node2D button. More...

Protected Attributes
optional< int >	m_effectiveButtonGroupId

Detailed Description

Button concept class.

Member Function Documentation

static PropertyTypeEditorInfoSharedPtr kanzi::ButtonConcept::makeEditorInfo ( )

static

optional<int> kanzi::ButtonConcept::getEffectiveButtonGroupId ( ) const

inline

static Vector2 kanzi::ButtonConcept::measure2D ( Node2D *  button, Vector2  availableSize  )

staticprotected

Measure function for a Node2D button.

Member Data Documentation

PropertyType<bool> kanzi::ButtonConcept::IsPressedProperty

static

IsPressed property.

Whether the button is in down state. The default value is false.

See also

setIsPressed(), isIsPressed()

PropertyType<float> kanzi::ButtonConcept::LongPressIntervalProperty

static

LongPressInterval property.

Occurs when the button is in down state for the set amount of milliseconds. Set to 0 to disable. The default value is 0.0f.

See also

setLongPressInterval(), getLongPressInterval()

PropertyType<bool> kanzi::ButtonConcept::PressOnHoverProperty

static

PressOnHover property.

Whether hovering the pointer over the button makes sets it into down state. The default value is false.

See also

setPressOnHover(), isPressOnHover()

PropertyType<float> kanzi::ButtonConcept::AutoClickIntervalProperty

static

AutoClickInterval property.

An interval in milliseconds after which a held down button sends a button click message. Set to 0 to disable. The default value is 0.0f.

See also

setAutoClickInterval(), getAutoClickInterval()

PropertyType<int> kanzi::ButtonConcept::ToggleStateProperty

static

ToggleState property.

The current toggle state of a toggle button. The default value is 0.

See also

setToggleState(), getToggleState()

PropertyType<int> kanzi::ButtonConcept::ToggleStateCountProperty

static

ToggleStateCount property.

The number of toggle states of a toggle button. The default value is 0.

See also

setToggleStateCount(), getToggleStateCount()

PropertyType<int> kanzi::ButtonConcept::IndexInGroupProperty

static

IndexInGroup property.

The default value is -1.

See also

setIndexInGroup(), getIndexInGroup()

MessageType<ClickedMessageArguments> kanzi::ButtonConcept::ClickedMessage

static

MessageType<PressedMessageArguments> kanzi::ButtonConcept::PressedMessage

static

MessageType<CanceledMessageArguments> kanzi::ButtonConcept::CanceledMessage

static

MessageType<PointerEnteredMessageArguments> kanzi::ButtonConcept::PointerEnteredMessage

static

MessageType<PointerLeftMessageArguments> kanzi::ButtonConcept::PointerLeftMessage

static

MessageType<LongPressMessageArguments> kanzi::ButtonConcept::LongPressMessage

static

MessageType<ToggledOnMessageArguments> kanzi::ButtonConcept::ToggledOnMessage

static

MessageType<ToggledOffMessageArguments> kanzi::ButtonConcept::ToggledOffMessage

static

MessageType<ToggleStateChangedMessageArguments> kanzi::ButtonConcept::ToggleStateChangedMessage

static

optional<int> kanzi::ButtonConcept::m_effectiveButtonGroupId

protected

---

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

• kanzi/ui/node/concept/button.hpp