kanzi::TextInputGesture Struct Reference

The text input key gesture. More...

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

Inheritance diagram for kanzi::TextInputGesture:

Public Types
using	KeyGestureFunction
	Type of the function associated to a key gesture.

Public Member Functions
void	cancel (TextInputManipulator &manipulator)
	Activates the function associated to the key-cancel gesture.
void	press (TextInputManipulator &manipulator)
	Activates the function associated to the key-press gesture.
void	release (TextInputManipulator &manipulator)
	Activates the function associated to the key-release gesture.
	TextInputGesture (LogicalKey key, KeyModifier modifier, KeyGestureFunction onPressed, KeyGestureFunction onReleased, KeyGestureFunction onCanceled, bool allowedOnReadOnly)
	Constructor.
Public Member Functions inherited from kanzi::KeyGestureInfo
void	grab ()
	Grabs the key gesture, increases the grab count by 1.
bool	isGrabbed () const
	Returns whether the key gesture is grabbed.
	KeyGestureInfo ()=default
	Default constructor.
	KeyGestureInfo (LogicalKey key)
	Constructor.
	KeyGestureInfo (LogicalKey key, CapsLockState capsLockState)
	Constructor.
	KeyGestureInfo (LogicalKey key, KeyModifier modifier)
	Constructor.
	KeyGestureInfo (LogicalKey key, KeyModifier modifier, CapsLockState capsLockState)
	Constructor.
void	ungrab ()
	Resets the grab count of the key gesture.

Public Attributes
const bool	allowedOnReadOnly
	Indicates whether a gesture is available on read-only Text Box nodes.
KeyGestureFunction	onCancel
	Kanzi calls this method when the user cancels a key gesture.
KeyGestureFunction	onPress
	Kanzi calls this method when it detects the key-pressed gesture.
KeyGestureFunction	onRelease
	Kanzi calls this method when it detects the key-released gesture.
Public Attributes inherited from kanzi::KeyGestureInfo
CapsLockState	capsLockState
	Holds the required Caps Lock state for the key gesture.
const KeyEvent *	grabbedKeyEvent
	The grabbed key event.
size_t	grabCount
	Holds the grab count of the key gesture.
bool	isCapsLockGrabbed
	Holds the Caps Lock state at the time Kanzi grabs the key gesture.
bool	isHandled
	Holds the handled state of the key gesture.
LogicalKey	key
	The logical key value.
KeyModifier	modifier
	The key modifier.
size_t	repeatCount
	Holds the key press repetition count.

Detailed Description

The text input key gesture.

Since

Kanzi 3.9.0

Member Typedef Documentation

KeyGestureFunction

using kanzi::TextInputGesture::KeyGestureFunction

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:

• kanzi/core.ui/input/text_input_manipulator.hpp