Kanzi  3.9.7
Kanzi Engine API
kanzi::KeyManipulator Class Reference

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

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

Public Member Functions

CapsLockState getCapsLock () const
 Returns the required Caps Lock state for the key gesture. More...
 
pair< LogicalKey, KeyModifiergetKey () const
 Returns the composing elements of a key gesture. More...
 
void setCapsLock (CapsLockState capsLock)
 Sets the required Caps Lock state for 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...
 
- Public Member Functions inherited from kanzi::InputManipulator
void attach (Node &node)
 Attaches an input manipulator to a node. More...
 
void cancel ()
 Notify manipulator of touch canceling. More...
 
void detach ()
 Detaches an input manipulator. More...
 
NodegetAttachedNode () const
 Gets the node to which the input manipulator is attached. More...
 
InputManipulatorgetDependantManipulator () 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
 Returns whether an input manipulator is in a cancelable state. More...
 
bool isResettable () const
 Returns 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...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () 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 addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers. More...
 
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 (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
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)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
virtual ~PropertyObject ()
 

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 MetaclassgetStaticMetaclass ()
 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 MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Static Public Attributes

static MessageType< KeyCanceledMessageArgumentsKeyCanceledMessage
 Kanzi dispatches this message to the attached node when the user cancels a gesture. More...
 
static MessageType< KeyPressedMessageArgumentsKeyPressedMessage
 Kanzi dispatches this message to the attached node when the user presses a gesture. More...
 
static MessageType< KeyReleasedMessageArgumentsKeyReleasedMessage
 Kanzi dispatches this message to the attached node when the user releases a gesture. More...
 

Protected Member Functions

 KeyManipulator (Domain *domain)
 Constructor. More...
 
bool notifyKeyInput (const KeyEvent &event) override
 Overrides InputManipulator::notifyKeyInput(). More...
 
void onCancel () override
 Overrides InputManipulator::onCancel(). More...
 
void onKeyPressGesture (KeyGestureInfo &) override
 Overrides InputManipulator::onKeyPressGesture(). More...
 
void onKeyReleaseGesture (KeyGestureInfo &) override
 Overrides InputManipulator::onKeyPressGesture(). 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...
 
bool detectKeyGesture (const KeyEvent &event, KeyGestureInfo &gesture)
 Detects key gestures from the event that you pass as an argument. More...
 
Node2DfindNearestParent2D ()
 Find the 2D manipulator node for this input manipulator. More...
 
InputManagergetInputManager () 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...
 
virtual bool isResettableOverride () const
 Overridable check for the resettable status of an input manipulator. More...
 
void markTouchPointConsumed (const TouchPoint &touchPoint)
 Marks the passed touch point handled. 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...
 
virtual void onPartialKeyPressGesture (KeyGestureInfo &gesture)
 The detectKeyGesture() method calls this method when it detects a partial key press gesture. 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::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them. More...
 
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::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (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...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage. More...
 
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 validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers. More...
 

Protected Attributes

bool m_capsLock
 Caps Lock state for the current key input event. More...
 
KeyGestureInfo m_gesture
 The key gesture handled. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. 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< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. 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:

  1. Grabs the gesture.
  2. Enters the StateBegin state.
  3. 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.

To handle the press and release of the A key:

auto keyManipulator = KeyManipulator::create(getDomain());
anyNode->addInputManipulator(keyManipulator);
keyManipulator->setKey(LogicalKey::A);
auto onKeyPressed = [](auto&)
{
// Handle the key press.
};
anyNode->addMessageHandler(KeyManipulator::KeyPressedMessage, onKeyPressed);
auto onKeyReleased = [](auto&)
{
// Handle the key release.
};
anyNode->addMessageHandler(KeyManipulator::KeyReleasedMessage, onKeyReleased);

To handle the Left Control modifier key as a key gesture:

keyManipulator->setKey(LogicalKey::LeftControl);

To handle a key gesture composed of the Shift + A keys:

keyManipulator->setKey(LogicalKey::A, KeyModifier::Shift);

To handle the Left Alt + Left Control modifier keys, set the Left Alt as modifier key:

The key press order matters. Pressing Left Control first and then Left Alt does not result in the same key gesture as pressing first Left Alt, then Left Control. To handle the Left Control + Left Alt key gesture:

Since
Kanzi 3.8.0

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
domainThe domain to which the KeyManipulator instance belongs.
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
domainThe domain to which the KeyManipulator instance belongs.
keyThe logical key value to handle.
modifierThe key modifiers to handle. If no modifier is required, pass KeyModifier::Undefined.
void kanzi::KeyManipulator::setKey ( LogicalKey  key,
KeyModifier  modifiers 
)

Sets the key gesture composing elements to handle.

Parameters
keyThe logical key value to handle.
modifiersThe key modifiers to handle. If no modifier is required, pass KeyModifier::Undefined.
void kanzi::KeyManipulator::setKey ( LogicalKey  key)
inline

Sets the key gesture composed of a logical key value with no key modifier.

Override of the setKey() function.

Parameters
keyThe logical key value to handle.
pair<LogicalKey, KeyModifier> kanzi::KeyManipulator::getKey ( ) const

Returns the composing elements of a key gesture.

Returns
A pair containing the logical key as the first, and the key modifiers as the second field.
void kanzi::KeyManipulator::setCapsLock ( CapsLockState  capsLock)
inline

Sets the required Caps Lock state for the key gesture.

Parameters
capsLockThe state that is required for the key gesture.
Since
Kanzi 3.9.0
CapsLockState kanzi::KeyManipulator::getCapsLock ( ) const
inline

Returns the required Caps Lock state for the key gesture.

Since
Kanzi 3.9.0
bool kanzi::KeyManipulator::notifyKeyInput ( const KeyEvent event)
overrideprotectedvirtual
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::onKeyPressGesture ( KeyGestureInfo )
overrideprotectedvirtual
void kanzi::KeyManipulator::onKeyReleaseGesture ( KeyGestureInfo )
overrideprotectedvirtual

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.

KeyGestureInfo kanzi::KeyManipulator::m_gesture
protected

The key gesture handled.

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: