Spinning Topp Logo BlackTopp Studios
inc
Classes | Typedefs | Enumerations | Functions
Mezzanine::Input Namespace Reference

This namespace is for all the classes belonging to the Input Subsystem. More...

Classes

class  ButtonDevice
 This is a base class for all input devices with buttons. More...
 
class  Controller
 This class represents a controller input device, such as a gamepad or joystick. More...
 
class  DefaultInputManagerFactory
 A factory responsible for the creation and destruction of the default inputmanager. More...
 
class  Device
 This is a base class for all input devices. More...
 
class  DeviceUpdateWorkUnit
 This is a Mezzanine::Threading::iWorkUnit for the updating of the physics debug drawer. More...
 
class  InputManager
 This is the manager responsible for the handling of input devices and events. More...
 
class  InputManagerInternalData
 This is an class for the handling of internal input data. More...
 
class  Keyboard
 This class represents the keyboard input device. ////////////////////////////////////. More...
 
class  MetaCode
 This Determines the kind of user input. More...
 
class  MetaCodeKey
 A key class for MetaCodes to be used in associative containers. More...
 
class  Mouse
 This class represents the mouse input device. More...
 
class  SequenceContainer
 This class stores and provides utilities for sequenced inputs and their operations. More...
 

Typedefs

typedef InputManagerInternalData::ControllerIterator InternalControlIterator
 
typedef InputManagerInternalData::ControllerPair InternalControlPair
 

Enumerations

enum  ButtonState { BUTTON_LIFTING = 1, BUTTON_UP = 2, BUTTON_PRESSING = 4, BUTTON_DOWN = 8 }
 An Optional listing of value that can be used in a metacode to represent the information of a button press. More...
 
enum  DirectionalMotionState { DIRECTIONALMOTION_UPLEFT = 1, DIRECTIONALMOTION_UNCHANGED = 0, DIRECTIONALMOTION_DOWNRIGHT = -1 }
 An Optional listing of values that can be used in a metacode Indicate spin, digital or binary travel in a directionl. More...
 
enum  HatState {
  CONTROLLERHAT_CENTERED = 0, CONTROLLERHAT_UP = 1, CONTROLLERHAT_RIGHT = 2, CONTROLLERHAT_DOWN = 4,
  CONTROLLERHAT_LEFT = 8, CONTROLLERHAT_RIGHTUP = ( CONTROLLERHAT_RIGHT | CONTROLLERHAT_UP ), CONTROLLERHAT_RIGHTDOWN = ( CONTROLLERHAT_RIGHT | CONTROLLERHAT_DOWN ), CONTROLLERHAT_LEFTUP = ( CONTROLLERHAT_LEFT | CONTROLLERHAT_UP ),
  CONTROLLERHAT_LEFTDOWN = ( CONTROLLERHAT_LEFT | CONTROLLERHAT_DOWN )
}
 An optional listing of the possible states a hat on a controller can take. More...
 
