Static Public Member Functions

KeyboardButton Class Reference

This class is just used as a convenient namespace for grouping all of these handy functions that return buttons which map to standard keyboard keys. More...

#include "keyboardButton.h"

List of all members.

Static Public Member Functions

static ButtonHandle alt ()
static ButtonHandle ascii_key (char ascii_equivalent)
 Returns the ButtonHandle associated with the particular ASCII character, if there is one, or ButtonHandle::none() if there is not.
static ButtonHandle ascii_key (const string &ascii_equivalent)
 Returns the ButtonHandle associated with the particular ASCII character (taken from the first character of the indicated string), if there is one, or ButtonHandle::none() if there is not.
static ButtonHandle backspace ()
static ButtonHandle caps_lock ()
static ButtonHandle control ()
static ButtonHandle del ()
static ButtonHandle down ()
static ButtonHandle end ()
static ButtonHandle enter ()
static ButtonHandle escape ()
static ButtonHandle f1 ()
static ButtonHandle f10 ()
static ButtonHandle f11 ()
static ButtonHandle f12 ()
static ButtonHandle f13 ()
static ButtonHandle f14 ()
static ButtonHandle f15 ()
static ButtonHandle f16 ()
static ButtonHandle f2 ()
static ButtonHandle f3 ()
static ButtonHandle f4 ()
static ButtonHandle f5 ()
static ButtonHandle f6 ()
static ButtonHandle f7 ()
static ButtonHandle f8 ()
static ButtonHandle f9 ()
static ButtonHandle help ()
static ButtonHandle home ()
static void init_keyboard_buttons ()
 This is intended to be called only once, by the static initialization performed in config_util.cxx.
static ButtonHandle insert ()
static ButtonHandle lalt ()
static ButtonHandle lcontrol ()
static ButtonHandle left ()
static ButtonHandle lshift ()
static ButtonHandle meta ()
static ButtonHandle num_lock ()
static ButtonHandle page_down ()
static ButtonHandle page_up ()
static ButtonHandle pause ()
static ButtonHandle print_screen ()
static ButtonHandle ralt ()
static ButtonHandle rcontrol ()
static ButtonHandle right ()
static ButtonHandle rshift ()
static ButtonHandle scroll_lock ()
static ButtonHandle shift ()
static ButtonHandle shift_lock ()
static ButtonHandle space ()
static ButtonHandle tab ()
static ButtonHandle up ()

Detailed Description

This class is just used as a convenient namespace for grouping all of these handy functions that return buttons which map to standard keyboard keys.

Definition at line 28 of file keyboardButton.h.

Member Function Documentation

ButtonHandle KeyboardButton::ascii_key ( char  ascii_equivalent) [static]

Returns the ButtonHandle associated with the particular ASCII character, if there is one, or ButtonHandle::none() if there is not.

Definition at line 28 of file keyboardButton.cxx.

References ButtonRegistry::find_ascii_button(), and ButtonRegistry::ptr().

Referenced by RocketInputHandler::get_rocket_key(), and x11GraphicsWindow::map_button().

ButtonHandle KeyboardButton::ascii_key ( const string &  ascii_equivalent) [static]

Returns the ButtonHandle associated with the particular ASCII character (taken from the first character of the indicated string), if there is one, or ButtonHandle::none() if there is not.

Definition at line 41 of file keyboardButton.cxx.

References ButtonRegistry::find_ascii_button(), ButtonHandle::none(), and ButtonRegistry::ptr().

void KeyboardButton::init_keyboard_buttons ( ) [static]

This is intended to be called only once, by the static initialization performed in config_util.cxx.

Definition at line 111 of file keyboardButton.cxx.

References ButtonHandle::none(), ButtonRegistry::ptr(), and ButtonRegistry::register_button().

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