docs: Use markdown for section headings
This commit is contained in:
@ -44,7 +44,8 @@
|
|||||||
* window's menus would be constructed from a combination of two action
|
* window's menus would be constructed from a combination of two action
|
||||||
* groups.
|
* groups.
|
||||||
*
|
*
|
||||||
* <para id="Action-Accel">
|
* ## Accelerators ## {#Action-Accel}
|
||||||
|
*
|
||||||
* Accelerators are handled by the GTK+ accelerator map. All actions are
|
* Accelerators are handled by the GTK+ accelerator map. All actions are
|
||||||
* assigned an accelerator path (which normally has the form
|
* assigned an accelerator path (which normally has the form
|
||||||
* <literal><Actions>/group-name/action-name</literal>)
|
* <literal><Actions>/group-name/action-name</literal>)
|
||||||
@ -52,11 +53,9 @@
|
|||||||
* and toolitems take on this accelerator path. The GTK+ accelerator map
|
* and toolitems take on this accelerator path. The GTK+ accelerator map
|
||||||
* code makes sure that the correct shortcut is displayed next to the menu
|
* code makes sure that the correct shortcut is displayed next to the menu
|
||||||
* item.
|
* item.
|
||||||
* </para>
|
|
||||||
*
|
*
|
||||||
* <refsect2 id="GtkActionGroup-BUILDER-UI">
|
* # GtkActionGroup as GtkBuildable # {#GtkActionGroup-BUILDER-UI}
|
||||||
* <title>GtkActionGroup as GtkBuildable</title>
|
*
|
||||||
* <para>
|
|
||||||
* The #GtkActionGroup implementation of the #GtkBuildable interface accepts
|
* The #GtkActionGroup implementation of the #GtkBuildable interface accepts
|
||||||
* #GtkAction objects as <child> elements in UI definitions.
|
* #GtkAction objects as <child> elements in UI definitions.
|
||||||
*
|
*
|
||||||
@ -68,9 +67,8 @@
|
|||||||
* modifiers and allows to specify accelerators. This is similar to the
|
* modifiers and allows to specify accelerators. This is similar to the
|
||||||
* <accelerator> element of #GtkWidget, the main difference is that
|
* <accelerator> element of #GtkWidget, the main difference is that
|
||||||
* it doesn't allow you to specify a signal.
|
* it doesn't allow you to specify a signal.
|
||||||
* </para>
|
*
|
||||||
* <example>
|
* ## A #GtkDialog UI definition fragment. ##
|
||||||
* <title>A #GtkDialog UI definition fragment.</title>
|
|
||||||
* |[
|
* |[
|
||||||
* <object class="GtkActionGroup" id="actiongroup">
|
* <object class="GtkActionGroup" id="actiongroup">
|
||||||
* <child>
|
* <child>
|
||||||
@ -83,8 +81,7 @@
|
|||||||
* </child>
|
* </child>
|
||||||
* </object>
|
* </object>
|
||||||
* ]|
|
* ]|
|
||||||
* </example>
|
*
|
||||||
* </refsect2>
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "config.h"
|
#include "config.h"
|
||||||
|
@ -25,9 +25,8 @@
|
|||||||
* through its action, as they are responsible for activating their
|
* through its action, as they are responsible for activating their
|
||||||
* related actions.
|
* related actions.
|
||||||
*
|
*
|
||||||
* <refsect2>
|
* # Implementing GtkActivatable
|
||||||
* <title>Implementing GtkActivatable</title>
|
*
|
||||||
* <para>
|
|
||||||
* When extending a class that is already #GtkActivatable; it is only
|
* When extending a class that is already #GtkActivatable; it is only
|
||||||
* necessary to implement the #GtkActivatable->sync_action_properties()
|
* necessary to implement the #GtkActivatable->sync_action_properties()
|
||||||
* and #GtkActivatable->update() methods and chain up to the parent
|
* and #GtkActivatable->update() methods and chain up to the parent
|
||||||
@ -38,9 +37,9 @@
|
|||||||
* the action pointer and boolean flag on your instance, and calling
|
* the action pointer and boolean flag on your instance, and calling
|
||||||
* gtk_activatable_do_set_related_action() and
|
* gtk_activatable_do_set_related_action() and
|
||||||
* gtk_activatable_sync_action_properties() at the appropriate times.
|
* gtk_activatable_sync_action_properties() at the appropriate times.
|
||||||
* </para>
|
*
|
||||||
* <example>
|
* ## A class fragment implementing #GtkActivatable
|
||||||
* <title>A class fragment implementing #GtkActivatable</title>
|
*
|
||||||
* |[<!-- language="C" -->
|
* |[<!-- language="C" -->
|
||||||
*
|
*
|
||||||
* enum {
|
* enum {
|
||||||
@ -253,9 +252,8 @@
|
|||||||
* foo_bar_set_label (button, gtk_action_get_label (action));
|
* foo_bar_set_label (button, gtk_action_get_label (action));
|
||||||
*
|
*
|
||||||
* ...
|
* ...
|
||||||
* }]|
|
* }
|
||||||
* </example>
|
* ]|
|
||||||
* </refsect2>
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "config.h"
|
#include "config.h"
|
||||||
|
@ -51,13 +51,12 @@
|
|||||||
* for this widget's #GtkColorSelection::color-changed signal to be notified
|
* for this widget's #GtkColorSelection::color-changed signal to be notified
|
||||||
* when the color changes.
|
* when the color changes.
|
||||||
*
|
*
|
||||||
* <refsect2 id="GtkColorSelectionDialog-BUILDER-UI">
|
* # GtkColorSelectionDialog as GtkBuildable # {#GtkColorSelectionDialog-BUILDER-UI}
|
||||||
* <title>GtkColorSelectionDialog as GtkBuildable</title>
|
*
|
||||||
* The GtkColorSelectionDialog implementation of the GtkBuildable interface
|
* The GtkColorSelectionDialog implementation of the GtkBuildable interface
|
||||||
* exposes the embedded #GtkColorSelection as internal child with the
|
* exposes the embedded #GtkColorSelection as internal child with the
|
||||||
* name "color_selection". It also exposes the buttons with the names
|
* name "color_selection". It also exposes the buttons with the names
|
||||||
* "ok_button", "cancel_button" and "help_button".
|
* "ok_button", "cancel_button" and "help_button".
|
||||||
* </refsect2>
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
@ -1626,13 +1626,12 @@ gtk_font_selection_set_preview_text (GtkFontSelection *fontsel,
|
|||||||
* In GTK+ 3.2, #GtkFontSelectionDialog has been deprecated in favor of
|
* In GTK+ 3.2, #GtkFontSelectionDialog has been deprecated in favor of
|
||||||
* #GtkFontChooserDialog.
|
* #GtkFontChooserDialog.
|
||||||
*
|
*
|
||||||
* <refsect2 id="GtkFontSelectionDialog-BUILDER-UI">
|
* # GtkFontSelectionDialog as GtkBuildable # {#GtkFontSelectionDialog-BUILDER-UI}
|
||||||
* <title>GtkFontSelectionDialog as GtkBuildable</title>
|
*
|
||||||
* The GtkFontSelectionDialog implementation of the GtkBuildable interface
|
* The GtkFontSelectionDialog implementation of the GtkBuildable interface
|
||||||
* exposes the embedded #GtkFontSelection as internal child with the
|
* exposes the embedded #GtkFontSelection as internal child with the
|
||||||
* name "font_selection". It also exposes the buttons with the names
|
* name "font_selection". It also exposes the buttons with the names
|
||||||
* "ok_button", "cancel_button" and "apply_button".
|
* "ok_button", "cancel_button" and "apply_button".
|
||||||
* </refsect2>
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
static void gtk_font_selection_dialog_buildable_interface_init (GtkBuildableIface *iface);
|
static void gtk_font_selection_dialog_buildable_interface_init (GtkBuildableIface *iface);
|
||||||
|
@ -70,12 +70,12 @@
|
|||||||
* gtk_widget_render_icon(). These functions take the theme into account when
|
* gtk_widget_render_icon(). These functions take the theme into account when
|
||||||
* looking up the icon to use for a given stock ID.
|
* looking up the icon to use for a given stock ID.
|
||||||
*
|
*
|
||||||
* <refsect2 id="GtkIconFactory-BUILDER-UI">
|
* # GtkIconFactory as GtkBuildable # {#GtkIconFactory-BUILDER-UI}
|
||||||
* <title>GtkIconFactory as GtkBuildable</title>
|
*
|
||||||
* <para>
|
|
||||||
* GtkIconFactory supports a custom <sources> element, which can contain
|
* GtkIconFactory supports a custom <sources> element, which can contain
|
||||||
* multiple <source> elements.
|
* multiple <source> elements.
|
||||||
* The following attributes are allowed:
|
* The following attributes are allowed:
|
||||||
|
*
|
||||||
* <variablelist>
|
* <variablelist>
|
||||||
* <varlistentry>
|
* <varlistentry>
|
||||||
* <term>stock-id</term>
|
* <term>stock-id</term>
|
||||||
@ -120,8 +120,9 @@
|
|||||||
* </para></listitem>
|
* </para></listitem>
|
||||||
* </varlistentry>
|
* </varlistentry>
|
||||||
* </variablelist>
|
* </variablelist>
|
||||||
* <example>
|
*
|
||||||
* <title>A #GtkIconFactory UI definition fragment.</title>
|
* ## A #GtkIconFactory UI definition fragment. ##
|
||||||
|
*
|
||||||
* |[
|
* |[
|
||||||
* <object class="GtkIconFactory" id="iconfactory1">
|
* <object class="GtkIconFactory" id="iconfactory1">
|
||||||
* <sources>
|
* <sources>
|
||||||
@ -137,9 +138,6 @@
|
|||||||
* </child>
|
* </child>
|
||||||
* </object>
|
* </object>
|
||||||
* ]|
|
* ]|
|
||||||
* </example>
|
|
||||||
* </para>
|
|
||||||
* </refsect2>
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
@ -60,9 +60,8 @@
|
|||||||
* one or more UI definitions, which reference actions from one or more
|
* one or more UI definitions, which reference actions from one or more
|
||||||
* action groups.
|
* action groups.
|
||||||
*
|
*
|
||||||
* <refsect2 id="XML-UI">
|
* # UI Definitions # {#XML-UI}
|
||||||
* <title>UI Definitions</title>
|
*
|
||||||
* <para>
|
|
||||||
* The UI definitions are specified in an XML format which can be
|
* The UI definitions are specified in an XML format which can be
|
||||||
* roughly described by the following DTD.
|
* roughly described by the following DTD.
|
||||||
*
|
*
|
||||||
@ -108,6 +107,7 @@
|
|||||||
* <!ATTLIST accelerator name #IMPLIED
|
* <!ATTLIST accelerator name #IMPLIED
|
||||||
* action #REQUIRED >
|
* action #REQUIRED >
|
||||||
* ]|
|
* ]|
|
||||||
|
*
|
||||||
* There are some additional restrictions beyond those specified in the
|
* There are some additional restrictions beyond those specified in the
|
||||||
* DTD, e.g. every toolitem must have a toolbar in its anchestry and
|
* DTD, e.g. every toolitem must have a toolbar in its anchestry and
|
||||||
* every menuitem must have a menubar or popup in its anchestry. Since
|
* every menuitem must have a menubar or popup in its anchestry. Since
|
||||||
@ -121,8 +121,8 @@
|
|||||||
* enclosed in doublequotes, thus they must not '"' characters or references
|
* enclosed in doublequotes, thus they must not '"' characters or references
|
||||||
* to the " entity.
|
* to the " entity.
|
||||||
*
|
*
|
||||||
* <example>
|
* ## A UI definition ##
|
||||||
* <title>A UI definition</title>
|
*
|
||||||
* |[
|
* |[
|
||||||
* <ui>
|
* <ui>
|
||||||
* <menubar>
|
* <menubar>
|
||||||
@ -149,12 +149,12 @@
|
|||||||
* </toolbar>
|
* </toolbar>
|
||||||
* </ui>
|
* </ui>
|
||||||
* ]|
|
* ]|
|
||||||
* </example>
|
|
||||||
*
|
*
|
||||||
* The constructed widget hierarchy is very similar to the element tree
|
* The constructed widget hierarchy is very similar to the element tree
|
||||||
* of the XML, with the exception that placeholders are merged into their
|
* of the XML, with the exception that placeholders are merged into their
|
||||||
* parents. The correspondence of XML elements to widgets should be
|
* parents. The correspondence of XML elements to widgets should be
|
||||||
* almost obvious:
|
* almost obvious:
|
||||||
|
*
|
||||||
* <variablelist>
|
* <variablelist>
|
||||||
* <varlistentry>
|
* <varlistentry>
|
||||||
* <term>menubar</term>
|
* <term>menubar</term>
|
||||||
@ -197,11 +197,9 @@
|
|||||||
* The "position" attribute determines where a constructed widget is positioned
|
* The "position" attribute determines where a constructed widget is positioned
|
||||||
* wrt. to its siblings in the partially constructed tree. If it is
|
* wrt. to its siblings in the partially constructed tree. If it is
|
||||||
* "top", the widget is prepended, otherwise it is appended.
|
* "top", the widget is prepended, otherwise it is appended.
|
||||||
* </para>
|
*
|
||||||
* </refsect2>
|
* # UI Merging # {#UI-Merging}
|
||||||
* <refsect2 id="UI-Merging">
|
*
|
||||||
* <title>UI Merging</title>
|
|
||||||
* <para>
|
|
||||||
* The most remarkable feature of #GtkUIManager is that it can overlay a set
|
* The most remarkable feature of #GtkUIManager is that it can overlay a set
|
||||||
* of menuitems and toolitems over another one, and demerge them later.
|
* of menuitems and toolitems over another one, and demerge them later.
|
||||||
*
|
*
|
||||||
@ -211,20 +209,16 @@
|
|||||||
* has the path <literal>/ui/menubar/JustifyMenu/Left</literal> and the
|
* has the path <literal>/ui/menubar/JustifyMenu/Left</literal> and the
|
||||||
* toolitem with the same name has path
|
* toolitem with the same name has path
|
||||||
* <literal>/ui/toolbar1/JustifyToolItems/Left</literal>.
|
* <literal>/ui/toolbar1/JustifyToolItems/Left</literal>.
|
||||||
* </para>
|
*
|
||||||
* </refsect2>
|
* # Accelerators #
|
||||||
* <refsect2>
|
*
|
||||||
* <title>Accelerators</title>
|
|
||||||
* <para>
|
|
||||||
* Every action has an accelerator path. Accelerators are installed together with
|
* Every action has an accelerator path. Accelerators are installed together with
|
||||||
* menuitem proxies, but they can also be explicitly added with <accelerator>
|
* menuitem proxies, but they can also be explicitly added with <accelerator>
|
||||||
* elements in the UI definition. This makes it possible to have accelerators for
|
* elements in the UI definition. This makes it possible to have accelerators for
|
||||||
* actions even if they have no visible proxies.
|
* actions even if they have no visible proxies.
|
||||||
* </para>
|
*
|
||||||
* </refsect2>
|
* # Smart Separators # {#Smart-Separators}
|
||||||
* <refsect2 id="Smart-Separators">
|
*
|
||||||
* <title>Smart Separators</title>
|
|
||||||
* <para>
|
|
||||||
* The separators created by #GtkUIManager are "smart", i.e. they do not show up
|
* The separators created by #GtkUIManager are "smart", i.e. they do not show up
|
||||||
* in the UI unless they end up between two visible menu or tool items. Separators
|
* in the UI unless they end up between two visible menu or tool items. Separators
|
||||||
* which are located at the very beginning or end of the menu or toolbar
|
* which are located at the very beginning or end of the menu or toolbar
|
||||||
@ -236,14 +230,13 @@
|
|||||||
* For separators in toolbars, you can set <literal>expand="true"</literal> to
|
* For separators in toolbars, you can set <literal>expand="true"</literal> to
|
||||||
* turn them from a small, visible separator to an expanding, invisible one.
|
* turn them from a small, visible separator to an expanding, invisible one.
|
||||||
* Toolitems following an expanding separator are effectively right-aligned.
|
* Toolitems following an expanding separator are effectively right-aligned.
|
||||||
* </para>
|
*
|
||||||
* </refsect2>
|
* # Empty Menus
|
||||||
* <refsect2>
|
*
|
||||||
* <title>Empty Menus</title>
|
|
||||||
* <para>
|
|
||||||
* Submenus pose similar problems to separators inconnection with merging. It is
|
* Submenus pose similar problems to separators inconnection with merging. It is
|
||||||
* impossible to know in advance whether they will end up empty after merging.
|
* impossible to know in advance whether they will end up empty after merging.
|
||||||
* #GtkUIManager offers two ways to treat empty submenus:
|
* #GtkUIManager offers two ways to treat empty submenus:
|
||||||
|
*
|
||||||
* <itemizedlist>
|
* <itemizedlist>
|
||||||
* <listitem>
|
* <listitem>
|
||||||
* <para>make them disappear by hiding the menu item they're attached to</para>
|
* <para>make them disappear by hiding the menu item they're attached to</para>
|
||||||
@ -252,13 +245,12 @@
|
|||||||
* <para>add an insensitive "Empty" item</para>
|
* <para>add an insensitive "Empty" item</para>
|
||||||
* </listitem>
|
* </listitem>
|
||||||
* </itemizedlist>
|
* </itemizedlist>
|
||||||
|
*
|
||||||
* The behaviour is chosen based on the "hide_if_empty" property of the action
|
* The behaviour is chosen based on the "hide_if_empty" property of the action
|
||||||
* to which the submenu is associated.
|
* to which the submenu is associated.
|
||||||
* </para>
|
*
|
||||||
* </refsect2>
|
* # GtkUIManager as GtkBuildable # {#GtkUIManager-BUILDER-UI}
|
||||||
* <refsect2 id="GtkUIManager-BUILDER-UI">
|
*
|
||||||
* <title>GtkUIManager as GtkBuildable</title>
|
|
||||||
* <para>
|
|
||||||
* The GtkUIManager implementation of the GtkBuildable interface accepts
|
* The GtkUIManager implementation of the GtkBuildable interface accepts
|
||||||
* GtkActionGroup objects as <child> elements in UI definitions.
|
* GtkActionGroup objects as <child> elements in UI definitions.
|
||||||
*
|
*
|
||||||
@ -269,8 +261,8 @@
|
|||||||
* other parts of the constructed user interface with the help of the
|
* other parts of the constructed user interface with the help of the
|
||||||
* "constructor" attribute. See the example below.
|
* "constructor" attribute. See the example below.
|
||||||
*
|
*
|
||||||
* <example>
|
* ## An embedded GtkUIManager UI definition
|
||||||
* <title>An embedded GtkUIManager UI definition</title>
|
*
|
||||||
* |[
|
* |[
|
||||||
* <object class="GtkUIManager" id="uiman">
|
* <object class="GtkUIManager" id="uiman">
|
||||||
* <child>
|
* <child>
|
||||||
@ -295,9 +287,6 @@
|
|||||||
* </child>
|
* </child>
|
||||||
* </object>
|
* </object>
|
||||||
* ]|
|
* ]|
|
||||||
* </example>
|
|
||||||
* </para>
|
|
||||||
* </refsect2>
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user