enum  InputCode {
  KEY_FIRST = 0, KEY_UNKNOWN = 0, KEY_A = 4, KEY_B = 5,
  KEY_C = 6, KEY_D = 7, KEY_E = 8, KEY_F = 9,
  KEY_G = 10, KEY_H = 11, KEY_I = 12, KEY_J = 13,
  KEY_K = 14, KEY_L = 15, KEY_M = 16, KEY_N = 17,
  KEY_O = 18, KEY_P = 19, KEY_Q = 20, KEY_R = 21,
  KEY_S = 22, KEY_T = 23, KEY_U = 24, KEY_V = 25,
  KEY_W = 26, KEY_X = 27, KEY_Y = 28, KEY_Z = 29,
  KEY_1 = 30, KEY_2 = 31, KEY_3 = 32, KEY_4 = 33,
  KEY_5 = 34, KEY_6 = 35, KEY_7 = 36, KEY_8 = 37,
  KEY_9 = 38, KEY_0 = 39, KEY_RETURN = 40, KEY_ESCAPE = 41,
  KEY_BACKSPACE = 42, KEY_TAB = 43, KEY_SPACE = 44, KEY_MINUS = 45,
  KEY_EQUALS = 46, KEY_LEFTBRACKET = 47, KEY_RIGHTBRACKET = 48, KEY_BACKSLASH = 49,
  KEY_NONUSHASH = 50, KEY_SEMICOLON = 51, KEY_APOSTROPHE = 52, KEY_GRAVE = 53,
  KEY_COMMA = 54, KEY_PERIOD = 55, KEY_SLASH = 56, KEY_CAPSLOCK = 57,
  KEY_F1 = 58, KEY_F2 = 59, KEY_F3 = 60, KEY_F4 = 61,
  KEY_F5 = 62, KEY_F6 = 63, KEY_F7 = 64, KEY_F8 = 65,
  KEY_F9 = 66, KEY_F10 = 67, KEY_F11 = 68, KEY_F12 = 69,
  KEY_PRINTSCREEN = 70, KEY_SCROLLLOCK = 71, KEY_PAUSE = 72, KEY_INSERT = 73,
  KEY_HOME = 74, KEY_PAGEUP = 75, KEY_DELETE = 76, KEY_END = 77,
  KEY_PAGEDOWN = 78, KEY_RIGHT = 79, KEY_LEFT = 80, KEY_DOWN = 81,
  KEY_UP = 82, KEY_NUMLOCKCLEAR = 83, KEY_KP_DIVIDE = 84, KEY_KP_MULTIPLY = 85,
  KEY_KP_MINUS = 86, KEY_KP_PLUS = 87, KEY_KP_ENTER = 88, KEY_KP_1 = 89,
  KEY_KP_2 = 90, KEY_KP_3 = 91, KEY_KP_4 = 92, KEY_KP_5 = 93,
  KEY_KP_6 = 94, KEY_KP_7 = 95, KEY_KP_8 = 96, KEY_KP_9 = 97,
  KEY_KP_0 = 98, KEY_KP_PERIOD = 99, KEY_NONUSBACKSLASH = 100, KEY_APPLICATION = 101,
  KEY_POWER = 102, KEY_KP_EQUALS = 103, KEY_F13 = 104, KEY_F14 = 105,
  KEY_F15 = 106, KEY_F16 = 107, KEY_F17 = 108, KEY_F18 = 109,
  KEY_F19 = 110, KEY_F20 = 111, KEY_F21 = 112, KEY_F22 = 113,
  KEY_F23 = 114, KEY_F24 = 115, KEY_EXECUTE = 116, KEY_HELP = 117,
  KEY_MENU = 118, KEY_SELECT = 119, KEY_STOP = 120, KEY_AGAIN = 121,
  KEY_UNDO = 122, KEY_CUT = 123, KEY_COPY = 124, KEY_PASTE = 125,
  KEY_FIND = 126, KEY_MUTE = 127, KEY_VOLUMEUP = 128, KEY_VOLUMEDOWN = 129,
  KEY_KP_COMMA = 133, KEY_KP_EQUALSAS400 = 134, KEY_INTERNATIONAL1 = 135, KEY_INTERNATIONAL2 = 136,
  KEY_INTERNATIONAL3 = 137, KEY_INTERNATIONAL4 = 138, KEY_INTERNATIONAL5 = 139, KEY_INTERNATIONAL6 = 140,
  KEY_INTERNATIONAL7 = 141, KEY_INTERNATIONAL8 = 142, KEY_INTERNATIONAL9 = 143, KEY_LANG1 = 144,
  KEY_LANG2 = 145, KEY_LANG3 = 146, KEY_LANG4 = 147, KEY_LANG5 = 148,
  KEY_LANG6 = 149, KEY_LANG7 = 150, KEY_LANG8 = 151, KEY_LANG9 = 152,
  KEY_ALTERASE = 153, KEY_SYSREQ = 154, KEY_CANCEL = 155, KEY_CLEAR = 156,
  KEY_PRIOR = 157, KEY_RETURN2 = 158, KEY_SEPARATOR = 159, KEY_OUT = 160,
  KEY_OPER = 161, KEY_CLEARAGAIN = 162, KEY_CRSEL = 163, KEY_EXSEL = 164,
  KEY_KP_00 = 176, KEY_KP_000 = 177, KEY_THOUSANDSSEPARATOR = 178, KEY_DECIMALSEPARATOR = 179,
  KEY_CURRENCYUNIT = 180, KEY_CURRENCYSUBUNIT = 181, KEY_KP_LEFTPAREN = 182, KEY_KP_RIGHTPAREN = 183,
  KEY_KP_LEFTBRACE = 184, KEY_KP_RIGHTBRACE = 185, KEY_KP_TAB = 186, KEY_KP_BACKSPACE = 187,
  KEY_KP_A = 188, KEY_KP_B = 189, KEY_KP_C = 190, KEY_KP_D = 191,
  KEY_KP_E = 192, KEY_KP_F = 193, KEY_KP_XOR = 194, KEY_KP_POWER = 195,
  KEY_KP_PERCENT = 196, KEY_KP_LESS = 197, KEY_KP_GREATER = 198, KEY_KP_AMPERSAND = 199,
  KEY_KP_DBLAMPERSAND = 200, KEY_KP_VERTICALBAR = 201, KEY_KP_DBLVERTICALBAR = 202, KEY_KP_COLON = 203,
  KEY_KP_HASH = 204, KEY_KP_SPACE = 205, KEY_KP_AT = 206, KEY_KP_EXCLAM = 207,
  KEY_KP_MEMSTORE = 208, KEY_KP_MEMRECALL = 209, KEY_KP_MEMCLEAR = 210, KEY_KP_MEMADD = 211,
  KEY_KP_MEMSUBTRACT = 212, KEY_KP_MEMMULTIPLY = 213, KEY_KP_MEMDIVIDE = 214, KEY_KP_PLUSMINUS = 215,
  KEY_KP_CLEAR = 216, KEY_KP_CLEARENTRY = 217, KEY_KP_BINARY = 218, KEY_KP_OCTAL = 219,
  KEY_KP_DECIMAL = 220, KEY_KP_HEXADECIMAL = 221, KEY_LCTRL = 224, KEY_LSHIFT = 225,
  KEY_LALT = 226, KEY_LSUPER = 227, KEY_RCTRL = 228, KEY_RSHIFT = 229,
  KEY_RALT = 230, KEY_RSUPER = 231, KEY_MODE = 257, KEY_AUDIONEXT = 258,
  KEY_AUDIOPREV = 259, KEY_AUDIOSTOP = 260, KEY_AUDIOPLAY = 261, KEY_AUDIOMUTE = 262,
  KEY_MEDIASELECT = 263, KEY_WWW = 264, KEY_MAIL = 265, KEY_CALCULATOR = 266,
  KEY_COMPUTER = 267, KEY_AC_SEARCH = 268, KEY_AC_HOME = 269, KEY_AC_BACK = 270,
  KEY_AC_FORWARD = 271, KEY_AC_STOP = 272, KEY_AC_REFRESH = 273, KEY_AC_BOOKMARKS = 274,
  KEY_BRIGHTNESSDOWN = 275, KEY_BRIGHTNESSUP = 276, KEY_DISPLAYSWITCH = 277, KEY_KBDILLUMTOGGLE = 278,
  KEY_KBDILLUMDOWN = 279, KEY_KBDILLUMUP = 280, KEY_EJECT = 281, KEY_SLEEP = 282,
  KEY_LAST = 379, MOUSE_FIRST = 380, MOUSEBUTTON = 380, MOUSEBUTTON_FIRST = 381,
  MOUSEBUTTON_1 = 381, MOUSEBUTTON_2 = 382, MOUSEBUTTON_3 = 383, MOUSEBUTTON_4 = 384,
  MOUSEBUTTON_5 = 385, MOUSEBUTTON_6 = 386, MOUSEBUTTON_7 = 387, MOUSEBUTTON_8 = 388,
  MOUSEBUTTON_9 = 389, MOUSEBUTTON_10 = 390, MOUSEBUTTON_11 = 391, MOUSEBUTTON_12 = 392,
  MOUSEBUTTON_13 = 393, MOUSEBUTTON_14 = 394, MOUSEBUTTON_15 = 395, MOUSEBUTTON_16 = 396,
  MOUSEBUTTON_17 = 397, MOUSEBUTTON_18 = 398, MOUSEBUTTON_19 = 399, MOUSEBUTTON_20 = 400,
  MOUSEBUTTON_LAST = 400, INPUTEVENT_FIRST = 401, MOUSEMOTION_FIRST = 402, MOUSEABSOLUTEVERTICAL = 402,
  MOUSEABSOLUTEHORIZONTAL = 403, MOUSEVERTICAL = 404, MOUSEHORIZONTAL = 405, MOUSEWHEELVERTICAL = 406,
  MOUSEWHEELHORIZONTAL = 407, MOUSEMOTION_LAST = 410, MOUSE_LAST = 410, MOTION_FIRST = 420,
  MOTION_LAST = 429, MULTITOUCH_FIRST = 440, MULTITOUCH_ACTION = 441, MULTITOUCH_GESTURE = 442,
  MULTITOUCH_PINCH = 443, MULTITOUCH_STRETCH = 444, MULTITOUCH_LAST = 449, CONTROLLER_FIRST = 450,
  CONTROLLERBUTTON = 450, CONTROLLERBUTTON_FIRST = 451, CONTROLLERBUTTON_1 = 451, CONTROLLERBUTTON_2 = 452,
  CONTROLLERBUTTON_3 = 453, CONTROLLERBUTTON_4 = 454, CONTROLLERBUTTON_5 = 455, CONTROLLERBUTTON_6 = 456,
  CONTROLLERBUTTON_7 = 457, CONTROLLERBUTTON_8 = 458, CONTROLLERBUTTON_9 = 459, CONTROLLERBUTTON_10 = 460,
  CONTROLLERBUTTON_11 = 461, CONTROLLERBUTTON_12 = 462, CONTROLLERBUTTON_13 = 463, CONTROLLERBUTTON_14 = 464,
  CONTROLLERBUTTON_15 = 465, CONTROLLERBUTTON_16 = 466, CONTROLLERBUTTON_17 = 467, CONTROLLERBUTTON_18 = 468,
  CONTROLLERBUTTON_19 = 469, CONTROLLERBUTTON_20 = 470, CONTROLLERBUTTON_LAST = 470, CONTROLLERAXIS = 480,
  CONTROLLERAXIS_FIRST = 481, CONTROLLERAXIS_1 = 481, CONTROLLERAXIS_2 = 482, CONTROLLERAXIS_3 = 483,
  CONTROLLERAXIS_4 = 484, CONTROLLERAXIS_5 = 485, CONTROLLERAXIS_6 = 486, CONTROLLERAXIS_7 = 487,
  CONTROLLERAXIS_8 = 488, CONTROLLERAXIS_9 = 489, CONTROLLERAXIS_10 = 490, CONTROLLERAXIS_11 = 491,
  CONTROLLERAXIS_12 = 492, CONTROLLERAXIS_13 = 493, CONTROLLERAXIS_14 = 494, CONTROLLERAXIS_15 = 495,
  CONTROLLERAXIS_16 = 496, CONTROLLERAXIS_17 = 497, CONTROLLERAXIS_18 = 498, CONTROLLERAXIS_19 = 499,
  CONTROLLERAXIS_20 = 500, CONTROLLERAXIS_LAST = 500, CONTROLLERBALL = 501, CONTROLLERBALL_FIRST = 502,
  CONTROLLERBALL_1_VERTICAL = 502, CONTROLLERBALL_1_HORIZONTAL = 503, CONTROLLERBALL_2_VERTICAL = 504, CONTROLLERBALL_2_HORIZONTAL = 505,
  CONTROLLERBALL_LAST = 505, CONTROLLERHAT = 506, CONTROLLERHAT_FIRST = 507, CONTROLLERHAT_1 = 507,
  CONTROLLERHAT_2 = 508, CONTROLLERHAT_3 = 509, CONTROLLERHAT_4 = 510, CONTROLLERHAT_5 = 511,
  CONTROLLERHAT_LAST = 511, CONTROLLER_LAST = 512, COMPOUNDINPUT_FIRST = 768, COMPOUNDINPUT_MOUSEMULTICLICKFIRST = 769,
  COMPOUNDINPUT_MOUSELEFTMULTICLICK = 769, COMPOUNDINPUT_MOUSERIGHTMULTICLICK = 770, COMPOUNDINPUT_MOUSEMULTICLICKLAST = 790, COMPOUNDINPUT_CUSTOMSEQUENCE = 799,
  COMPOUNDINPUT_LAST = 800, OSTEXTINPUT = 900, INPUTEVENT_LAST = 1024
}
 The InputCode enum defines all the posible types of inputs. More...
 
