accelerator_parse

Description:


public bool accelerator_parse (string accelerator, out uint accelerator_key, out ModifierType accelerator_mods)

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 [func@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 [flags@Gdk.ModifierType] mask:

  • `<Shift>` for `GDK_SHIFT_MASK`
  • `<Ctrl>` for `GDK_CONTROL_MASK`
  • `<Alt>` for `GDK_ALT_MASK`
  • `<Meta>` for `GDK_META_MASK`
  • `<Super>` for `GDK_SUPER_MASK`
  • `<Hyper>` for `GDK_HYPER_MASK`

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

Parameters:

accelerator

string representing an accelerator
accelerator_key

return location for accelerator keyval
accelerator_mods

return location for accelerator modifier mask

Namespace: Gtk
Package: gtk4