HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Data Fields | Friends
v1::keyboard_event Struct Reference

Public Types

enum class  Type : uint8_t { Idle , partial_grapheme , grapheme , Key }
 

Public Member Functions

 keyboard_event (Type type=Type::Idle) noexcept
 
 keyboard_event (KeyboardState state, keyboard_modifiers modifiers, keyboard_virtual_key key) noexcept
 Create a key-key keyboard event.
 
 keyboard_event (hi::grapheme grapheme, bool full=true) noexcept
 
std::vector< command > const & getCommands () const noexcept
 

Data Fields

Type type
 
KeyboardState state
 
hi::grapheme grapheme
 
keyboard_key key
 

Friends

std::string to_string (keyboard_event const &rhs) noexcept
 
std::ostreamoperator<< (std::ostream &lhs, keyboard_event const &rhs)
 

Member Enumeration Documentation

◆ Type

enum class v1::keyboard_event::Type : uint8_t
strong
Enumerator
partial_grapheme 

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

◆ keyboard_event()

v1::keyboard_event::keyboard_event ( KeyboardState state,
keyboard_modifiers modifiers,
keyboard_virtual_key key )
inlinenoexcept

Create a key-key keyboard event.


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