Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

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

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.

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.

ButtonHandle space ()
ButtonHandle backspace ()
ButtonHandle tab ()
ButtonHandle enter ()
ButtonHandle escape ()
ButtonHandle f1 ()
ButtonHandle f2 ()
ButtonHandle f3 ()
ButtonHandle f4 ()
ButtonHandle f5 ()
ButtonHandle f6 ()
ButtonHandle f7 ()
ButtonHandle f8 ()
ButtonHandle f9 ()
ButtonHandle f10 ()
ButtonHandle f11 ()
ButtonHandle f12 ()
ButtonHandle left ()
ButtonHandle right ()
ButtonHandle up ()
ButtonHandle down ()
ButtonHandle page_up ()
ButtonHandle page_down ()
ButtonHandle home ()
ButtonHandle end ()
ButtonHandle insert ()
ButtonHandle del ()
ButtonHandle shift ()
ButtonHandle control ()
ButtonHandle alt ()
ButtonHandle meta ()
ButtonHandle caps_lock ()
ButtonHandle shift_lock ()
ButtonHandle num_lock ()
ButtonHandle scroll_lock ()
ButtonHandle print_screen ()
void init_keyboard_buttons ()
 This is intended to be called only once, by the static initialization performed in config_util.cxx.

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 40 of file keyboardButton.h.

Member Function Documentation

ButtonHandle KeyboardButton::alt (   )  [static]
 

Definition at line 107 of file keyboardButton.cxx.

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 59 of file keyboardButton.cxx.

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 40 of file keyboardButton.cxx.

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

ButtonHandle KeyboardButton::backspace (   )  [static]
 

Definition at line 73 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::caps_lock (   )  [static]
 

Definition at line 100 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::control (   )  [static]
 

Definition at line 106 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::del (   )  [static]
 

Definition at line 98 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::down (   )  [static]
 

Definition at line 92 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::end (   )  [static]
 

Definition at line 96 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::enter (   )  [static]
 

Definition at line 75 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::escape (   )  [static]
 

Definition at line 76 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f1 (   )  [static]
 

Definition at line 77 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f10 (   )  [static]
 

Definition at line 86 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f11 (   )  [static]
 

Definition at line 87 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f12 (   )  [static]
 

Definition at line 88 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f2 (   )  [static]
 

Definition at line 78 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f3 (   )  [static]
 

Definition at line 79 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f4 (   )  [static]
 

Definition at line 80 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f5 (   )  [static]
 

Definition at line 81 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f6 (   )  [static]
 

Definition at line 82 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f7 (   )  [static]
 

Definition at line 83 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f8 (   )  [static]
 

Definition at line 84 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::f9 (   )  [static]
 

Definition at line 85 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::home (   )  [static]
 

Definition at line 95 of file keyboardButton.cxx.

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 121 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::insert (   )  [static]
 

Definition at line 97 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::left (   )  [static]
 

Definition at line 89 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::meta (   )  [static]
 

Definition at line 99 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::num_lock (   )  [static]
 

Definition at line 103 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::page_down (   )  [static]
 

Definition at line 94 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::page_up (   )  [static]
 

Definition at line 93 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::print_screen (   )  [static]
 

Definition at line 104 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::right (   )  [static]
 

Definition at line 90 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::scroll_lock (   )  [static]
 

Definition at line 102 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::shift (   )  [static]
 

Definition at line 105 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::shift_lock (   )  [static]
 

Definition at line 101 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::space (   )  [static]
 

Definition at line 72 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::tab (   )  [static]
 

Definition at line 74 of file keyboardButton.cxx.

ButtonHandle KeyboardButton::up (   )  [static]
 

Definition at line 91 of file keyboardButton.cxx.

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:51:37 2003 for Panda by doxygen1.3