enum  InputDevice {
  DEVICE_UNKNOWN = 0, DEVICE_KEYBOARD = 1, DEVICE_MOUSE = 2, DEVICE_MULTITOUCH = 3,
  DEVICE_CONTROLLER = 4
}
 An enum listing containing the different kind of input devices, useful for some query functions.
 

Functions

Boole ControllerCodeCompare (const MetaCode &First, const MetaCode &Second)
 Function used for sorting controller metacodes. More...
 
String GetClipboardText ()
 Returns system clipboard text. More...
 
Boole KeyboardCodeCompare (const MetaCode &First, const MetaCode &Second)
 Function used for sorting keyboard metacodes. More...
 
Boole MouseCodeCompare (const MetaCode &First, const MetaCode &Second)
 Function used for sorting mouse metacodes. More...
 
Boole MultitouchCodeCompare (const MetaCode &First, const MetaCode &Second)
 Function used for sorting multitouch metacodes. More...
 
Boole SequenceCodeCompare (const MetaCode &First, const MetaCode &Second)
 Function used for sorting controller metacodes. More...
 
void SetClipboardText (const String &ClipboardText)
 Sets system clipboard text. More...
 

Detailed Description

This namespace is for all the classes belonging to the Input Subsystem.

Our Input system uses SDL for the collection of input from windows belonging to Mezzanine.

