KeyManipulator class is a key input manipulator that detects key gestures. More...

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

Inheritance diagram for kanzi::KeyManipulator:

Classes
class	KeyCanceledMessageArguments
	Message arguments used by the KeyCanceledMessage. More...

class	KeyPressedMessageArguments
	Message arguments used by the KeyPressedMessage. More...

class	KeyReleasedMessageArguments
	Message arguments used by the KeyReleasedMessage. More...

Static Public Member Functions
static KeyManipulatorSharedPtr	create (Domain *domain, string_view="")
	Creates a KeyManipulator instance. More...

static KeyManipulatorSharedPtr	create (Domain *domain, LogicalKey key, KeyModifier modifier=KeyModifier::Undefined, string_view="")
	Convenience function, creates a KeyManipulator with the logical key and key modifier. More...

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...

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

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

Static Public Attributes
static MessageType< KeyCanceledMessageArguments >	KeyCanceledMessage
	Kanzi dispatches this message to the attached node when the user cancels a gesture. More...

static MessageType< KeyPressedMessageArguments >	KeyPressedMessage
	Kanzi dispatches this message to the attached node when the user presses a gesture. More...

static MessageType< KeyReleasedMessageArguments >	KeyReleasedMessage
	Kanzi dispatches this message to the attached node when the user releases a gesture. More...

Protected Types
using	RepeatGesture = KeyRepeatConceptImpl< KeyManipulator >

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Protected Member Functions
	KeyManipulator (Domain *domain)
	Constructor. More...

void	notifyKeyHoldGesture ()
	KeyRepeatConceptImpl calls this method to notify a key manipulator that it detected a key hold gesture. More...

bool	notifyKeyInput (const KeyEvent &event) override
	Overrides InputManipulator::notifyKeyInput(). More...

void	notifyKeyPressGesture (KeyInputConcept &)
	KeyInputConceptImpl calls this method to notify a key manipulator that it detected a full key press gesture. More...

void	notifyKeyReleaseGesture (KeyInputConcept &)
	KeyInputConceptImpl calls this method to notify a key manipulator that it detected a key release gesture. More...

void	notifyKeyRepeatGesture ()
	KeyRepeatConceptImpl calls this method to notify a key manipulator that it detected a key repeat gesture. More...

void	notifyPartialKeyPressGesture (KeyInputConcept &)
	KeyInputConceptImpl calls this method to notify a key manipulator that it detected a partial key press gesture. More...

void	onCancel () override
	Overrides InputManipulator::onCancel(). More...

void	onReset () override
	Overrides InputManipulator::onReset(). More...

Protected Member Functions inherited from kanzi::InputManipulator
void	addHitTestArguments (MessageArguments &message, const TouchPoint &touchPoint)
	Add hit test information arguments to the message from the touch point. More...

void	attach (Node &node)
	Attach an input manipulator to a node. Kanzi calls this method when you add an input manipulator to a node. More...

void	detach ()
	Detach an input manipulator. Kanzi calls this method when you remove an input manipulator from a node. More...

InputManager *	getInputManager () const
	Get the attached input manager of an input manipulator. More...

	InputManipulator (Domain *domain, ManipulatorType type=ManipulatorType::TouchInputHandler)
	Constructor. More...

virtual bool	isCancelableOverride () const
	Overridable check for the cancelable status of an input manipulator. More...

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

virtual bool	isResettableOverride () const
	Overridable check for the resettable status of an input manipulator. More...

virtual void	notifyTouchInside (const TouchInfo &touchInfo)
	Notify an input manipulator about touch events that occur inside the subtree of the input manipulator. More...

virtual void	notifyTouchOutside (const TouchInfo &touchInfo)
	Notify an input manipulator about touch events that occur outside the subtree of the input manipulator. More...

virtual void	onAttach ()
	Attach function for input manipulators. More...

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

virtual void	onFail ()
	Fail function for input manipulators. More...

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

void	setInputManager (InputManager *inputManager)
	Attach or detach the input manager to an input manipulator during recognition. More...

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

void	onCopy (const Object &other)

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

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Protected Member Functions inherited from kanzi::KeyInputConceptImpl< KeyManipulator >
void	grabGesture ()
	Grabs the gesture. More...

	KeyInputConceptImpl ()=default
	Constructor. More...

void	ungrabGesture ()
	Ungrabs the gesture. More...

