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

Implementation of base Click Concept class for derived classes. More...

#include <kanzi/core.ui/input/click_concept.hpp>

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

Public Member Functions
bool	isDoubleClickEnabled () const
	Gets the value of DoubleClickEnabledProperty. More...
void	setDoubleClickEnabled (bool value)
	Sets the value of DoubleClickEnabledProperty. More...

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

Protected Member Functions
	ClickConceptImpl (Domain *domain, string_view name)
	Constructor. More...
void	configureDoubleClick ()
	Configures a MultiClickManipulator for an ClickConcept-derived class based on the value of the DoubleClickEnabledProperty: More...
void	onAttached () override
	Overrides TBaseClass::onAttached(). More...
void	onClicked (ClickManipulator::ClickMessageArguments &messageArguments)
	Handles click event. More...
void	onDetached () override
	Overrides TBaseClass::onDetached(). More...
void	onMultiClicked (MultiClickManipulator::MultiClickMessageArguments &messageArguments)
	Handles multi-click event. More...
void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Overrides TBaseClass::onNodePropertyChanged(). More...

Additional Inherited Members
Static Public Attributes inherited from kanzi::ClickConcept
static PropertyType< bool >	DoubleClickEnabledProperty
	Enables the double-click gesture for a node. More...
Protected Attributes inherited from kanzi::ClickConcept
ClickManipulatorSharedPtr	m_clickManipulator
	The ClickManipulator. More...
MultiClickManipulatorSharedPtr	m_multiClickManipulator
	Multi-Click manipulator. More...

Detailed Description

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

Implementation of base Click Concept class for derived classes.

Template Parameters

TBaseClass	Type of the base class, derived from Node2D or Node3D.
TDerivedClass	Type of the derived class that holds the Click Concept properties.

Since

Kanzi 3.9.0

Constructor & Destructor Documentation

template<typename TBaseClass , typename TDerivedClass >

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

explicitprotected

Constructor.

Member Function Documentation

template<typename TBaseClass, typename TDerivedClass>

static PropertyTypeEditorInfoSharedPtr kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )

inlinestatic

template<typename TBaseClass, typename TDerivedClass>

bool kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >::isDoubleClickEnabled ( ) const

inline

Gets the value of DoubleClickEnabledProperty.

Returns

The value of the DoubleClickEnabledProperty.

See also

setDoubleClickEnabled()

template<typename TBaseClass, typename TDerivedClass>

void kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >::setDoubleClickEnabled ( bool  value )

inline

Sets the value of DoubleClickEnabledProperty.

Parameters

value

The value to set to the DoubleClickEnabledProperty.

See also

isDoubleClickEnabled()

template<typename TBaseClass , typename TDerivedClass >

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

overrideprotected

Overrides TBaseClass::onAttached().

Reimplemented in kanzi::ButtonConceptImpl< Node2D, Button2D >, kanzi::ButtonConceptImpl< Node3D, Button3D >, kanzi::ButtonConceptImpl< Node3D, ToggleButton3D >, and kanzi::ButtonConceptImpl< Node2D, ToggleButton2D >.

template<typename TBaseClass , typename TDerivedClass >

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

overrideprotected

Overrides TBaseClass::onDetached().

Reimplemented in kanzi::ButtonConceptImpl< Node2D, Button2D >, kanzi::ButtonConceptImpl< Node3D, Button3D >, kanzi::ButtonConceptImpl< Node3D, ToggleButton3D >, and kanzi::ButtonConceptImpl< Node2D, ToggleButton2D >.

template<typename TBaseClass , typename TDerivedClass >

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

overrideprotected

Overrides TBaseClass::onNodePropertyChanged().

Reimplemented in kanzi::ButtonConceptImpl< Node2D, Button2D >, kanzi::ButtonConceptImpl< Node3D, Button3D >, kanzi::ButtonConceptImpl< Node3D, ToggleButton3D >, kanzi::ButtonConceptImpl< Node2D, ToggleButton2D >, kanzi::ListBoxItemContainerImpl< ContentLayout3D, ListBoxItemContainer3D, ContentLayout3D >, and kanzi::ListBoxItemContainerImpl< ContentLayout2D, ListBoxItemContainer2D, ContentLayout2D >.

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >::onClicked ( ClickManipulator::ClickMessageArguments &  messageArguments )

protected

Handles click event.

Since

Kanzi 3.9.3

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >::onMultiClicked ( MultiClickManipulator::MultiClickMessageArguments &  messageArguments )

protected

Handles multi-click event.

Since

Kanzi 3.9.3

template<typename TBaseClass , typename TDerivedClass >

void kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >::configureDoubleClick ( )

protected

Configures a MultiClickManipulator for an ClickConcept-derived class based on the value of the DoubleClickEnabledProperty:

• If the value is true, adds a Multi-Click Manipulator that handles the double-click gesture.
• If the value is false, removes an existing Multi-Click Manipulator.

---

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

• kanzi/core.ui/input/click_concept.hpp
• kanzi/core.ui/input/click_concept_impl.hpp