luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-26 05:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

GMenuModel: Convert docs to markdown

Browse Source
This commit is contained in:
Matthias Clasen 2014-01-31 23:00:58 -05:00
parent 4a1710862d
commit 54578e4c34
1 changed files with 22 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
gio/gmenumodel.c
View File

@ -53,16 +53,15 @@
* *
* There are 8 "menus" visible in the screenshot: one menubar, two * There are 8 "menus" visible in the screenshot: one menubar, two
* submenus and 5 sections: * submenus and 5 sections:
* <itemizedlist> *
* <listitem>the toplevel menubar (containing 4 items)</listitem> * - the toplevel menubar (containing 4 items)
* <listitem>the View submenu (containing 3 sections)</listitem> * - the View submenu (containing 3 sections)
* <listitem>the first section of the View submenu (containing 2 items)</listitem> * - the first section of the View submenu (containing 2 items)
* <listitem>the second section of the View submenu (containing 1 item)</listitem> * - the second section of the View submenu (containing 1 item)
* <listitem>the final section of the View submenu (containing 1 item)</listitem> * - the final section of the View submenu (containing 1 item)
* <listitem>the Highlight Mode submenu (containing 2 sections)</listitem> * - the Highlight Mode submenu (containing 2 sections)
* <listitem>the Sources section (containing 2 items)</listitem> * - the Sources section (containing 2 items)
* <listitem>the Markup section (containing 2 items)</listitem> * - the Markup section (containing 2 items)
* </itemizedlist>
* *
* <xref linkend="menu-model"/> illustrates the conceptual connection between * <xref linkend="menu-model"/> illustrates the conceptual connection between
* these 8 menus. Each large block in the figure represents a menu and the * these 8 menus. Each large block in the figure represents a menu and the
@ -116,48 +115,37 @@
* While a wide variety of stateful actions is possible, the following * While a wide variety of stateful actions is possible, the following
* is the minimum that is expected to be supported by all users of exported * is the minimum that is expected to be supported by all users of exported
* menu information: * menu information:
* <itemizedlist> * - an action with no parameter type and no state
* <listitem>an action with no parameter type and no state</listitem> * - an action with no parameter type and boolean state
* <listitem>an action with no parameter type and boolean state</listitem> * - an action with string parameter type and string state
* <listitem>an action with string parameter type and string state</listitem> *
* </itemizedlist> * ## Stateless
* *
* <formalpara><title>Stateless</title>
* <para>
* A stateless action typically corresponds to an ordinary menu item. * A stateless action typically corresponds to an ordinary menu item.
* </para>
* <para>
* Selecting such a menu item will activate the action (with no parameter).
* </para>
* </formalpara>
* *
* <formalpara><title>Boolean State</title> * Selecting such a menu item will activate the action (with no parameter).
* <para> *
* ## Boolean State
*
* An action with a boolean state will most typically be used with a "toggle" * An action with a boolean state will most typically be used with a "toggle"
* or "switch" menu item. The state can be set directly, but activating the * or "switch" menu item. The state can be set directly, but activating the
* action (with no parameter) results in the state being toggled. * action (with no parameter) results in the state being toggled.
* </para> *
* <para>
* Selecting a toggle menu item will activate the action. The menu item should * Selecting a toggle menu item will activate the action. The menu item should
* be rendered as "checked" when the state is true. * be rendered as "checked" when the state is true.
* </para>
* </formalpara>
* *
* <formalpara><title>String Parameter and State</title> * ## String Parameter and State
* <para> *
* Actions with string parameters and state will most typically be used to * Actions with string parameters and state will most typically be used to
* represent an enumerated choice over the items available for a group of * represent an enumerated choice over the items available for a group of
* radio menu items. Activating the action with a string parameter is * radio menu items. Activating the action with a string parameter is
* equivalent to setting that parameter as the state. * equivalent to setting that parameter as the state.
* </para> *
* <para>
* Radio menu items, in addition to being associated with the action, will * Radio menu items, in addition to being associated with the action, will
* have a target value. Selecting that menu item will result in activation * have a target value. Selecting that menu item will result in activation
* of the action with the target value as the parameter. The menu item should * of the action with the target value as the parameter. The menu item should
* be rendered as "selected" when the state of the action is equal to the * be rendered as "selected" when the state of the action is equal to the
* target value of the menu item. * target value of the menu item.
* </para>
* </formalpara>
*/ */
/** /**