Protected Member Functions inherited from kanzi::KeyInputGestureDetector< KeyManipulator, KeyInputConcept >
bool	detectKeyGesture (const KeyEvent &event, KeyInputConcept &gesture)
	Detects key gestures from the event that you pass as an argument. More...

void	grabGesture (KeyInputConcept &gesture)
	Grabs a gesture. More...

	KeyInputGestureDetector ()=default
	Constructor. More...

void	ungrabGesture (KeyInputConcept &gesture)
	Ungrabs a gesture. More...

Protected Member Functions inherited from kanzi::KeyRepeatConceptImpl< KeyManipulator >
	KeyRepeatConceptImpl (Domain *domain)
	Constructor. More...

void	startKeyRepeatDetection ()
	Starts the key-repeat gesture detection. More...

void	stopKeyRepeatDetection ()
	Stops the gesture detection. More...

Protected Member Functions inherited from kanzi::KeyRepeatConcept
	KeyRepeatConcept ()=default
	Constructor. More...

Protected Attributes
bool	m_capsLock
	Caps Lock state for the current key input event. More...

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

Protected Attributes inherited from kanzi::KeyInputConcept
bool	m_capsLock
	Holds the Caps Lock state at the time Kanzi grabs the key gesture. More...

CapsLockState	m_capsLockState
	Holds the required Caps Lock state for the key gesture. More...

LogicalKey	m_code
	The logical key value. More...

bool	m_isEnabled
	Holds the enabled state of a gesture. More...

bool	m_isGrabbed
	Holds the grabbed state of a gesture. More...

KeyModifier	m_modifiers
	The key modifiers. More...

Protected Attributes inherited from kanzi::KeyRepeatConcept
DetectionMode	m_detectionMode
	Holds the key-repeat setting of the key gesture. More...

chrono::milliseconds	m_keyHoldTimeout
	Key-hold timeout. More...

MainLoopTimerToken	m_keyHoldTimerSubscription
	Timer handle for the initial key-hold and the key-repeat interval. More...

chrono::milliseconds	m_keyRepeatInterval
	Key-repeat interval. More...

Friends
class	KeyInputGestureDetector< KeyManipulator, KeyInputConcept >
	KeyInputGestureDetector needs access to protected methods when it calls the notifier functions. More...

class	KeyRepeatConceptImpl< KeyManipulator >
	KeyRepeatConceptImpl needs access to protected methods when it calls the notifier functions. More...

Additional Inherited Members
Public Types inherited from kanzi::InputManipulator
enum	EventRoutingMode { RoutingBubbling, RoutingTunneling }
	Enumeration for the available input event routing modes. More...

enum	ManipulatorType { ManipulatorType::TouchInputHandler, ManipulatorType::KeyInputHandler }
	Enumeration for the input manipulator type. More...

enum	State { StateReady, StatePossible, StateBegin, StateChange, StateEnd, StateFail, StateDelayed, StateCanceled }
	Enumeration for possible input manipulator states during touch, mouse, or key input sequence. More...

using	TouchEventRoutingMode = EventRoutingMode
	Enumeration for the available touch event routing modes. More...

using	TouchPointsConstIterator = TouchPointsContainer::const_iterator

using	TouchPointsContainer = vector< TouchPoint * >

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Types inherited from kanzi::KeyRepeatConcept
enum	DetectionMode : uint8_t { DetectionMode::Disabled, DetectionMode::KeyHold, DetectionMode::KeyHoldAndRepeat }
	Specifies the key-hold and key-repeat gesture detection mode. More...

Public Member Functions inherited from kanzi::InputManipulator
void	cancel ()
	Notify manipulator of touch canceling. More...

Node *	getAttachedNode () const
	Gets the node to which the input manipulator is attached. More...

InputManipulator *	getDependantManipulator () const
	Gets the dependant input manipulator. More...

EventRoutingMode	getEventRoutingMode ()
	Returns the current input event routing mode. More...

InputManipulatorWeakPtr	getFailManipulator () const
	Gets the fail manipulator. More...

State	getState () const
	Get the state of an input manipulator. More...

KZ_DEPRECATED TouchEventRoutingMode	getTouchEventRoutingMode ()
	Returns the current touch event routing mode. More...

ManipulatorType	getType () const
	Returns the type of the input manipulator. More...

bool	isActive () const
	Checks whether an input manipulator is in active state. More...

