Struct KeyboardHandlerWindowsImpl::WinKeyCode

Defined in File keyboard_handler_windows_impl.hpp

Nested Relationships

This struct is a nested type of Class KeyboardHandlerWindowsImpl.

Struct Documentation

struct WinKeyCode

Data type for representing key codes returning by _getch() function in response to the pressing keyboard keys.

Windows OS could return up to two integer values in response to the pressing keyboard key combination. If Windows returning only one value it will be placed in first field and second field will be initialized with NOT_A_KEY value.

Public Functions

inline bool operator==(const WinKeyCode &rhs) const

Equality operator for comparison of two WinKeyCodes.

Parameters: rhs – Value for comparison from right hand side.
Returns: Returns true if two key codes are equal, otherwise false.

inline bool operator!=(const WinKeyCode &rhs) const

Not equal operator for comparison of two WinKeyCodes.

Parameters: rhs – Value for comparison from right hand side.
Returns: Returns true if two key codes are not equal, otherwise false.

Public Members

int first

int second

Public Static Attributes

static constexpr int NOT_A_KEY = -1: Predefined value which is corresponding to the invalid or empty value for WinKeyCode elements.