Kanzi  3.9.4
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::KeyGestureInfo
void grab ()
 Grabs the key gesture, increases the grab count by 1. More...
 
bool isGrabbed () const
 Returns whether the key gesture is grabbed. More...
 
 KeyGestureInfo ()=default
 Default constructor. More...
 
 KeyGestureInfo (LogicalKey key, KeyModifier modifier, CapsLockState capsLockState)
 Constructor. More...
 
 KeyGestureInfo (LogicalKey key, CapsLockState capsLockState)
 Constructor. More...
 
 KeyGestureInfo (LogicalKey key, KeyModifier modifier)
 Constructor. More...
 
 KeyGestureInfo (LogicalKey key)
 Constructor. More...
 
void ungrab ()
 Resets the grab count of the key gesture. More...
 

Public Attributes

bool isEnabled
 The enabled state of the navigation gesture. More...
 
NavigationDirection navigationDirection
 The navigation direction identifier of the gesture. More...
 
- Public Attributes inherited from kanzi::KeyGestureInfo
CapsLockState capsLockState
 Holds the required Caps Lock state for the key gesture. More...
 
size_t grabCount
 Holds the grab count of the key gesture. More...
 
bool isCapsLockGrabbed
 Holds the Caps Lock state at the time Kanzi grabs the key gesture. More...
 
LogicalKey key
 The logical key value. More...
 
KeyModifier modifier
 The key modifier. More...
 
size_t repeatCount
 Holds the key press repetition count. More...
 

Detailed Description

Declares a navigation gesture.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ NavigationGesture()

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

Member Data Documentation

◆ navigationDirection

NavigationDirection kanzi::NavigationGesture::navigationDirection

The navigation direction identifier of the gesture.

◆ isEnabled

bool kanzi::NavigationGesture::isEnabled

The enabled state of the navigation gesture.


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