Terminal++ 3.1.0.4
A C++ library for interacting with ANSI terminal windows
Loading...
Searching...
No Matches
Public Types | Public Attributes | Friends | List of all members
terminalpp::virtual_key Struct Reference

A class that represents a keypress, possibly combined with modifiers such as shift, ctrl, etc. More...

#include <virtual_key.hpp>

Public Types

using input_sequence = std::variant< byte, control_sequence >
 A virtual key is generated from either a single character or some control sequence that represents the key.
 

Public Attributes

vk key = vk::nul
 The actual key we believe was pressed, selected from the list of VK constants.
 
vk_modifier modifiers = vk_modifier::none
 Any modifiers for the key, such as shift, ctrl, alt, meta, etc.
 
int repeat_count = 0
 The repeat count of the character.
 
input_sequence sequence
 The actual received data for the key.
 

Friends

constexpr friend auto operator<=> (virtual_key const &lhs, virtual_key const &rhs) noexcept=default
 Relational operators for virtual keys.
 

Detailed Description

A class that represents a keypress, possibly combined with modifiers such as shift, ctrl, etc.


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