→ home
 
→ index of namespace default
 
→ index of project tksdl
 
→ index of module tksdl

Class tksdl.Key


Synopsis: Represents a keyboard event

  Base classes:
  Methods:
  Constants:
Method getAlpha
Return (untranslated) ASCII code or 0 if this is a special key event.
Signature
getAlpha():int
Returns
int–

 
→ top of page
Method getCode
Query raw key code
Signature
getCode():int
Returns
int–

 
→ top of page
Method getCodeName
Return raw keycode name
Signature
getCodeName():String
Returns
String–

 
→ top of page
Method getMod
Query modifier mask
Signature
getMod():int
Returns
int–

 
→ top of page
Method getModName
Return modifier mask name
Signature
getModName():String
Returns
String–

 
→ top of page
Method getName
Return full keyevent name
Signature
getName():String
Returns
String–
Description

E.g. "lctrl-c"

 
→ top of page
Method getNameFor
Return full name for given key code and modifier mask.
Signature
getNameFor(intkey,
  intmod 
  )  
 :String
Arguments
intkey–
intmod–
Returns
String–

 
→ top of page
Method getPressed
Query pressed (raw) key code. Returns 0 if this is not a keypress event.
Signature
getPressed():int
Returns
int–

 
→ top of page
Method getReleased
Query release (raw) key code. Return 0 if this is not a keyrelease event.
Signature
getReleased():int
Returns
int–

 
→ top of page
Method getUnicode
Return (translated) unicode char.
Signature
getUnicode():int
Returns
int–
See also:  


 
→ top of page
Method modAlt
Query whether left or right alt key modifiers are used
Signature
modAlt():boolean
Returns
boolean–

 
→ top of page
Method modCaps
Query whether capslock modifier is used
Signature
modCaps():boolean
Returns
boolean–

 
→ top of page
Method modCtrl
Query whether left or right control key modifiers are used
Signature
modCtrl():boolean
Returns
boolean–

 
→ top of page
Method modShift
Query whether left or right shift key modifiers are used
Signature
modShift():boolean
Returns
boolean–

 
→ top of page
Method modShiftOrCaps
Query whether left or right shift key modifiers or capslock is used
Signature
modShiftOrCaps():boolean
Returns
boolean–

 
→ top of page
Method setAlpha
Set (untranslated) ASCII key code
Signature
setAlpha(intc)
Arguments
intc–

 
→ top of page
Method setCode
Set raw keycode.
Signature
setCode(intcode)
Arguments
intcode–
Description

Does not modify press/release mask.

 
→ top of page
Method setCodeName
Set key code by name
Signature
setCodeName(Strings)
Arguments
Strings–

 
→ top of page
Method setMod
Set modifier mask
Signature
setMod(intmod)
Arguments
intmod–

 
→ top of page
Method setModName
Set modifier mask by name
Signature
setModName(Strings)
Arguments
Strings–

 
→ top of page
Method setName
Set key code and modifier mask by name
Signature
setName(Strings)
Arguments
Strings–

 
→ top of page
Method setPressed
Set raw keycode and set pressed flag.
Signature
setPressed(intcode)
Arguments
intcode–

 
→ top of page
Method setReleased
Set raw keycode and set released flag.
Signature
setReleased(intcode)
Arguments
intcode–

 
→ top of page
Method setUnicode
Set unicode char
Signature
setUnicode(intc)
Arguments
intc–
Description

