Kanzi Engine API
kanzi::NavigationGesture Struct Reference

Declares a navigation gesture. More...

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

Inheritance diagram for kanzi::NavigationGesture:
[legend]

Public Member Functions

 NavigationGesture (NavigationDirection navigationDirection, LogicalKey key)
 
- Public Member Functions inherited from kanzi::KeyInputConcept
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...
 
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 Attributes

NavigationDirection navigationDirection
 The navigation direction identifier of the gesture. More...
 

Additional Inherited Members

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

Detailed Description

Declares a navigation gesture.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

kanzi::NavigationGesture::NavigationGesture ( NavigationDirection  navigationDirection,
LogicalKey  key 
)
inlineexplicit

Member Data Documentation

NavigationDirection kanzi::NavigationGesture::navigationDirection

The navigation direction identifier of the gesture.


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