xtd - Reference Guide  0.1.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Public Member Functions | List of all members
xtd::console_key_info Class Referencefinal

#include <console_key_info.h>

Definition

Specifies the standard keys on a console.

Namespace
xtd
Library
xtd.core
See also
Console

Public Member Functions

 console_key_info ()=default
 Create a new instance of console_key_info class. More...
 
 console_key_info (char32_t key_char, console_key key, bool shift, bool alt, bool control)
 Initializes a new instance of the console_key_info class using the specified character, console key, and modifier keys. More...
 
console_key key ()
 Gets the console key represented by the current console_key_info object. More...
 
char32_t key_char ()
 Gets the Unicode character represented by the current console_key_info object. More...
 
console_modifiers modifiers ()
 Gets a bitwise combination of console_modifiers values that specifies one or more modifier keys pressed simultaneously with the console key. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. More...
 
virtual xtd::ustring to_string () const noexcept
 Returns a std::string that represents the current object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 

Constructor & Destructor Documentation

◆ console_key_info() [1/2]

xtd::console_key_info::console_key_info ( )
default

Create a new instance of console_key_info class.

Remarks
This type is not intended to be created by users. Instead, it is returned to the user in response to calling the Console::ReadKey method.
The console_key_info type does not specify whether the left or right SHIFT, ALT, or CTRL modifier key was pressed

◆ console_key_info() [2/2]

xtd::console_key_info::console_key_info ( char32_t  key_char,
console_key  key,
bool  shift,
bool  alt,
bool  control 
)
inline

Initializes a new instance of the console_key_info class using the specified character, console key, and modifier keys.

Parameters
keyCharThe Unicode character that corresponds to the key parameter.
keyThe console key that corresponds to the keyChar parameter.
shifttrue to indicate that a SHIFT key was pressed; otherwise, false.
alttrue to indicate that an ALT key was pressed; otherwise, false.
controltrue to indicate that a CTRL key was pressed; otherwise, false.
Remarks
This type is not intended to be created by users. Instead, it is returned to the user in response to calling the Console::ReadKey method.
The console_key_info type does not specify whether the left or right SHIFT, ALT, or CTRL modifier key was pressed

Member Function Documentation

◆ key()

console_key xtd::console_key_info::key ( )
inline

Gets the console key represented by the current console_key_info object.

Parameters
Aconsole_key value that identifies the console key that was pressed

◆ key_char()

char32_t xtd::console_key_info::key_char ( )
inline

Gets the Unicode character represented by the current console_key_info object.

Parameters
Anchar32 object that corresponds to the console key represented by the current console_key_info object.

◆ modifiers()

console_modifiers xtd::console_key_info::modifiers ( )
inline

Gets a bitwise combination of console_modifiers values that specifies one or more modifier keys pressed simultaneously with the console key.

Parameters
Abitwise combination of console_modifiers values. There is no default value.

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