Enumeration Type Documentation

An Optional listing of value that can be used in a metacode to represent the information of a button press.

This is optional set of values that can make working with buttons easier. The values the engine pass via the the event manager will all use these whereever appropriate.

Enumerator
BUTTON_LIFTING 

Used when the key stops being pressed.

BUTTON_UP 

The default state of a key.

BUTTON_PRESSING 

This is used at the exact point in time that a key goes from unpressed to pressed.

BUTTON_DOWN 

This is used the entire time a key is down.

Definition at line 546 of file inputenumerations.h.

An Optional listing of values that can be used in a metacode Indicate spin, digital or binary travel in a directionl.

This is optional set of values that can make working with the MouseWheel and other items that can be moved along 1 axis in two dirctions easier. The values the engine pass via the the event manager will all use these whereever appropriate.

Enumerator
DIRECTIONALMOTION_UPLEFT 

Optionally Used when the device is spun/moved up or to the left as a MetaValue

DIRECTIONALMOTION_UNCHANGED 

This really isn't used in normal situations, but if a mousewheel or joyhat event is ever needed when the device is unmoved

DIRECTIONALMOTION_DOWNRIGHT 

Optionally Used when the MouseWheel/Joyhat is spun Down/Right as a Meta Code

Definition at line 557 of file inputenumerations.h.

