DOSBox-X
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types | Public Member Functions | Public Attributes
GUI::Key Class Reference

Identifies a keyboard key. More...

#include <gui_tk.h>

List of all members.

Public Types

enum  Special {
  None, F1, F2, F3,
  F4, F5, F6, F7,
  F8, F9, F10, F11,
  F12, Up, Down, Left,
  Right, Backspace, Tab, Backtab,
  Enter, Escape, Home, End,
  PageUp, PageDown, Insert, Delete,
  Menu, Print, Pause, Break,
  CapsLock, NumLock, ScrollLock, Alt,
  Ctrl, Shift, Windows
}
 Special keyboard keys. More...

Public Member Functions

 Key (GUI::Char character, Special special, bool shift, bool ctrl, bool alt, bool windows)
 Constructor.

Public Attributes

Char character
 Translated character value.
enum GUI::Key::Special special
bool shift
 Set if the Shift key is currently down.
bool ctrl
 Set if the Ctrl key is currently down.
bool alt
 Set if the Alt (PC) or Meta (classic Unix) key is currently down.
bool windows
 Set if the "Windows"/Meta (PC) or Super (classic Unix) key is currently down.

Detailed Description

Identifies a keyboard key.

Definition at line 270 of file gui_tk.h.


Member Enumeration Documentation

Special keyboard keys.

It is modeled after PC keyboards. When you feed keyboard events to a GUI::Screen, try to map native keys to this set. Some special keys have a character value. Set to None if the key has no special meaning.

Definition at line 280 of file gui_tk.h.


Member Data Documentation

Translated character value.

No encoding is implied. The Font that is used to display this character determines the appearance.

Definition at line 275 of file gui_tk.h.

Referenced by GUI::Input::keyDown(), GUI::Button::keyDown(), GUI::Checkbox::keyDown(), GUI::Radiobox::keyDown(), GUI::Button::keyUp(), GUI::Checkbox::keyUp(), and GUI::Radiobox::keyUp().

Set if the "Windows"/Meta (PC) or Super (classic Unix) key is currently down.

Do not depend too heavily on this, as many keyboards and systems do not have such a key.

Definition at line 296 of file gui_tk.h.

Referenced by GUI::Window::keyDown(), GUI::Button::keyUp(), GUI::Checkbox::keyUp(), and GUI::Radiobox::keyUp().


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