AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

Improve the gtk_accelerator_parse() docs

Browse Source 
We need to escape the modifiers in angular brackets, or Markdown will
consider them as HTML tags.

We also should document the modifiers we're parsing.
This commit is contained in:
Emmanuele Bassi 2021-09-04 18:56:08 +01:00
parent 464e0aed04
commit c3ca48b249
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
gtk/gtkaccelgroup.c
View File

@ -484,15 +484,26 @@ out:
*
* Parses a string representing an accelerator.
*
* The format looks like “<Control>a” or “<Shift><Alt>F1”.
* 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>-”.
* abbreviations such as “`<Ctl>`” and “`<Ctrl>`”.
*
* If the parse fails, @accelerator_key and @accelerator_mods will
* 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
* [enum@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).
*/
gboolean