kanzi::Keyboard Class Reference

Keyboard declares the messages dispatched to the nodes when Kanzi handles a hardware key event. More...

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

Classes
class	KeyDownMessageArguments
	Message arguments used by the KeyDownMessage. More...
class	KeyStateChangedMessageArguments
	Represents base message arguments for key state change messages. More...
class	KeyUpMessageArguments
	Message arguments used by the KeyUpMessage. More...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Creates the property editor info for the Keyboard. More...

Static Public Attributes
static MessageType< KeyDownMessageArguments >	KeyDownMessage
	Kanzi dispatches this message to a node when the user presses a key. More...
static MessageType< KeyUpMessageArguments >	KeyUpMessage
	Kanzi dispatches this message to a node when the user releases a key. More...

Detailed Description

Keyboard declares the messages dispatched to the nodes when Kanzi handles a hardware key event.

The key events handled by Kanzi are the press and release events. These key events are converted into KeyDownMessage and KeyUpMessage, that includes the translated logical key value and the key modifiers. Key modifiers are special keys that modify the logical key meaning when pressed together with that logical key.

Deprecated:

In Kanzi 3.8. To handle key messages, use KeyManipulator.

Member Function Documentation

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::Keyboard::makeEditorInfo ( )

static

Creates the property editor info for the Keyboard.

Member Data Documentation

KeyDownMessage

MessageType<KeyDownMessageArguments> kanzi::Keyboard::KeyDownMessage

static

Kanzi dispatches this message to a node when the user presses a key.

The KeyDownMessageArguments holds the pressed logical key value and key modifiers.

Deprecated:

In Kanzi 3.8. To handle key presses, use KeyManipulator::KeyPressedMessage.

KeyUpMessage

MessageType<KeyUpMessageArguments> kanzi::Keyboard::KeyUpMessage

static

Kanzi dispatches this message to a node when the user releases a key.

The KeyUpMessageArguments holds the released logical key value and key modifiers.

Deprecated:

In Kanzi 3.8. To handle key releases, use KeyManipulator::KeyReleasedMessage.

---

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

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