An optional listing of the possible states a hat on a controller can take.

This is optional set of values that can make working with controller hats easier. The values the engine pass via the the event manager will all use these whereever appropriate.

Definition at line 567 of file inputenumerations.h.

The InputCode enum defines all the posible types of inputs.

It has one entry for each key on a most keyboards. Then it has an entry for most mouse and joystick input methods.

Warning
Once upon a time, this partially matched with ascii. It doesn't anymore.
Enumerator
KEY_FIRST 

KEY_FIRST Same Value as KEY_UNKOWN, is Guaranteed to be the lowest value of any key.

KEY_UNKNOWN 

KEY_UNKNOWN This is used for unsupported keys or keys that are not in Unicode.

KEY_BACKSLASH 

Located at the lower left of the return key on ISO keyboards and at the right end of the QWERTY row on ANSI keyboards. Produces REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US layout, REVERSE SOLIDUS and VERTICAL LINE in a UK Mac layout, NUMBER SIGN and TILDE in a UK Windows layout, DOLLAR SIGN and POUND SIGN in a Swiss German layout, NUMBER SIGN and APOSTROPHE in a German layout, GRAVE ACCENT and POUND SIGN in a French Mac layout, and ASTERISK and MICRO SIGN in a French Windows layout.

KEY_NONUSHASH 

