org.gnu.gtk
Class Accelerator
public
class
Accelerator
extends Object
Method Summary |
static ModifierType | getDefaultModifierMask()
Gets the value set by {@link #setDefaultModifierMask(ModifierType)}.
|
static String | getLabel(int key, ModifierType mods)
Converts an accelerator keyval and modifier mask into a string which can
be used to represent the accelerator to the user.
|
static String | getName(int key, ModifierType mods)
Converts an accelerator keyval and modifier mask into a string parseable
by {@link #parseKey(String)} or {@link #parseModifier(String)}. |
static boolean | isValid(int key, ModifierType mods)
Determines whether a given keyv and modifier mask constitute a valid
keyboard accelerator. |
static int | parseKey(String accelerator)
Parses a string representing an accelerator. |
static ModifierType | parseModifier(String accelerator)
Parses a string representing an accelerator. |
static void | setDefaultModifierMask(ModifierType mask)
Sets the modifiers that will be considered significant for keyboard
accelerators. |
Gets the value set by {@link #setDefaultModifierMask(ModifierType)}.
Returns: The default modifier mask
Converts an accelerator keyval and modifier mask into a string which can
be used to represent the accelerator to the user.
Parameters: key
The key for teh accelerator mods
The modifier mask for the accelerator
Returns: The user-readable string representation of the accelerator
Converts an accelerator keyval and modifier mask into a string parseable
by {@link #parseKey(String)} or {@link #parseModifier(String)}. For
example, if you pass in KeySymbol.q and ModifierType.CONTROL_MASK, this
function returns "
q". If you need to display accelerators in
the user interface, see {@link #getLabel(int, ModifierType)}.
Parameters: key
The key for the accelerator mods
The modifier mask for the accelerator
Returns: The string representation of the accelerator
Since: 2.8.1
Determines whether a given keyv and modifier mask constitute a valid
keyboard accelerator. For example, the KeyChar.a key plus
ModifierType.CONTROL_MASK is valid - this is a "Ctrl+a" accelerator. But,
you can't, for instance, use the KeySymbol.Control_L keyval as an
accelerator.
Parameters: key
The key for the accelerator4 mods
The modifiers for the accelerator4
Returns: true if the accelerator is valid, false otherwise
Since: 2.8.1
public static int parseKey(String accelerator)
Parses a string representing an accelerator. The format looks like "
a"
or "F1" or "z" (the last one is for key release).
The parser is fairly liberal and allows lower or upper case, and also
abbreviations such as "" and "". If the parse fails, it will
return a KeySymbol with value 0.
Parameters: accelerator
The string to parse
Returns: The int (from {@link KeyValue}) corresponding to the key part of
the accelerator
Since: 2.8.1
public static
ModifierType parseModifier(String accelerator)
Parses a string representing an accelerator. The format looks like "
a"
or "F1" or "z" (the last one is for key release).
The parser is fairly liberal and allows lower or upper case, and also
abbreviations such as "" and "". If the parse fails, it will
return a ModifierType with value 0.
Parameters: accelerator
The string to parse
Returns: The ModifierType corresponding to the modifier mask of the
accelerator
Since: 2.8.1
public static void setDefaultModifierMask(
ModifierType mask)
Sets the modifiers that will be considered significant for keyboard
accelerators. The default mod mask is CONTROL_MASK | SHIFT_MASK |
MOD1_MASK | SUPER_MASK | HYPER_MASK | META_MASK, that is, Control, Shift,
Alt, Super, Hyper and Meta. Other modifiers will by default be ignored by
AccelGroup. You must include at least the three modifiers Control, Shift
and Alt in any value you pass to this function. The default mod mask
should be changed on application startup, before using any accelerator
groups.
Parameters: mask
The new default modifier mask