tt::KeyboardEvent Struct Reference

Public Types
enum class	Type : uint8_t {   Idle , Entered , Exited , PartialGrapheme ,   Grapheme , Key }

Public Member Functions
	KeyboardEvent (Type type=Type::Idle) noexcept
	KeyboardEvent (KeyboardState state, KeyboardModifiers modifiers, KeyboardVirtualKey key) noexcept
	Create a key-key keyboard event.
	KeyboardEvent (Grapheme grapheme, bool full=true) noexcept
std::vector< string_ltag > const &	getCommands () const noexcept

Static Public Member Functions
static KeyboardEvent	entered () noexcept
static KeyboardEvent	exited () noexcept

Data Fields
Type	type
KeyboardState	state
Grapheme	grapheme
KeyboardKey	key

Friends
std::string	to_string (KeyboardEvent const &rhs) noexcept
std::ostream &	operator<< (std::ostream &lhs, KeyboardEvent const &rhs)

Member Enumeration Documentation

Type

enum class tt::KeyboardEvent::Type : uint8_t

strong

Enumerator
Entered	Keyboard focus was given.
Exited	Keyboard focus was taken away.
PartialGrapheme	The user is combining a grapheme.
Grapheme	The user has finished entering a grapheme.
Key	Key (+modifiers) was used to send a key.

Constructor & Destructor Documentation

KeyboardEvent()

tt::KeyboardEvent::KeyboardEvent ( KeyboardState state, KeyboardModifiers modifiers, KeyboardVirtualKey key )

inlinenoexcept

Create a key-key keyboard event.

---

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

• hikogui/src/TTauri/GUI/KeyboardEvent.hpp