ISO USB keyboards actually use this code instead of 49 for the same key, but all OSes I've seen treat the two codes identically. So, as an implementor, unless your keyboard generates both of those codes and your OS treats them differently, you should generate KEY_BACKSLASH instead of this code. As a user, you should not rely on this code because SDL will never generate it with most (all?) keyboards.

KEY_GRAVE 

Located in the top left corner (on both ANSI and ISO keyboards). Produces GRAVE ACCENT and TILDE in a US Windows layout and in US and UK Mac layouts on ANSI keyboards, GRAVE ACCENT and NOT SIGN in a UK Windows layout, SECTION SIGN and PLUS-MINUS SIGN in US and UK Mac layouts on ISO keyboards, SECTION SIGN and DEGREE SIGN in a Swiss German layout (Mac: only on ISO keyboards), CIRCUMFLEX ACCENT and DEGREE SIGN in a German layout (Mac: only on ISO keyboards), SUPERSCRIPT TWO and TILDE in a French Windows layout, COMMERCIAL AT and NUMBER SIGN in a French Mac layout on ISO keyboards, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French Mac layout on ANSI keyboards.

KEY_INSERT 

insert on PC, help on some Mac keyboards (but does send code 73, not 117)

KEY_NUMLOCKCLEAR 

num lock on PC, clear on Mac keyboards

KEY_NONUSBACKSLASH 

This is the additional key that ISO keyboards have over ANSI ones, located between left shift and Y. Produces GRAVE ACCENT and TILDE in a US or UK Mac layout, REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US or UK Windows layout, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French layout.

KEY_APPLICATION 

windows contextual menu, compose

KEY_POWER 

The USB document says this is a status flag, not a physical key - but some Mac keyboards do have a power key.

KEY_AGAIN 

redo

KEY_INTERNATIONAL1 

used on Asian keyboards, see footnotes in USB doc

KEY_INTERNATIONAL3 

Yen

KEY_LANG1 

Hangul/English toggle

KEY_LANG2 

Hanja conversion

KEY_LANG3 

Katakana

KEY_LANG4 

Hiragana

KEY_LANG5 

Zenkaku/Hankaku

KEY_LANG6 

reserved

KEY_LANG7 

reserved

KEY_LANG8 

reserved

KEY_LANG9 

reserved

KEY_ALTERASE 

Erase-Eaze

KEY_LALT 

alt, option

KEY_LSUPER 

windows, command (apple), meta

KEY_RALT 

alt gr, option

KEY_RSUPER 

windows, command (apple), meta

KEY_MODE 

I'm not sure if this is really not covered by any of the above, but since there's a special KMOD_MODE for it I'm adding it here

KEY_DISPLAYSWITCH 

display mirroring/dual display switch, video mode switch

KEY_LAST 

The last Keyboard InputCode, all Keys values will be less than this, and all Events will be larger than that.

MOUSE_FIRST 

The First Mouse event, all Mouse Event values will be more than this.

MOUSEBUTTON 

This is the generic Some mouse button code. You can add the number of the mouse button to this and you will get the approriate code. Example (MOUSEBUTTON_1 == MOUSEBUTTON + 1)

MOUSEBUTTON_FIRST 

This is the lowest mouse button value, all mice values will be larger of equal to this.

MOUSEBUTTON_1 

Most commonly left click.

MOUSEBUTTON_2 

Most Commonly Right click.

MOUSEBUTTON_3 

Most commonly middle click.

MOUSEBUTTON_LAST 

The Last mouse button event, all mouse button event will be lower or equal to this.

INPUTEVENT_FIRST 

The First non-button event, all Mouse and keyboard button values will be Less than this.

MOUSE_LAST 