The character will *not* be translated back to its original raw key code!

 
→ top of page
Constant DCON (int)
Constant STDERR (int)
Constant STDOUT (int)
Constant UC_CTRL_A (int)
Constant UC_CTRL_B (int)
Constant UC_CTRL_C (int)
Constant UC_CTRL_D (int)
Constant UC_CTRL_E (int)
Constant UC_CTRL_F (int)
Constant UC_CTRL_G (int)
Constant UC_CTRL_H (int)
Constant UC_CTRL_I (int)
Constant UC_CTRL_J (int)
Constant UC_CTRL_K (int)
Constant UC_CTRL_L (int)
Constant UC_CTRL_M (int)
Constant UC_CTRL_N (int)
Constant UC_CTRL_O (int)
Constant UC_CTRL_P (int)
Constant UC_CTRL_Q (int)
Constant UC_CTRL_R (int)
Constant UC_CTRL_S (int)
Constant UC_CTRL_T (int)
Constant UC_CTRL_U (int)
Constant UC_CTRL_V (int)
Constant UC_CTRL_W (int)
Constant UC_CTRL_X (int)
Constant UC_CTRL_Y (int)
Constant UC_CTRL_Z (int)
Constant VKEY_0 (int)
Constant VKEY_1 (int)
Constant VKEY_2 (int)
Constant VKEY_3 (int)
Constant VKEY_4 (int)
Constant VKEY_5 (int)
Constant VKEY_6 (int)
Constant VKEY_7 (int)
Constant VKEY_8 (int)
Constant VKEY_9 (int)
Constant VKEY_AMPERSAND (int)
Constant VKEY_ASTERISK (int)
Constant VKEY_AT (int)
Constant VKEY_BACKQUOTE (int)
Constant VKEY_BACKSLASH (int)
Constant VKEY_BACKSPACE (int)
Constant VKEY_BREAK (int)
Constant VKEY_CAPSLOCK (int)
Constant VKEY_CARET (int)
Constant VKEY_CLEAR (int)
Constant VKEY_COLON (int)
Constant VKEY_COMMA (int)
Constant VKEY_COMPOSE (int)
Constant VKEY_DELETE (int)
Constant VKEY_DOLLAR (int)
Constant VKEY_DOWN (int)
Constant VKEY_END (int)
Constant VKEY_EQUALS (int)
Constant VKEY_ESCAPE (int)
Constant VKEY_EURO (int)
Constant VKEY_EXCLAIM (int)
Constant VKEY_F1 (int)
Constant VKEY_F10 (int)
Constant VKEY_F11 (int)
Constant VKEY_F12 (int)
Constant VKEY_F13 (int)
Constant VKEY_F14 (int)
Constant VKEY_F15 (int)
Constant VKEY_F2 (int)
Constant VKEY_F3 (int)
Constant VKEY_F4 (int)
Constant VKEY_F5 (int)
Constant VKEY_F6 (int)
Constant VKEY_F7 (int)
Constant VKEY_F8 (int)
Constant VKEY_F9 (int)
Constant VKEY_GREATER (int)
Constant VKEY_HASH (int)
Constant VKEY_HELP (int)
Constant VKEY_HOME (int)
Constant VKEY_INSERT (int)
Constant VKEY_JOY0AXIS0NEG (int)
Constant VKEY_JOY0AXIS0POS (int)
Constant VKEY_JOY0AXIS1NEG (int)
Constant VKEY_JOY0AXIS1POS (int)
Constant VKEY_JOY0BUTTON0 (int)
Constant VKEY_JOY0BUTTON1 (int)
Constant VKEY_JOY0BUTTON2 (int)
Constant VKEY_JOY0BUTTON3 (int)
Constant VKEY_JOY0BUTTON4 (int)
Constant VKEY_JOY0BUTTON5 (int)
Constant VKEY_JOY0BUTTON6 (int)
Constant VKEY_JOY0BUTTON7 (int)
Constant VKEY_JOY0BUTTON8 (int)
Constant VKEY_JOY1AXIS0NEG (int)
Constant VKEY_JOY1AXIS0POS (int)
Constant VKEY_JOY1AXIS1NEG (int)
Constant VKEY_JOY1AXIS1POS (int)
Constant VKEY_JOY1BUTTON0 (int)
Constant VKEY_JOY1BUTTON1 (int)
Constant VKEY_JOY1BUTTON2 (int)
Constant VKEY_JOY1BUTTON3 (int)
Constant VKEY_JOY1BUTTON4 (int)
Constant VKEY_JOY1BUTTON5 (int)
Constant VKEY_JOY1BUTTON6 (int)
Constant VKEY_JOY1BUTTON7 (int)
Constant VKEY_JOY1BUTTON8 (int)
Constant VKEY_JOY2AXIS0NEG (int)
Constant VKEY_JOY2AXIS0POS (int)
Constant VKEY_JOY2AXIS1NEG (int)
Constant VKEY_JOY2AXIS1POS (int)
Constant VKEY_JOY2BUTTON0 (int)
Constant VKEY_JOY2BUTTON1 (int)
Constant VKEY_JOY2BUTTON2 (int)
Constant VKEY_JOY2BUTTON3 (int)
Constant VKEY_JOY2BUTTON4 (int)
Constant VKEY_JOY2BUTTON5 (int)
Constant VKEY_JOY2BUTTON6 (int)
Constant VKEY_JOY2BUTTON7 (int)
Constant VKEY_JOY2BUTTON8 (int)
Constant VKEY_JOY3AXIS0NEG (int)
Constant VKEY_JOY3AXIS0POS (int)
Constant VKEY_JOY3AXIS1NEG (int)
Constant VKEY_JOY3AXIS1POS (int)
Constant VKEY_JOY3BUTTON0 (int)
Constant VKEY_JOY3BUTTON1 (int)
Constant VKEY_JOY3BUTTON2 (int)
Constant VKEY_JOY3BUTTON3 (int)
Constant VKEY_JOY3BUTTON4 (int)
Constant VKEY_JOY3BUTTON5 (int)
Constant VKEY_JOY3BUTTON6 (int)
Constant VKEY_JOY3BUTTON7 (int)
Constant VKEY_JOY3BUTTON8 (int)
Constant VKEY_KP0 (int)
Constant VKEY_KP1 (int)
Constant VKEY_KP2 (int)
Constant VKEY_KP3 (int)
Constant VKEY_KP4 (int)
Constant VKEY_KP5 (int)
Constant VKEY_KP6 (int)
Constant VKEY_KP7 (int)
Constant VKEY_KP8 (int)
Constant VKEY_KP9 (int)
Constant VKEY_KP_DIVIDE (int)
Constant VKEY_KP_ENTER (int)
Constant VKEY_KP_EQUALS (int)
Constant VKEY_KP_MINUS (int)
Constant VKEY_KP_MULTIPLY (int)
Constant VKEY_KP_PERIOD (int)
Constant VKEY_KP_PLUS (int)
Constant VKEY_LALT (int)
Constant VKEY_LCTRL (int)
Constant VKEY_LEFT (int)
Constant VKEY_LEFTBRACKET (int)
Constant VKEY_LEFTPAREN (int)
Constant VKEY_LESS (int)
Constant VKEY_LMETA (int)
Constant VKEY_LSHIFT (int)
Constant VKEY_LSUPER (int)
Constant VKEY_MENU (int)
Constant VKEY_MINUS (int)
Constant VKEY_MODE (int)
Constant VKEY_MOUSEBUTTON0 (int)
Constant VKEY_MOUSEBUTTON1 (int)
Constant VKEY_MOUSEBUTTON2 (int)
Constant VKEY_MOUSEBUTTON3 (int)
Constant VKEY_MOUSEBUTTON4 (int)
Constant VKEY_NUMLOCK (int)
Constant VKEY_PAGEDOWN (int)
Constant VKEY_PAGEUP (int)
Constant VKEY_PAUSE (int)
Constant VKEY_PERIOD (int)
Constant VKEY_PLUS (int)
Constant VKEY_POWER (int)
Constant VKEY_PRINT (int)
Constant VKEY_QUESTION (int)
Constant VKEY_QUOTE (int)
Constant VKEY_QUOTEDBL (int)
Constant VKEY_RALT (int)
Constant VKEY_RCTRL (int)
Constant VKEY_RETURN (int)
Constant VKEY_RIGHT (int)
Constant VKEY_RIGHTBRACKET (int)
Constant VKEY_RIGHTPAREN (int)
Constant VKEY_RMETA (int)
Constant VKEY_RSHIFT (int)
Constant VKEY_RSUPER (int)
Constant VKEY_SCROLLOCK (int)
Constant VKEY_SEMICOLON (int)
Constant VKEY_SLASH (int)
Constant VKEY_SPACE (int)
Constant VKEY_SYSREQ (int)
Constant VKEY_TAB (int)
Constant VKEY_UNDERSCORE (int)
Constant VKEY_UP (int)
Constant VMOD_CAPS (int)
Constant VMOD_LALT (int)
Constant VMOD_LCTRL (int)
Constant VMOD_LMETA (int)
Constant VMOD_LSHIFT (int)
Constant VMOD_MODE (int)
Constant VMOD_NUM (int)
Constant VMOD_RALT (int)
Constant VMOD_RCTRL (int)
Constant VMOD_RMETA (int)
Constant VMOD_RSHIFT (int)

 

Project Modules:tksdl 
Project Classes:AudioDevice , AudioSample , Cursor , FPS , Joystick , Key , Mouse , SamplePlayer , SDL , Viewport 
Project Functions:MIDINoteToFrequency 
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 


auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54