bool	isAttached () const
	Tells whether the input manipulator is attached to a node. More...

bool	isCancelable () const
	Checks whether an input manipulator is in a cancelable state. More...

bool	isResettable () const
	Checks whether an input manipulator is in a resettable state. More...

void	requireToFail (InputManipulatorWeakPtr manipulatorToFail)
	Sets the input manipulator that must fail before Kanzi can recognize this input manipulator. More...

void	reset ()
	Reset the manipulator. More...

void	setEventRoutingMode (EventRoutingMode mode)
	Sets the input event routing mode that you want the input manager to use when distributing the input event data to manipulators. More...

void	setReferenceNode (NodeWeakPtr referenceNode)
	Override the attached node as the hit test reference node. More...

void	setState (State state)
	Set the state of an input manipulator. More...

KZ_DEPRECATED void	setTouchEventRoutingMode (TouchEventRoutingMode mode)
	Sets the touch event routing mode that you want the input manager to use when distributing the touch points to input manipulators. More...

	~InputManipulator () override
	Destructor. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

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

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

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

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

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

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

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

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

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

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) 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 >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...

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

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

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

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

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

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

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

	PropertyObject ()

void	removeKzbProperties ()

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

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

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

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

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Public Member Functions inherited from kanzi::KeyInputConceptImpl< KeyManipulator >
bool	detectKeyGesture (const KeyEvent &event)
	Detects key gestures from the event that you pass as an argument. More...

Public Member Functions inherited from kanzi::KeyInputConcept
CapsLockState	getCapsLock () const
	Returns the required Caps Lock state for the key gesture. More...

pair< LogicalKey, KeyModifier >	getKey () const
	Returns the composing elements of a key gesture. More...

bool	isCapsLockGrabbed () const
	Returns whether the Caps Lock mode was on when the gesture detector set this key gesture as grabbed. More...

bool	isEnabled () const
	Returns the enabled state of a key gesture. More...

bool	isGrabbed () const
	Returns the grabbed state of a key gesture. More...

	KeyInputConcept ()=default
	Constructor. More...

	KeyInputConcept (LogicalKey key, KeyModifier modifier, CapsLockState caps)
	Constructor. More...

	KeyInputConcept (LogicalKey key, KeyModifier modifier)
	Constructor. More...

	KeyInputConcept (LogicalKey key)
	Constructor. More...

void	setCapsLock (CapsLockState capsLock)
	Sets the required Caps Lock state for the key gesture. More...

void	setCapsLockGrabbed (bool capsLock)
	Sets whether the Caps Lock mode of the keyboard is on at the time Kanzi grabs the key gesture. More...

void	setEnabled (bool enabled)
	Sets the enabled state of the key gesture. More...

void	setGrabbed (bool grabbed)
	Sets the grabbed state of the key gesture. More...

void	setKey (LogicalKey key, KeyModifier modifiers)
	Sets the key gesture composing elements to handle. More...

void	setKey (LogicalKey key)
	Sets the key gesture composed of a logical key value with no key modifier. More...

virtual	~KeyInputConcept ()=default
	Destructor. More...

Public Member Functions inherited from kanzi::KeyRepeatConceptImpl< KeyManipulator >
void	setKeyRepeatDetectionMode (DetectionMode mode)
	Sets the key-hold and key-repeat gesture detection mode. More...

	~KeyRepeatConceptImpl () override
	Destructor. More...

Public Member Functions inherited from kanzi::KeyRepeatConcept
chrono::milliseconds	getKeyHoldTimeout () const
	Returns the time, in milliseconds, that Kanzi waits before it detects a key-hold gesture. More...

DetectionMode	getKeyRepeatDetectionMode () const
	Returns the current key-hold and key-repeat gesture detection mode. More...

chrono::milliseconds	getKeyRepeatInterval () const
	Returns the time, in milliseconds, between key-repeat gesture notifications that Kanzi sends repeatedly. More...

void	setKeyHoldTimeout (chrono::milliseconds timeout)
	Sets the time that Kanzi waits to detect a key-hold gesture. More...

void	setKeyRepeatInterval (chrono::milliseconds interval)
	Sets the time between the key-repeat gesture notifications that Kanzi sends repeatedly. More...

virtual	~KeyRepeatConcept ()=default
	Destructor. More...

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

Detailed Description

KeyManipulator class is a key input manipulator that detects key gestures.