The last MouseEvent Code, all Mouse events will be less than this.

MOTION_FIRST 

The first Motion event.

MOTION_LAST 

The last Motion event.

MULTITOUCH_FIRST 

The first Multi Touch event.

MULTITOUCH_LAST 

The last Multi Touch event.

CONTROLLER_FIRST 

The First JoyStick event, all Controller Event values will be more than this.

CONTROLLERBUTTON 

This is the generic Some stickbutton button code. You can add the number of the jpystick button to this and you will get the approriate code. Example (JOYSTICKBUTTON_1 == JOYSTICKBUTTON + 1)

CONTROLLERBUTTON_FIRST 

This is the lowest Controller button value, all joystickbutton values will be larger of equal to this.

CONTROLLERBUTTON_LAST 

The Last Controller button event, all Controller button event will be lower or equal to this.

CONTROLLERAXIS 

This is the generic Controller axis code. You can add the number of the Controller axis to this and you will get the approriate code. Example (JOYSTICKAXIS_1 == JOYSTICKAXIS + 1)

CONTROLLERAXIS_FIRST 

This is the lowest Controller axis value, all jpystick values will be larger of equal to this.

CONTROLLERAXIS_LAST 

The Last Controller axis event, all joystick axis event will be lower or equal to this.

CONTROLLER_LAST 

The last Controller Input Code, all Controller events will be less than this.

INPUTEVENT_LAST 

The last Input Code, all event codes will be less than this.

This represents text as detected by the OS as it is supposed to be presented when printed. OS text events are useful for non-english languages where a keystroke can represent multiple characters, or multiple keystrokes can represent a single character. A MetaCode with this type of input code will always represent only one character, but the event that creates it may make multiple MetaCodes.

Definition at line 58 of file inputenumerations.h.

Function Documentation

Boole Mezzanine::Input::ControllerCodeCompare ( const MetaCode First,
const MetaCode Second 
)

Function used for sorting controller metacodes.

Parameters
FirstThe first MetaCode to compare.
SecondThe second MetaCode to compare.
Returns
Returns true if First should be placed before Second, false otherwise.

Definition at line 84 of file metacodekey.cpp.

String Mezzanine::Input::GetClipboardText ( )

Returns system clipboard text.

Returns
Returns system clipboard text. Empty string if none exist.

Definition at line 49 of file inpututilities.cpp.

Boole Mezzanine::Input::KeyboardCodeCompare ( const MetaCode First,
const MetaCode Second 
)

Function used for sorting keyboard metacodes.

Parameters
FirstThe first MetaCode to compare.
SecondThe second MetaCode to compare.
Returns
Returns true if First should be placed before Second, false otherwise.

Definition at line 56 of file metacodekey.cpp.

Boole Mezzanine::Input::MouseCodeCompare ( const MetaCode First,
const MetaCode Second 
)

Function used for sorting mouse metacodes.

Parameters
FirstThe first MetaCode to compare.
SecondThe second MetaCode to compare.
Returns
Returns true if First should be placed before Second, false otherwise.

Definition at line 65 of file metacodekey.cpp.

Boole Mezzanine::Input::MultitouchCodeCompare ( const MetaCode First,
const MetaCode Second 
)

Function used for sorting multitouch metacodes.

Parameters
FirstThe first MetaCode to compare.
SecondThe second MetaCode to compare.
Returns
Returns true if First should be placed before Second, false otherwise.
Todo:
When our support for Multitouch devices expands this may need to be expanded as well.

Definition at line 74 of file metacodekey.cpp.

Boole Mezzanine::Input::SequenceCodeCompare ( const MetaCode First,
const MetaCode Second 
)

Function used for sorting controller metacodes.

Parameters
FirstThe first MetaCode to compare.
SecondThe second MetaCode to compare.
Returns
Returns true if First should be placed before Second, false otherwise.

Definition at line 97 of file metacodekey.cpp.

void Mezzanine::Input::SetClipboardText ( const String ClipboardText)

Sets system clipboard text.

Parameters
ClipboardTextA string containing desired clipboard text.

Definition at line 60 of file inpututilities.cpp.