Class: Key

Guacamole.OnScreenKeyboard.Key(template, nameopt)

new Key(template, nameopt)

Represents a single key, or a single possible behavior of a key. Each key on the on-screen keyboard must have at least one associated Guacamole.OnScreenKeyboard.Key, whether that key is explicitly defined or implied, and may have multiple Guacamole.OnScreenKeyboard.Key if behavior depends on modifier states.
Parameters:
Name Type Attributes Description
template Guacamole.OnScreenKeyboard.Key | Object The object whose identically-named properties will be used to initialize the properties of this key.
name String <optional>
The name to use instead of any name provided within the template, if any. If omitted, the name within the template will be used, assuming the template contains a name.
Source:

Members

keysym :Number

The keysym to be pressed/released when this key is pressed/released. If not provided, this will be derived from the title if the title is a single character.
Type:
  • Number
Source:

modifier :String

The name of the modifier set when the key is pressed and cleared when this key is released, if any. The names of modifiers are distinct from the names of keys; both the "RightShift" and "LeftShift" keys may set the "shift" modifier, for example. By default, the key will affect no modifiers.
Type:
  • String
Source:

name :String

The unique name identifying this key within the keyboard layout.
Type:
  • String
Source:

requires :Array.<String>

An array containing the names of each modifier required for this key to have an effect. For example, a lowercase letter may require nothing, while an uppercase letter would require "shift", assuming the Shift key is named "shift" within the layout. By default, the key will require no modifiers.
Type:
  • Array.<String>
Source:

title :String

The human-readable title that will be displayed to the user within the key. If not provided, this will be derived from the key name.
Type:
  • String
Source: