Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::TextInputGesture Struct Reference

The text input key gesture. More...

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

Inheritance diagram for kanzi::TextInputGesture:
[legend]

Public Types

using KeyGestureFunction = void(TextInputManipulator::*)()
 Type of the function associated to a key gesture. More...
 

Public Member Functions

void cancel (TextInputManipulator &manipulator)
 Activates the function associated to the key-cancel gesture. More...
 
void press (TextInputManipulator &manipulator)
 Activates the function associated to the key-press gesture. More...
 
void release (TextInputManipulator &manipulator)
 Activates the function associated to the key-release gesture. More...
 
 TextInputGesture (LogicalKey key, KeyModifier modifier, KeyGestureFunction onPressed, KeyGestureFunction onReleased, KeyGestureFunction onCanceled, bool allowedOnReadOnly)
 Constructor. More...
 
- 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

const bool allowedOnReadOnly
 Indicates whether a gesture is available on read-only Text Box nodes. More...
 
KeyGestureFunction onCancel
 Kanzi calls this method when the user cancels a key gesture. More...
 
KeyGestureFunction onPress
 Kanzi calls this method when it detects the key-pressed gesture. More...
 
KeyGestureFunction onRelease
 Kanzi calls this method when it detects the key-released 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

The text input key gesture.

Since
Kanzi 3.9.0

Member Typedef Documentation

◆ KeyGestureFunction

using kanzi::TextInputGesture::KeyGestureFunction = void (TextInputManipulator::*)()

Type of the function associated to a key gesture.

Constructor & Destructor Documentation

◆ TextInputGesture()

kanzi::TextInputGesture::TextInputGesture ( LogicalKey  key,
KeyModifier  modifier,
KeyGestureFunction  onPressed,
KeyGestureFunction  onReleased,
KeyGestureFunction  onCanceled,
bool  allowedOnReadOnly 
)
inlineexplicit

Constructor.

Member Function Documentation

◆ press()

void kanzi::TextInputGesture::press ( TextInputManipulator manipulator)
inline

Activates the function associated to the key-press gesture.

◆ release()

void kanzi::TextInputGesture::release ( TextInputManipulator manipulator)
inline

Activates the function associated to the key-release gesture.

◆ cancel()

void kanzi::TextInputGesture::cancel ( TextInputManipulator manipulator)
inline

Activates the function associated to the key-cancel gesture.

Member Data Documentation

◆ onPress

KeyGestureFunction kanzi::TextInputGesture::onPress

Kanzi calls this method when it detects the key-pressed gesture.

◆ onRelease

KeyGestureFunction kanzi::TextInputGesture::onRelease

Kanzi calls this method when it detects the key-released gesture.

◆ onCancel

KeyGestureFunction kanzi::TextInputGesture::onCancel

Kanzi calls this method when the user cancels a key gesture.

◆ allowedOnReadOnly

const bool kanzi::TextInputGesture::allowedOnReadOnly

Indicates whether a gesture is available on read-only Text Box nodes.


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