kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass > Class Template Reference

Base class for buttons. More...

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

Inheritance diagram for kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >:

Public Member Functions
bool	isPressed () const
void	setPressed (bool value)
float	getLongPressInterval () const
void	setLongPressInterval (float value)
bool	isPressOnHover () const
void	setPressOnHover (bool value)
float	getAutoClickInterval () const
void	setAutoClickInterval (float value)
unsigned int	getToggleStateCount () const
void	setToggleStateCount (unsigned int value)
unsigned int	getToggleState () const
void	setToggleState (unsigned int state)
int	getIndexInGroup () const
	Gets the value of #ButtonGroupIndexProperty. More...
void	setIndexInGroup (int value)
	Sets the value of #ButtonGroupIndexProperty. More...
virtual void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE
Public Member Functions inherited from kanzi::ButtonConcept
optional< int >	getEffectiveButtonGroupId () const

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Public Member Functions inherited from kanzi::ButtonConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Member Functions
	ButtonConceptImpl (Domain *domain, string_view name)
void	initialize ()
virtual void	onAttached () KZ_OVERRIDE
virtual void	onDetached () KZ_OVERRIDE
void	onClickEnter (ClickManipulator::ClickEnterMessageArguments &)
void	onClickLeave (ClickManipulator::ClickLeaveMessageArguments &)
void	onClickBegin (ClickManipulator::ClickBeginMessageArguments &)
void	onClick (ClickManipulator::ClickMessageArguments &)
void	onClickCancel (ClickManipulator::ClickCancelMessageArguments &)
void	onLongPress (LongPressManipulator::LongPressMessageArguments &arguments)
void	onKeyDown (Keyboard::KeyDownMessageArguments &arguments)
void	onKeyUp (Keyboard::KeyUpMessageArguments &arguments)
void	toggle ()

Static Protected Member Functions
static kzsError	repeatHandler (MessageArguments *message, void *userData)
Static Protected Member Functions inherited from kanzi::ButtonConcept
static Vector2	measure2D (Node2D *button, Vector2 availableSize)
	Measure function for a Node2D button. More...

Friends
class	::KzTestButtons

Additional Inherited Members
Static Public Attributes inherited from kanzi::ButtonConcept
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...
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
Protected Attributes inherited from kanzi::ButtonConcept
optional< int >	m_effectiveButtonGroupId

Detailed Description

template<typename TBaseClass, typename TDerivedClass>
class kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >

Base class for buttons.

Constructor & Destructor Documentation

template<typename TBaseClass , typename TDerivedClass >

kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::ButtonConceptImpl ( Domain *  domain, string_view  name  )

explicitprotected

Member Function Documentation

template<typename TBaseClass , typename TDerivedClass >

PropertyTypeEditorInfoSharedPtr kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )

static

template<typename TBaseClass , typename TDerivedClass >

bool kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::isPressed

(

)

const

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::setPressed

(

bool

value

)

template<typename TBaseClass , typename TDerivedClass >

float kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::getLongPressInterval

(

)

const

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::setLongPressInterval

(

float

value

)

template<typename TBaseClass , typename TDerivedClass >

bool kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::isPressOnHover

(

)

const

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::setPressOnHover

(

bool

value

)

template<typename TBaseClass , typename TDerivedClass >

float kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::getAutoClickInterval

(

)

const

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::setAutoClickInterval

(

float

value

)

template<typename TBaseClass , typename TDerivedClass >

unsigned int kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::getToggleStateCount

(

)

const

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::setToggleStateCount

(

unsigned int

value

)

template<typename TBaseClass , typename TDerivedClass >

unsigned int kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::getToggleState

(

)

const

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::setToggleState

(

unsigned int

state

)

template<typename TBaseClass , typename TDerivedClass >

int kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::getIndexInGroup

(

)

const

Gets the value of #ButtonGroupIndexProperty.

See also

setButtonGroupIndex()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::setIndexInGroup

(

int

value

)

Sets the value of #ButtonGroupIndexProperty.

See also

getButtonGroupIndex()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onNodePropertyChanged ( AbstractPropertyType  propertyType, PropertyNotificationReason  reason  )

virtual

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::initialize ( )

protected

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onAttached ( )

protectedvirtual

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onDetached ( )

protectedvirtual

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onClickEnter ( ClickManipulator::ClickEnterMessageArguments &  )

protected

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onClickLeave ( ClickManipulator::ClickLeaveMessageArguments &  )

protected

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onClickBegin ( ClickManipulator::ClickBeginMessageArguments &  )

protected

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onClick ( ClickManipulator::ClickMessageArguments &  )

protected

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onClickCancel ( ClickManipulator::ClickCancelMessageArguments &  )

protected

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onLongPress ( LongPressManipulator::LongPressMessageArguments &  arguments )

protected

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onKeyDown ( Keyboard::KeyDownMessageArguments &  arguments )

protected

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onKeyUp ( Keyboard::KeyUpMessageArguments &  arguments )

protected

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::toggle ( )

protected

template<typename TBaseClass , typename TDerivedClass >

kzsError kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::repeatHandler ( MessageArguments *  message, void *  userData  )

staticprotected

Friends And Related Function Documentation

template<typename TBaseClass, typename TDerivedClass>

friend class ::KzTestButtons

friend

---

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

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