Class Index | File Index

Classes


Class Guacamole.OnScreenKeyboard.Key


Defined in: OnScreenKeyboard.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Basic representation of a single key of a keyboard.
Field Summary
Field Attributes Field Name and Description
 
An associative map of all caps by modifier.
 
Bit mask with all modifiers that affect this key set.
 
Whether this key is currently pressed.
 
Width of the key, relative to the size of the keyboard.
Method Summary
Method Attributes Method Name and Description
 
getCap(modifier)
Given the bitwise OR of all active modifiers, returns the key cap which applies.
Class Detail
Guacamole.OnScreenKeyboard.Key()
Basic representation of a single key of a keyboard. Each key has a set of caps associated with tuples of modifiers. The cap determins what happens when a key is pressed, while it is the state of modifier keys that determines what cap is in effect on any particular key.
Field Detail
caps
An associative map of all caps by modifier.

modifierMask
Bit mask with all modifiers that affect this key set.

pressed
Whether this key is currently pressed.

size
Width of the key, relative to the size of the keyboard.
Method Detail
getCap(modifier)
Given the bitwise OR of all active modifiers, returns the key cap which applies.
Parameters:
modifier

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jul 21 2014 14:23:23 GMT-0700 (PDT)