Kanzi recognizes a key gesture when it receives an event with a key code and an optional key modifier. When Kanzi recognizes a key gesture, an input manipulator:

Grabs the gesture.
Enters the StateBegin state.
Dispatches to an attached node the KeyPressedMessage with the logical key value and the pressed key modifiers.

The input manipulator that grabs a key gesture continues to stay in the StateBegin state until it receives a key up event with a logical key value, or a key modifier that forms a key gesture.

The key input manipulators are exclusive input manipulators. To handle different key gestures, you can add multiple key manipulators.

Since: Kanzi 3.8.0

Member Typedef Documentation

using kanzi::KeyManipulator::RepeatGesture = KeyRepeatConceptImpl<KeyManipulator>

protected

Constructor & Destructor Documentation

kanzi::KeyManipulator::KeyManipulator ( Domain * domain )

explicitprotected

Constructor.

Member Function Documentation

static KeyManipulatorSharedPtr kanzi::KeyManipulator::create	(	Domain *	domain,
		string_view	= `""`
	)

inlinestatic

Creates a KeyManipulator instance.

Parameters

domain	The domain to which the KeyManipulator instance belongs.
name	The name of the input manipulator.

static KeyManipulatorSharedPtr kanzi::KeyManipulator::create	(	Domain *	domain,
		LogicalKey	key,
		KeyModifier	modifier = `KeyModifier::Undefined`,
		string_view	= `""`
	)

inlinestatic

Convenience function, creates a KeyManipulator with the logical key and key modifier.

Parameters

domain	The domain to which the KeyManipulator instance belongs.
key	The logical key value to handle.
modifier	The key modifiers to handle. If no modifier is required, pass KeyModifier::Undefined.
name	The name of the input manipulator.

bool kanzi::KeyManipulator::notifyKeyInput ( const KeyEvent & event )

overrideprotectedvirtual

Overrides InputManipulator::notifyKeyInput().

Reimplemented from kanzi::InputManipulator.

void kanzi::KeyManipulator::onCancel ( )

overrideprotectedvirtual

Overrides InputManipulator::onCancel().

Reimplemented from kanzi::InputManipulator.

void kanzi::KeyManipulator::onReset ( )

overrideprotectedvirtual

Overrides InputManipulator::onReset().

Reimplemented from kanzi::InputManipulator.

void kanzi::KeyManipulator::notifyPartialKeyPressGesture ( KeyInputConcept & )

protected

KeyInputConceptImpl calls this method to notify a key manipulator that it detected a partial key press gesture.

void kanzi::KeyManipulator::notifyKeyPressGesture ( KeyInputConcept & )

protected

KeyInputConceptImpl calls this method to notify a key manipulator that it detected a full key press gesture.

void kanzi::KeyManipulator::notifyKeyReleaseGesture ( KeyInputConcept & )

protected

KeyInputConceptImpl calls this method to notify a key manipulator that it detected a key release gesture.

void kanzi::KeyManipulator::notifyKeyHoldGesture ( )

protected

KeyRepeatConceptImpl calls this method to notify a key manipulator that it detected a key hold gesture.

void kanzi::KeyManipulator::notifyKeyRepeatGesture ( )

protected

KeyRepeatConceptImpl calls this method to notify a key manipulator that it detected a key repeat gesture.

Friends And Related Function Documentation

friend class KeyInputGestureDetector< KeyManipulator, KeyInputConcept >

friend

KeyInputGestureDetector needs access to protected methods when it calls the notifier functions.

friend class KeyRepeatConceptImpl< KeyManipulator >

friend

KeyRepeatConceptImpl needs access to protected methods when it calls the notifier functions.

Member Data Documentation

MessageType<KeyPressedMessageArguments> kanzi::KeyManipulator::KeyPressedMessage

static

Kanzi dispatches this message to the attached node when the user presses a gesture.

MessageType<KeyReleasedMessageArguments> kanzi::KeyManipulator::KeyReleasedMessage

static

Kanzi dispatches this message to the attached node when the user releases a gesture.

MessageType<KeyCanceledMessageArguments> kanzi::KeyManipulator::KeyCanceledMessage

static

Kanzi dispatches this message to the attached node when the user cancels a gesture.

bool kanzi::KeyManipulator::m_capsLock

protected

Caps Lock state for the current key input event.

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

kanzi/core.ui/input/key_manipulator.hpp


Kanzi Engine API

Classes

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation