Kanzi Engine API
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 >:
[legend]

Public Member Functions

float getAutoClickInterval () const
 
int getIndexInGroup () const
 Gets the value of #ButtonGroupIndexProperty. More...
 
float getLongPressInterval () const
 
unsigned int getToggleState () const
 
unsigned int getToggleStateCount () const
 
bool isPressed () const
 
bool isPressOnHover () const
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 
void setAutoClickInterval (float value)
 
void setIndexInGroup (int value)
 Sets the value of #ButtonGroupIndexProperty. More...
 
void setLongPressInterval (float value)
 
void setPressed (bool value)
 
void setPressOnHover (bool value)
 
void setToggleState (unsigned int state)
 
void setToggleStateCount (unsigned int value)
 
- 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 ()
 
void onAttached () override
 
void onClick (ClickManipulator::ClickMessageArguments &)
 
void onClickBegin (ClickManipulator::ClickBeginMessageArguments &)
 
void onClickCancel (ClickManipulator::ClickCancelMessageArguments &)
 
void onClickEnter (ClickManipulator::ClickEnterMessageArguments &)
 
void onClickLeave (ClickManipulator::ClickLeaveMessageArguments &)
 
void onDetached () override
 
void onKeyCancel (KeyManipulator::KeyCanceledMessageArguments &arguments)
 
void onKeyDown (KeyManipulator::KeyPressedMessageArguments &arguments)
 
void onKeyUp (KeyManipulator::KeyReleasedMessageArguments &arguments)
 
void onLongPress (LongPressManipulator::LongPressMessageArguments &arguments)
 
void repeatHandler ()
 
void toggle ()
 

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< ClickedMessageArgumentsClickedMessage
 
static MessageType< PressedMessageArgumentsPressedMessage
 
static MessageType< CanceledMessageArgumentsCanceledMessage
 
static MessageType< PointerEnteredMessageArgumentsPointerEnteredMessage
 
static MessageType< PointerLeftMessageArgumentsPointerLeftMessage
 
static MessageType< LongPressMessageArgumentsLongPressMessage
 
static MessageType< ToggledOnMessageArgumentsToggledOnMessage
 
static MessageType< ToggledOffMessageArgumentsToggledOffMessage
 
static MessageType< ToggleStateChangedMessageArgumentsToggleStateChangedMessage
 
- Static Protected Member Functions inherited from kanzi::ButtonConcept
static Vector2 measure2D (Node2D *button, Vector2 availableSize)
 Measure function for a Node2D button. More...
 
- 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 
)
override
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::initialize ( )
protected
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onAttached ( )
overrideprotected
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onDetached ( )
overrideprotected
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 ( KeyManipulator::KeyPressedMessageArguments arguments)
protected
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onKeyUp ( KeyManipulator::KeyReleasedMessageArguments arguments)
protected
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::onKeyCancel ( KeyManipulator::KeyCanceledMessageArguments arguments)
protected
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::toggle ( )
protected
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ButtonConceptImpl< TBaseClass, TDerivedClass >::repeatHandler ( )
protected

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: