Click manipulator generates messages necessary to implement logic for object that can be pressed, for example buttons. More...

#include <kanzi/input/click_manipulator.hpp>

Inheritance diagram for kanzi::ClickManipulator:

Classes
class	ClickBeginMessageArguments

class	ClickCancelMessageArguments

class	ClickEnterMessageArguments

class	ClickLeaveMessageArguments

class	ClickMessageArguments

Public Member Functions
virtual kzsError	notifyTouchInside (const TouchInfo &touchInfo) KZ_OVERRIDE
	Touch inside implementation for click manipulator. More...

virtual kzsError	notifyTouchOutside (const TouchInfo &touchInfo) KZ_OVERRIDE
	Touch outside implementation for click manipulator. More...

void	setHoverToBegin (bool hoverToBegin)
	Enable or disable click begin on hovering. More...

Public Member Functions inherited from kanzi::InputManipulator
	InputManipulator (Domain *domain)
	Create base input manipulator. More...

virtual	~InputManipulator ()

kzsError	attach (Node *objectNode)
	Attach an input manipulator to an object node. More...

kzsError	detach ()
	Detach an input manipulator. More...

kzsError	reset ()
	Reset manipulator. More...

kzsError	cancel ()
	Notify manipulator of touch canceling. More...

KzuInputManipulatorState	getState () const
	Get the state of a manipulator. More...

kzsError	setState (KzuInputManipulatorState state)
	Set the state of a manipulator. More...

Node *	getObjectNode () const
	Get the object node an input manipulator is attached to. More...

void	requireToFail (InputManipulator *manipulatorToFail)
	Sets the manipulator that is required to fail before this manipulator can succeed. More...

InputManipulator *	getFailManipulator () const
	Gets the fail manipulator. More...

InputManipulator *	getDependManipulator () const
	Gets the depend manipulator. More...

bool	isHandled () const
	Get the change flag of a manipulator. More...

void	setHandled (bool handled)
	Set the change flag of a manipulator. More...

kzsError	setInputManager (KzuInputManager *inputManager)
	Attach or detach an input manager to a manipulator during recognition. More...

KzuInputManager *	getInputManager () const
	Get the attached input manager of a manipulator. More...

bool	isAttached () const
	Tells if the input manipulator is attached (has a valid node reference). More...

void	setReferenceNode (NodeWeakPtr referenceNode)

kzsError	addHitTestArguments (MessageArguments message, const KzuInputTouchPoint touchPoint)
	Add hit test information arguments to a message from a touch point. More...

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

KzuPropertyManager *	getPropertyManager () const
	Returns the property manager of the object. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

virtual const Metaclass *	getDynamicMetaclass () const
	Returns the metaclass of the dynamic type of the object. More...

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
	Sets the local value of a property. More...

void	setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
	Sets the local value of a resource id property with a resource pointer. More...

template<typename DataType >
DataType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

template<typename DataType >
bool	getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)

void	setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
bool	getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

void	copyLocalValues (const Object &other)
	Copies all local values from another object. More...

virtual void	onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

AppliedStyleEntry *	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Static Public Member Functions
static ClickManipulatorSharedPtr	create (Domain *domain, string_view="")

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Public Attributes
unsigned int	touchId
	Touch ID. More...

kzBool	touchInside
	Is the touch inside the manipulator. More...

kzBool	pressed
	Is pressed. More...

kzBool	delayed
	Is the click handling delayed. More...

kzBool	hoverToBegin
	Is begin on hovering enabled. More...

Public Attributes inherited from kanzi::InputManipulator
Node *	m_node
	Object node reference. More...

KzuInputManager *	m_inputManager
	Input manager reference. More...

KzuInputManipulatorState	m_state
	The state of the manipulator. More...

bool	m_handled
	The handled flag to identify input phases. More...

InputManipulator *	m_failManipulator
	The input manipulator that has to fail for this manipulator to succeed. More...

InputManipulator *	m_dependManipulator
	The input manipulator that will be notified in case this manipulator fails. More...

NodeWeakPtr	m_referenceNode

Static Public Attributes
static MessageType < ClickMessageArguments >	ClickMessage

static MessageType < ClickBeginMessageArguments >	ClickBeginMessage

static MessageType < ClickCancelMessageArguments >	ClickCancelMessage

static MessageType < ClickEnterMessageArguments >	ClickEnterMessage

static MessageType < ClickLeaveMessageArguments >	ClickLeaveMessage

Protected Member Functions
	ClickManipulator (Domain *domain)

virtual kzsError	onReset () KZ_OVERRIDE
	Reset implementation for click manipulator. More...

virtual kzsError	onFail () KZ_OVERRIDE
	Fail implementation for click manipulator. More...

Protected Member Functions inherited from kanzi::InputManipulator
virtual kzsError	onAttach ()
	Attach function for input manipulators. More...

virtual kzsError	onDetach ()
	Detach function for input manipulators. More...

virtual kzsError	onCancel ()
	Cancel function for input manipulators. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector < AppliedStyleEntry * >	AppliedStyleContainer
	Applied style container. More...

Static Protected Member Functions inherited from kanzi::InputManipulator
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Click manipulator generates messages necessary to implement logic for object that can be pressed, for example buttons.

Constructor & Destructor Documentation

kanzi::ClickManipulator::ClickManipulator ( Domain * domain )

explicitprotected

Member Function Documentation

virtual kzsError kanzi::ClickManipulator::notifyTouchInside ( const TouchInfo & touchInfo )

virtual

Touch inside implementation for click manipulator.

Reimplemented from kanzi::InputManipulator.

virtual kzsError kanzi::ClickManipulator::notifyTouchOutside ( const TouchInfo & touchInfo )

virtual

Touch outside implementation for click manipulator.

Reimplemented from kanzi::InputManipulator.

void kanzi::ClickManipulator::setHoverToBegin ( bool hoverToBegin )

Enable or disable click begin on hovering.

static ClickManipulatorSharedPtr kanzi::ClickManipulator::create	(	Domain *	domain,
		string_view	= `""`
	)

inlinestatic

virtual kzsError kanzi::ClickManipulator::onReset ( )

protectedvirtual

Reset implementation for click manipulator.

Reimplemented from kanzi::InputManipulator.

virtual kzsError kanzi::ClickManipulator::onFail ( )

protectedvirtual

Fail implementation for click manipulator.

Reimplemented from kanzi::InputManipulator.

Member Data Documentation

MessageType<ClickMessageArguments> kanzi::ClickManipulator::ClickMessage

static

MessageType<ClickBeginMessageArguments> kanzi::ClickManipulator::ClickBeginMessage

static

MessageType<ClickCancelMessageArguments> kanzi::ClickManipulator::ClickCancelMessage

static

MessageType<ClickEnterMessageArguments> kanzi::ClickManipulator::ClickEnterMessage

static

MessageType<ClickLeaveMessageArguments> kanzi::ClickManipulator::ClickLeaveMessage

static

unsigned int kanzi::ClickManipulator::touchId

Touch ID.

kzBool kanzi::ClickManipulator::touchInside

Is the touch inside the manipulator.

kzBool kanzi::ClickManipulator::pressed

Is pressed.

kzBool kanzi::ClickManipulator::delayed

Is the click handling delayed.

kzBool kanzi::ClickManipulator::hoverToBegin

Is begin on hovering enabled.

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

kanzi/input/click_manipulator.hpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation