Function
Gtkaccelerator_parse
Declaration [src]
gboolean
gtk_accelerator_parse (
const char* accelerator,
guint* accelerator_key,
GdkModifierType* accelerator_mods
)
Description [src]
Parses a string representing an accelerator.
The format looks like “<Control>a” or “<Shift><Alt>F1”.
The parser is fairly liberal and allows lower or upper case, and also
abbreviations such as “<Ctl>” and “<Ctrl>”.
Key names are parsed using gdk_keyval_from_name(). For character keys
the name is not the symbol, but the lowercase name, e.g. one would use
“<Ctrl>minus” instead of “<Ctrl>-”.
Modifiers are enclosed in angular brackets <>, and match the
GdkModifierType mask:
<Shift>forGDK_SHIFT_MASK<Ctrl>forGDK_CONTROL_MASK<Alt>forGDK_ALT_MASK<Meta>forGDK_META_MASK<Super>forGDK_SUPER_MASK<Hyper>forGDK_HYPER_MASK
If the parse operation fails, accelerator_key and accelerator_mods will
be set to 0 (zero).
Parameters
accelerator |
const char* |
String representing an accelerator. |
|
| The data is owned by the caller of the function. | |
| The value is a NUL terminated UTF-8 string. | |
accelerator_key |
guint* |
Return location for accelerator keyval. |
|
| The argument will be set by the function. | |
The argument can be NULL. | |
| The called function takes ownership of the data, and is responsible for freeing it. | |
accelerator_mods |
GdkModifierType |
Return location for accelerator modifier mask. |
|
| The argument will be set by the function. | |
The argument can be NULL. | |
| The called function takes ownership of the data, and is responsible for freeing it. |