Function

Gtkaccelerator_parse

Declaration [src]

void
gtk_accelerator_parse (
  const gchar* accelerator,
  guint* accelerator_key,
  GdkModifierType* accelerator_mods
)

Description [src]

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 “”. 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 “minus” instead of “-”.

If the parse fails, accelerator_key and accelerator_mods will be set to 0 (zero).

Parameters

accelerator

Type: const gchar*

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

Type: guint*

Return location for accelerator keyval, or NULL.

The argument will be set by the function.

The argument can be NULL.

accelerator_mods

Type: GdkModifierType

Return location for accelerator modifier mask, NULL.

The argument will be set by the function.

The argument can be NULL.

The caller of the function takes ownership of the returned data, and is responsible for freeing it.