Merge branch 'gtk3-docs-fixes' into 'gtk-3-24'

docs: Escape the XML tags in the Widget class description

See merge request GNOME/gtk!3869
This commit is contained in:
Matthias Clasen 2021-08-22 19:13:57 +00:00
commit 26e9919bf6
32 changed files with 176 additions and 149 deletions

View File

@ -56,19 +56,20 @@
* # GtkActionGroup as GtkBuildable # {#GtkActionGroup-BUILDER-UI} * # GtkActionGroup as GtkBuildable # {#GtkActionGroup-BUILDER-UI}
* *
* 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.
* *
* Note that it is probably more common to define actions and action groups * Note that it is probably more common to define actions and action groups
* in the code, since they are directly related to what the code can do. * in the code, since they are directly related to what the code can do.
* *
* The GtkActionGroup implementation of the GtkBuildable interface supports * The GtkActionGroup implementation of the GtkBuildable interface supports
* a custom <accelerator> element, which has attributes named key and * a custom `<accelerator>` element, which has attributes named key and
* 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 doesnt allow you to specify a signal. * it doesnt allow you to specify a signal.
* *
* ## A #GtkDialog UI definition fragment. ## * ## A #GtkDialog UI definition fragment. ##
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkActionGroup" id="actiongroup"> * <object class="GtkActionGroup" id="actiongroup">
* <child> * <child>
* <object class="GtkAction" id="About"> * <object class="GtkAction" id="About">

View File

@ -72,8 +72,8 @@
* *
* # GtkIconFactory as GtkBuildable # {#GtkIconFactory-BUILDER-UI} * # GtkIconFactory as GtkBuildable # {#GtkIconFactory-BUILDER-UI}
* *
* GtkIconFactory supports a custom <sources> element, which can contain * GtkIconFactory supports a custom `<sources>` element, which can contain
* multiple <source> elements. The following attributes are allowed: * multiple `<source>` elements. The following attributes are allowed:
* *
* - stock-id * - stock-id
* *

View File

@ -41,9 +41,9 @@
* #GtkRecentChooserMenu. * #GtkRecentChooserMenu.
* *
* To construct a submenu showing recently used files, use a #GtkRecentAction * To construct a submenu showing recently used files, use a #GtkRecentAction
* as the action for a <menuitem>. To construct a menu toolbutton showing * as the action for a `<menuitem>`. To construct a menu toolbutton showing
* the recently used files in the popup menu, use a #GtkRecentAction as the * the recently used files in the popup menu, use a #GtkRecentAction as the
* action for a <toolitem> element. * action for a `<toolitem>` element.
*/ */

View File

@ -56,16 +56,16 @@
* @Title: GtkUIManager * @Title: GtkUIManager
* @See_also: #GtkBuilder * @See_also: #GtkBuilder
* *
* A #GtkUIManager constructs a user interface (menus and toolbars) from
* one or more UI definitions, which reference actions from one or more
* action groups.
*
* > GtkUIManager is deprecated since GTK+ 3.10. To construct user interfaces * > GtkUIManager is deprecated since GTK+ 3.10. To construct user interfaces
* > from XML definitions, you should use #GtkBuilder, #GMenuModel, et al. To * > from XML definitions, you should use #GtkBuilder, #GMenuModel, et al. To
* > work with actions, use #GAction, #GtkActionable et al. These newer classes * > work with actions, use #GAction, #GtkActionable et al. These newer classes
* > support richer functionality and integration with various desktop shells. * > support richer functionality and integration with various desktop shells.
* > It should be possible to migrate most/all functionality from GtkUIManager. * > It should be possible to migrate most/all functionality from GtkUIManager.
* *
* A #GtkUIManager constructs a user interface (menus and toolbars) from
* one or more UI definitions, which reference actions from one or more
* action groups.
*
* # UI Definitions # {#XML-UI} * # UI Definitions # {#XML-UI}
* *
* The UI definitions are specified in an XML format which can be * The UI definitions are specified in an XML format which can be
@ -126,7 +126,7 @@
* *
* # A UI definition # * # A UI definition #
* *
* |[ * |[<!-- language="xml" -->
* <ui> * <ui>
* <menubar> * <menubar>
* <menu name="FileMenu" action="FileMenuAction"> * <menu name="FileMenu" action="FileMenuAction">
@ -213,7 +213,7 @@
* *
* Every action has an accelerator path. Accelerators are installed together * Every action has an accelerator path. Accelerators are installed together
* with menuitem proxies, but they can also be explicitly added with * with menuitem proxies, but they can also be explicitly added with
* <accelerator> elements in the UI definition. This makes it possible to * `<accelerator>` elements in the UI definition. This makes it possible to
* have accelerators for actions even if they have no visible proxies. * have accelerators for actions even if they have no visible proxies.
* *
* # Smart Separators # {#Smart-Separators} * # Smart Separators # {#Smart-Separators}
@ -246,10 +246,10 @@
* # GtkUIManager as GtkBuildable # {#GtkUIManager-BUILDER-UI} * # GtkUIManager as GtkBuildable # {#GtkUIManager-BUILDER-UI}
* *
* 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.
* *
* A GtkUIManager UI definition as described above can be embedded in * A GtkUIManager UI definition as described above can be embedded in
* an GtkUIManager <object> element in a GtkBuilder UI definition. * an GtkUIManager `<object>` element in a GtkBuilder UI definition.
* *
* The widgets that are constructed by a GtkUIManager can be embedded in * The widgets that are constructed by a GtkUIManager can be embedded in
* other parts of the constructed user interface with the help of the * other parts of the constructed user interface with the help of the
@ -257,7 +257,7 @@
* *
* ## An embedded GtkUIManager UI definition * ## An embedded GtkUIManager UI definition
* *
* |[ * |[<!-- language="xml" -->
* <object class="GtkUIManager" id="uiman"> * <object class="GtkUIManager" id="uiman">
* <child> * <child>
* <object class="GtkActionGroup" id="actiongroup"> * <object class="GtkActionGroup" id="actiongroup">
@ -1096,10 +1096,10 @@ gtk_ui_manager_get_accel_group (GtkUIManager *manager)
* Looks up a widget by following a path. * Looks up a widget by following a path.
* The path consists of the names specified in the XML description of the UI. * The path consists of the names specified in the XML description of the UI.
* separated by /. Elements which dont have a name or action attribute in * separated by /. Elements which dont have a name or action attribute in
* the XML (e.g. <popup>) can be addressed by their XML element name * the XML (e.g. `<popup>`) can be addressed by their XML element name
* (e.g. "popup"). The root element ("/ui") can be omitted in the path. * (e.g. "popup"). The root element ("/ui") can be omitted in the path.
* *
* Note that the widget found by following a path that ends in a <menu>; * Note that the widget found by following a path that ends in a `<menu>`;
* element is the menuitem to which the menu is attached, not the menu it * element is the menuitem to which the menu is attached, not the menu it
* manages. * manages.
* *
@ -1937,7 +1937,7 @@ add_ui_from_string (GtkUIManager *manager,
* @error: return location for an error * @error: return location for an error
* *
* Parses a string containing a [UI definition][XML-UI] and merges it with * Parses a string containing a [UI definition][XML-UI] and merges it with
* the current contents of @manager. An enclosing <ui> element is added if * the current contents of @manager. An enclosing `<ui>` element is added if
* it is missing. * it is missing.
* *
* Returns: The merge id for the merged UI. The merge id can be used * Returns: The merge id for the merged UI. The merge id can be used

View File

@ -236,7 +236,7 @@ gtk_buildable_construct_child (GtkBuildable *buildable,
* @data: (out): return location for user data that will be passed in * @data: (out): return location for user data that will be passed in
* to parser functions * to parser functions
* *
* This is called for each unknown element under <child>. * This is called for each unknown element under `<child>`.
* *
* Returns: %TRUE if a object has a custom implementation, %FALSE * Returns: %TRUE if a object has a custom implementation, %FALSE
* if it doesn't. * if it doesn't.

View File

@ -58,15 +58,15 @@ typedef struct _GtkBuildableIface GtkBuildableIface;
* is created. * is created.
* @construct_child: Constructs a child of a buildable that has been * @construct_child: Constructs a child of a buildable that has been
* specified as constructor in the UI definition. #GtkUIManager implements * specified as constructor in the UI definition. #GtkUIManager implements
* this to reference to a widget created in a <ui> tag which is outside * this to reference to a widget created in a `<ui>` tag which is outside
* of the normal GtkBuilder UI definition hierarchy. A reference to the * of the normal GtkBuilder UI definition hierarchy. A reference to the
* constructed object is returned and becomes owned by the caller. * constructed object is returned and becomes owned by the caller.
* @custom_tag_start: Implement this if the buildable needs to parse * @custom_tag_start: Implement this if the buildable needs to parse
* content below <child>. To handle an element, the implementation * content below `<child>`. To handle an element, the implementation
* must fill in the @parser and @user_data and return %TRUE. * must fill in the @parser and @user_data and return %TRUE.
* #GtkWidget implements this to parse keyboard accelerators specified * #GtkWidget implements this to parse keyboard accelerators specified
* in <accelerator> elements. #GtkContainer implements it to map * in `<accelerator>` elements. #GtkContainer implements it to map
* properties defined via <packing> elements to child properties. * properties defined via `<packing>` elements to child properties.
* Note that @user_data must be freed in @custom_tag_end or @custom_finished. * Note that @user_data must be freed in @custom_tag_end or @custom_finished.
* @custom_tag_end: Called for the end tag of each custom element that is * @custom_tag_end: Called for the end tag of each custom element that is
* handled by the buildable (see @custom_tag_start). * handled by the buildable (see @custom_tag_start).

View File

@ -69,25 +69,25 @@
* *
* [RELAX NG Compact Syntax](https://gitlab.gnome.org/GNOME/gtk/-/blob/gtk-3-24/gtk/gtkbuilder.rnc) * [RELAX NG Compact Syntax](https://gitlab.gnome.org/GNOME/gtk/-/blob/gtk-3-24/gtk/gtkbuilder.rnc)
* *
* The toplevel element is <interface>. It optionally takes a domain * The toplevel element is `<interface>`. It optionally takes a domain
* attribute, which will make the builder look for translated strings * attribute, which will make the builder look for translated strings
* using dgettext() in the domain specified. This can also be done by * using dgettext() in the domain specified. This can also be done by
* calling gtk_builder_set_translation_domain() on the builder. * calling gtk_builder_set_translation_domain() on the builder.
* Objects are described by <object> elements, which can contain * Objects are described by `<object>` elements, which can contain
* <property> elements to set properties, <signal> elements which * `<property>` elements to set properties, `<signal>` elements which
* connect signals to handlers, and <child> elements, which describe * connect signals to handlers, and `<child>` elements, which describe
* child objects (most often widgets inside a container, but also e.g. * child objects (most often widgets inside a container, but also e.g.
* actions in an action group, or columns in a tree model). A <child> * actions in an action group, or columns in a tree model). A `<child>`
* element contains an <object> element which describes the child object. * element contains an `<object>` element which describes the child object.
* The target toolkit version(s) are described by <requires> elements, * The target toolkit version(s) are described by `<requires>` elements,
* the lib attribute specifies the widget library in question (currently * the lib attribute specifies the widget library in question (currently
* the only supported value is gtk+) and the version attribute specifies * the only supported value is gtk+) and the version attribute specifies
* the target version in the form <major>.<minor>. The builder will error * the target version in the form `<major>.<minor>`. The builder will error
* out if the version requirements are not met. * out if the version requirements are not met.
* *
* Typically, the specific kind of object represented by an <object> * Typically, the specific kind of object represented by an `<object>`
* element is specified by the class attribute. If the type has not * element is specified by the class attribute. If the type has not
* been loaded yet, GTK+ tries to find the get_type() function from the * been loaded yet, GTK+ tries to find the `get_type()` function from the
* class name by applying heuristics. This works in most cases, but if * class name by applying heuristics. This works in most cases, but if
* necessary, it is possible to specify the name of the get_type() function * necessary, it is possible to specify the name of the get_type() function
* explictly with the "type-func" attribute. As a special case, GtkBuilder * explictly with the "type-func" attribute. As a special case, GtkBuilder
@ -100,10 +100,10 @@
* application to retrieve them from the builder with gtk_builder_get_object(). * application to retrieve them from the builder with gtk_builder_get_object().
* An id is also necessary to use the object as property value in other * An id is also necessary to use the object as property value in other
* parts of the UI definition. GTK+ reserves ids starting and ending * parts of the UI definition. GTK+ reserves ids starting and ending
* with ___ (3 underscores) for its own purposes. * with `___` (3 underscores) for its own purposes.
* *
* Setting properties of objects is pretty straightforward with the * Setting properties of objects is pretty straightforward with the
* <property> element: the name attribute specifies the name of the * `<property>` element: the name attribute specifies the name of the
* property, and the content of the element specifies the value. * property, and the content of the element specifies the value.
* If the translatable attribute is set to a true value, GTK+ uses * If the translatable attribute is set to a true value, GTK+ uses
* gettext() (or dgettext() if the builder has a translation domain set) * gettext() (or dgettext() if the builder has a translation domain set)
@ -141,7 +141,7 @@
* Internally builder implements this using GBinding objects. * Internally builder implements this using GBinding objects.
* For more information see g_object_bind_property() * For more information see g_object_bind_property()
* *
* Signal handlers are set up with the <signal> element. The name * Signal handlers are set up with the `<signal>` element. The name
* attribute specifies the name of the signal, and the handler attribute * attribute specifies the name of the signal, and the handler attribute
* specifies the function to connect to the signal. By default, GTK+ tries * specifies the function to connect to the signal. By default, GTK+ tries
* to find the handler using g_module_symbol(), but this can be changed by * to find the handler using g_module_symbol(), but this can be changed by
@ -157,19 +157,19 @@
* been constructed by GTK+ as part of a composite widget, to set * been constructed by GTK+ as part of a composite widget, to set
* properties on them or to add further children (e.g. the @vbox of * properties on them or to add further children (e.g. the @vbox of
* a #GtkDialog). This can be achieved by setting the internal-child * a #GtkDialog). This can be achieved by setting the internal-child
* property of the <child> element to a true value. Note that GtkBuilder * property of the `<child>` element to a true value. Note that GtkBuilder
* still requires an <object> element for the internal child, even if it * still requires an `<object>` element for the internal child, even if it
* has already been constructed. * has already been constructed.
* *
* A number of widgets have different places where a child can be added * A number of widgets have different places where a child can be added
* (e.g. tabs vs. page content in notebooks). This can be reflected in * (e.g. tabs vs. page content in notebooks). This can be reflected in
* a UI definition by specifying the type attribute on a <child> * a UI definition by specifying the type attribute on a `<child>`
* The possible values for the type attribute are described in the * The possible values for the type attribute are described in the
* sections describing the widget-specific portions of UI definitions. * sections describing the widget-specific portions of UI definitions.
* *
* # A GtkBuilder UI Definition * # A GtkBuilder UI Definition
* *
* |[ * |[<!-- language="xml" -->
* <interface> * <interface>
* <object class="GtkDialog" id="dialog1"> * <object class="GtkDialog" id="dialog1">
* <child internal-child="vbox"> * <child internal-child="vbox">
@ -195,14 +195,14 @@
* *
* Beyond this general structure, several object classes define their * Beyond this general structure, several object classes define their
* own XML DTD fragments for filling in the ANY placeholders in the DTD * own XML DTD fragments for filling in the ANY placeholders in the DTD
* above. Note that a custom element in a <child> element gets parsed by * above. Note that a custom element in a `<child>` element gets parsed by
* the custom tag handler of the parent object, while a custom element in * the custom tag handler of the parent object, while a custom element in
* an <object> element gets parsed by the custom tag handler of the object. * an `<object>` element gets parsed by the custom tag handler of the object.
* *
* These XML fragments are explained in the documentation of the * These XML fragments are explained in the documentation of the
* respective objects. * respective objects.
* *
* Additionally, since 3.10 a special <template> tag has been added * Additionally, since 3.10 a special `<template>` tag has been added
* to the format allowing one to define a widget classs components. * to the format allowing one to define a widget classs components.
* See the [GtkWidget documentation][composite-templates] for details. * See the [GtkWidget documentation][composite-templates] for details.
*/ */

View File

@ -39,33 +39,34 @@
* Implementations of GtkCellLayout which also implement the GtkBuildable * Implementations of GtkCellLayout which also implement the GtkBuildable
* interface (#GtkCellView, #GtkIconView, #GtkComboBox, * interface (#GtkCellView, #GtkIconView, #GtkComboBox,
* #GtkEntryCompletion, #GtkTreeViewColumn) accept GtkCellRenderer objects * #GtkEntryCompletion, #GtkTreeViewColumn) accept GtkCellRenderer objects
* as <child> elements in UI definitions. They support a custom <attributes> * as `<child>` elements in UI definitions. They support a custom `<attributes>`
* element for their children, which can contain multiple <attribute> * element for their children, which can contain multiple `<attribute>`
* elements. Each <attribute> element has a name attribute which specifies * elements. Each `<attribute>` element has a name attribute which specifies
* a property of the cell renderer; the content of the element is the * a property of the cell renderer; the content of the element is the
* attribute value. * attribute value.
* *
* This is an example of a UI definition fragment specifying attributes: * This is an example of a UI definition fragment specifying attributes:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkCellView"> * <object class="GtkCellView">
* <child> * <child>
* <object class="GtkCellRendererText"/> * <object class="GtkCellRendererText"/>
* <attributes> * <attributes>
* <attribute name="text">0</attribute> * <attribute name="text">0</attribute>
* </attributes> * </attributes>
* </child>" * </child>
* </object> * </object>
* ]| * ]|
* *
* Furthermore for implementations of GtkCellLayout that use a #GtkCellArea * Furthermore for implementations of GtkCellLayout that use a #GtkCellArea
* to lay out cells (all GtkCellLayouts in GTK+ use a GtkCellArea) * to lay out cells (all GtkCellLayouts in GTK+ use a GtkCellArea)
* [cell properties][cell-properties] can also be defined in the format by * [cell properties][cell-properties] can also be defined in the format by
* specifying the custom <cell-packing> attribute which can contain multiple * specifying the custom `<cell-packing>` attribute which can contain multiple
* <property> elements defined in the normal way. * `<property>` elements defined in the normal way.
* *
* Here is a UI definition fragment specifying cell properties: * Here is a UI definition fragment specifying cell properties:
* *
* |[ * |[<!-- language="xml" -->
* <object class="GtkTreeViewColumn"> * <object class="GtkTreeViewColumn">
* <child> * <child>
* <object class="GtkCellRendererText"/> * <object class="GtkCellRendererText"/>
@ -73,7 +74,7 @@
* <property name="align">True</property> * <property name="align">True</property>
* <property name="expand">False</property> * <property name="expand">False</property>
* </cell-packing> * </cell-packing>
* </child>" * </child>
* </object> * </object>
* ]| * ]|
* *

View File

@ -55,13 +55,14 @@
* # GtkComboBoxText as GtkBuildable * # GtkComboBoxText as GtkBuildable
* *
* The GtkComboBoxText implementation of the GtkBuildable interface supports * The GtkComboBoxText implementation of the GtkBuildable interface supports
* adding items directly using the <items> element and specifying <item> * adding items directly using the `<items>` element and specifying `<item>`
* elements for each item. Each <item> element can specify the id * elements for each item. Each `<item>` element can specify the id
* corresponding to the appended text and also supports the regular * corresponding to the appended text and also supports the regular
* translation attributes translatable, context and comments. * translation attributes translatable, context and comments.
* *
* Here is a UI definition fragment specifying GtkComboBoxText items: * Here is a UI definition fragment specifying GtkComboBoxText items:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkComboBoxText"> * <object class="GtkComboBoxText">
* <items> * <items>
* <item translatable="yes" id="factory">Factory</item> * <item translatable="yes" id="factory">Factory</item>

View File

@ -241,19 +241,20 @@
* # GtkContainer as GtkBuildable * # GtkContainer as GtkBuildable
* *
* The GtkContainer implementation of the GtkBuildable interface supports * The GtkContainer implementation of the GtkBuildable interface supports
* a <packing> element for children, which can contain multiple <property> * a `<packing>` element for children, which can contain multiple `<property>`
* elements that specify child properties for the child. * elements that specify child properties for the child.
* *
* Since 2.16, child properties can also be marked as translatable using * Since 2.16, child properties can also be marked as translatable using
* the same translatable, comments and context attributes that are used * the same translatable, comments and context attributes that are used
* for regular properties. * for regular properties.
* *
* Since 3.16, containers can have a <focus-chain> element containing multiple * Since 3.16, containers can have a `<focus-chain>` element containing multiple
* <widget> elements, one for each child that should be added to the focus * `<widget>` elements, one for each child that should be added to the focus
* chain. The name attribute gives the id of the widget. * chain. The name attribute gives the id of the widget.
* *
* An example of these properties in UI definitions: * An example of these properties in UI definitions:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkBox"> * <object class="GtkBox">
* <child> * <child>
* <object class="GtkEntry" id="entry1"/> * <object class="GtkEntry" id="entry1"/>

View File

@ -141,21 +141,22 @@
* @vbox and @action_area as internal children with the names vbox and * @vbox and @action_area as internal children with the names vbox and
* action_area. * action_area.
* *
* GtkDialog supports a custom <action-widgets> element, which can contain * GtkDialog supports a custom `<action-widgets>` element, which can contain
* multiple <action-widget> elements. The response attribute specifies a * multiple `<action-widget>` elements. The response attribute specifies a
* numeric response, and the content of the element is the id of widget * numeric response, and the content of the element is the id of widget
* (which should be a child of the dialogs @action_area). To mark a response * (which should be a child of the dialogs @action_area). To mark a response
* as default, set the default attribute of the <action-widget> element * as default, set the default attribute of the `<action-widget>` element
* to true. * to true.
* *
* GtkDialog supports adding action widgets by specifying action as * GtkDialog supports adding action widgets by specifying action as
* the type attribute of a <child> element. The widget will be added * the type attribute of a `<child>` element. The widget will be added
* either to the action area or the headerbar of the dialog, depending * either to the action area or the headerbar of the dialog, depending
* on the use-header-bar property. The response id has to be associated * on the use-header-bar property. The response id has to be associated
* with the action widget using the <action-widgets> element. * with the action widget using the `<action-widgets>` element.
* *
* An example of a #GtkDialog UI definition fragment: * An example of a #GtkDialog UI definition fragment:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkDialog" id="dialog1"> * <object class="GtkDialog" id="dialog1">
* <child type="action"> * <child type="action">
* <object class="GtkButton" id="button_cancel"/> * <object class="GtkButton" id="button_cancel"/>

View File

@ -77,11 +77,12 @@
* *
* The GtkExpander implementation of the GtkBuildable interface supports * The GtkExpander implementation of the GtkBuildable interface supports
* placing a child in the label position by specifying label as the * placing a child in the label position by specifying label as the
* type attribute of a <child> element. A normal content child can be * type attribute of a `<child>` element. A normal content child can be
* specified without specifying a <child> type attribute. * specified without specifying a `<child>` type attribute.
* *
* An example of a UI definition fragment with GtkExpander: * An example of a UI definition fragment with GtkExpander:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkExpander"> * <object class="GtkExpander">
* <child type="label"> * <child type="label">
* <object class="GtkLabel" id="expander-label"/> * <object class="GtkLabel" id="expander-label"/>

View File

@ -41,14 +41,15 @@
* # GtkFileFilter as GtkBuildable * # GtkFileFilter as GtkBuildable
* *
* The GtkFileFilter implementation of the GtkBuildable interface * The GtkFileFilter implementation of the GtkBuildable interface
* supports adding rules using the <mime-types>, <patterns> and * supports adding rules using the `<mime-types>`, `<patterns>` and
* <applications> elements and listing the rules within. Specifying * `<applications>` elements and listing the rules within. Specifying
* a <mime-type> or <pattern> has the same effect as as calling * a `<mime-type>` or `<pattern>` has the same effect as as calling
* gtk_file_filter_add_mime_type() or gtk_file_filter_add_pattern(). * gtk_file_filter_add_mime_type() or gtk_file_filter_add_pattern().
* *
* An example of a UI definition fragment specifying GtkFileFilter * An example of a UI definition fragment specifying GtkFileFilter
* rules: * rules:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkFileFilter"> * <object class="GtkFileFilter">
* <mime-types> * <mime-types>
* <mime-type>text/plain</mime-type> * <mime-type>text/plain</mime-type>

View File

@ -53,13 +53,14 @@
* *
* # GtkFrame as GtkBuildable * # GtkFrame as GtkBuildable
* *
* The GtkFrame implementation of the GtkBuildable interface supports * The GtkFrame implementation of the #GtkBuildable interface supports
* placing a child in the label position by specifying label as the * placing a child in the label position by specifying label as the
* type attribute of a <child> element. A normal content child can * type attribute of a `<child>` element. A normal content child can
* be specified without specifying a <child> type attribute. * be specified without specifying a `<child>` type attribute.
* *
* An example of a UI definition fragment with GtkFrame: * An example of a UI definition fragment with `GtkFrame`:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkFrame"> * <object class="GtkFrame">
* <child type="label"> * <child type="label">
* <object class="GtkLabel" id="frame-label"/> * <object class="GtkLabel" id="frame-label"/>

View File

@ -118,8 +118,8 @@
* the content area and action area as internal children with the names * the content area and action area as internal children with the names
* content_area and action_area. * content_area and action_area.
* *
* GtkInfoBar supports a custom <action-widgets> element, which can contain * GtkInfoBar supports a custom `<action-widgets>` element, which can contain
* multiple <action-widget> elements. The response attribute specifies a * multiple `<action-widget>` elements. The response attribute specifies a
* numeric response, and the content of the element is the id of widget * numeric response, and the content of the element is the id of widget
* (which should be a child of the dialogs @action_area). * (which should be a child of the dialogs @action_area).
* *

View File

@ -98,13 +98,14 @@
* # GtkLabel as GtkBuildable * # GtkLabel as GtkBuildable
* *
* The GtkLabel implementation of the GtkBuildable interface supports a * The GtkLabel implementation of the GtkBuildable interface supports a
* custom <attributes> element, which supports any number of <attribute> * custom `<attributes>` element, which supports any number of `<attribute>`
* elements. The <attribute> element has attributes named name, value, * elements. The `<attribute>` element has attributes named name, value,
* start and end and allows you to specify #PangoAttribute values for * start and end and allows you to specify #PangoAttribute values for
* this label. * this label.
* *
* An example of a UI definition fragment specifying Pango attributes: * An example of a UI definition fragment specifying Pango attributes:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkLabel"> * <object class="GtkLabel">
* <attributes> * <attributes>
* <attribute name="weight" value="PANGO_WEIGHT_BOLD"/> * <attribute name="weight" value="PANGO_WEIGHT_BOLD"/>

View File

@ -92,8 +92,8 @@
* # GtkLevelBar as GtkBuildable * # GtkLevelBar as GtkBuildable
* *
* The GtkLevelBar implementation of the GtkBuildable interface supports a * The GtkLevelBar implementation of the GtkBuildable interface supports a
* custom <offsets> element, which can contain any number of <offset> elements, * custom `<offsets>` element, which can contain any number of `<offset>` elements,
* each of which must have name and value attributes. * each of which must have "name" and "value" attributes.
* *
* # CSS nodes * # CSS nodes
* *

View File

@ -68,7 +68,7 @@
* *
* The GtkListBox implementation of the #GtkBuildable interface supports * The GtkListBox implementation of the #GtkBuildable interface supports
* setting a child as the placeholder by specifying placeholder as the type * setting a child as the placeholder by specifying placeholder as the type
* attribute of a <child> element. See gtk_list_box_set_placeholder() for info. * attribute of a `<child>` element. See gtk_list_box_set_placeholder() for info.
* *
* # CSS nodes * # CSS nodes
* *

View File

@ -54,6 +54,7 @@
* #GdkPixbufs stored. * #GdkPixbufs stored.
* *
* An example for creating a simple list store: * An example for creating a simple list store:
*
* |[<!-- language="C" --> * |[<!-- language="C" -->
* enum { * enum {
* COLUMN_STRING, * COLUMN_STRING,
@ -134,14 +135,14 @@
* # GtkListStore as GtkBuildable * # GtkListStore as GtkBuildable
* *
* The GtkListStore implementation of the GtkBuildable interface allows * The GtkListStore implementation of the GtkBuildable interface allows
* to specify the model columns with a <columns> element that may contain * to specify the model columns with a `<columns>` element that may contain
* multiple <column> elements, each specifying one model column. The type * multiple `<column>` elements, each specifying one model column. The type
* attribute specifies the data type for the column. * attribute specifies the data type for the column.
* *
* Additionally, it is possible to specify content for the list store * Additionally, it is possible to specify content for the list store
* in the UI definition, with the <data> element. It can contain multiple * in the UI definition, with the `<data>` element. It can contain multiple
* <row> elements, each specifying to content for one row of the list model. * `<row>` elements, each specifying to content for one row of the list model.
* Inside a <row>, the <col> elements specify the content for individual cells. * Inside a `<row>`, the `<col>` elements specify the content for individual cells.
* *
* Note that it is probably more common to define your models in the code, * Note that it is probably more common to define your models in the code,
* and one might consider it a layering violation to specify the content of * and one might consider it a layering violation to specify the content of
@ -149,7 +150,8 @@
* is to separate the two, as far as possible. * is to separate the two, as far as possible.
* *
* An example of a UI Definition fragment for a list store: * An example of a UI Definition fragment for a list store:
* |[<!-- language="C" --> *
* |[<!-- language="xml" -->
* <object class="GtkListStore"> * <object class="GtkListStore">
* <columns> * <columns>
* <column type="gchararray"/> * <column type="gchararray"/>

View File

@ -70,6 +70,7 @@
* For more advanced label settings, you can fetch the child widget from the GtkBin. * For more advanced label settings, you can fetch the child widget from the GtkBin.
* *
* An example for setting markup and accelerator on a MenuItem: * An example for setting markup and accelerator on a MenuItem:
*
* |[<!-- language="C" --> * |[<!-- language="C" -->
* GtkWidget *menu_item = gtk_menu_item_new_with_label ("Example Menu Item"); * GtkWidget *menu_item = gtk_menu_item_new_with_label ("Example Menu Item");
* *
@ -82,10 +83,11 @@
* *
* The GtkMenuItem implementation of the #GtkBuildable interface supports * The GtkMenuItem implementation of the #GtkBuildable interface supports
* adding a submenu by specifying submenu as the type attribute of * adding a submenu by specifying submenu as the type attribute of
* a <child> element. * a `<child>` element.
* *
* An example of UI definition fragment with submenus: * An example of UI definition fragment with submenus:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkMenuItem"> * <object class="GtkMenuItem">
* <child type="submenu"> * <child type="submenu">
* <object class="GtkMenu"/> * <object class="GtkMenu"/>

View File

@ -51,10 +51,11 @@
* *
* The GtkMenuToolButton implementation of the GtkBuildable interface * The GtkMenuToolButton implementation of the GtkBuildable interface
* supports adding a menu by specifying menu as the type attribute * supports adding a menu by specifying menu as the type attribute
* of a <child> element. * of a `<child>` element.
* *
* An example for a UI definition fragment with menus: * An example for a UI definition fragment with menus:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkMenuToolButton"> * <object class="GtkMenuToolButton">
* <child type="menu"> * <child type="menu">
* <object class="GtkMenu"/> * <object class="GtkMenu"/>

View File

@ -74,17 +74,18 @@
* *
* The GtkNotebook implementation of the #GtkBuildable interface * The GtkNotebook implementation of the #GtkBuildable interface
* supports placing children into tabs by specifying tab as the * supports placing children into tabs by specifying tab as the
* type attribute of a <child> element. Note that the content * type attribute of a `<child>` element. Note that the content
* of the tab must be created before the tab can be filled. * of the tab must be created before the tab can be filled.
* A tab child can be specified without specifying a <child> * A tab child can be specified without specifying a `<child>`
* type attribute. * type attribute.
* *
* To add a child widget in the notebooks action area, specify * To add a child widget in the notebooks action area, specify
* "action-start" or action-end as the type attribute of the * "action-start" or action-end as the type attribute of the
* <child> element. * `<child>` element.
* *
* An example of a UI definition fragment with GtkNotebook: * An example of a UI definition fragment with GtkNotebook:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkNotebook"> * <object class="GtkNotebook">
* <child> * <child>
* <object class="GtkLabel" id="notebook-content"> * <object class="GtkLabel" id="notebook-content">

View File

@ -48,7 +48,7 @@
* *
* # Example * # Example
* *
* |[ * |[<!-- language="xml" -->
* <object class="GtkPopoverMenu"> * <object class="GtkPopoverMenu">
* <child> * <child>
* <object class="GtkBox"> * <object class="GtkBox">

View File

@ -43,14 +43,16 @@
* ## GtkRecentFilter as GtkBuildable * ## GtkRecentFilter as GtkBuildable
* *
* The GtkRecentFilter implementation of the GtkBuildable interface * The GtkRecentFilter implementation of the GtkBuildable interface
* supports adding rules using the <mime-types>, <patterns> and * supports adding rules using the `<mime-types>`, `<patterns>` and
* <applications> elements and listing the rules within. Specifying * `<applications>` elements and listing the rules within. Specifying
* a <mime-type>, <pattern> or <application> has the same effect as * a `<mime-type>`, `<pattern>` or `<application>` has the same effect as
* calling gtk_recent_filter_add_mime_type(), * calling gtk_recent_filter_add_mime_type(),
* gtk_recent_filter_add_pattern() or gtk_recent_filter_add_application(). * gtk_recent_filter_add_pattern() or gtk_recent_filter_add_application().
* *
* An example of a UI definition fragment specifying GtkRecentFilter rules: * An example of a UI definition fragment specifying `GtkRecentFilter`
* |[ * rules:
*
* |[<!-- language="xml" -->
* <object class="GtkRecentFilter"> * <object class="GtkRecentFilter">
* <mime-types> * <mime-types>
* <mime-type>text/plain</mime-type> * <mime-type>text/plain</mime-type>

View File

@ -68,8 +68,8 @@
* *
* # GtkScale as GtkBuildable * # GtkScale as GtkBuildable
* *
* GtkScale supports a custom <marks> element, which can contain multiple * GtkScale supports a custom `<marks>` element, which can contain multiple
* <mark> elements. The value and position attributes have the same * `<mark>` elements. The value and position attributes have the same
* meaning as gtk_scale_add_mark() parameters of the same name. If the * meaning as gtk_scale_add_mark() parameters of the same name. If the
* element is not empty, its content is taken as the markup to show at * element is not empty, its content is taken as the markup to show at
* the mark. It can be translated with the usual translatable and * the mark. It can be translated with the usual translatable and

View File

@ -515,20 +515,21 @@ gtk_shortcuts_shortcut_class_init (GtkShortcutsShortcutClass *klass)
* The syntax of this property is (an extension of) the syntax understood by * The syntax of this property is (an extension of) the syntax understood by
* gtk_accelerator_parse(). Multiple accelerators can be specified by separating * gtk_accelerator_parse(). Multiple accelerators can be specified by separating
* them with a space, but keep in mind that the available width is limited. * them with a space, but keep in mind that the available width is limited.
* It is also possible to specify ranges of shortcuts, using ... between the keys. * It is also possible to specify ranges of shortcuts, using `...` between the keys.
* Sequences of keys can be specified using a + or & between the keys. * Sequences of keys can be specified using a `+` or `&` between the keys.
* *
* Examples: * Examples:
* - A single shortcut: <ctl><alt>delete *
* - Two alternative shortcuts: <shift>a Home * - A single shortcut: `<ctl><alt>delete`
* - A range of shortcuts: <alt>1...<alt>9 * - Two alternative shortcuts: `<shift>a Home`
* - Several keys pressed together: Control_L&Control_R * - A range of shortcuts: `<alt>1...<alt>9`
* - A sequence of shortcuts or keys: <ctl>c+<ctl>x * - Several keys pressed together: `Control_L&Control_R`
* - A sequence of shortcuts or keys: `<ctl>c+<ctl>x`
* *
* Use + instead of & when the keys may (or have to be) pressed sequentially (e.g * Use + instead of & when the keys may (or have to be) pressed sequentially (e.g
* use t+t for 'press the t key twice'). * use t+t for 'press the t key twice').
* *
* Note that <, > and & need to be escaped as &lt;, &gt; and &amp; when used * Note that `<`, `>` and `&` need to be escaped as &lt;, &gt; and &amp; when used
* in .ui files. * in .ui files.
*/ */
properties[PROP_ACCELERATOR] = properties[PROP_ACCELERATOR] =

View File

@ -84,14 +84,15 @@
* *
* # GtkSizeGroup as GtkBuildable * # GtkSizeGroup as GtkBuildable
* *
* Size groups can be specified in a UI definition by placing an <object> * Size groups can be specified in a UI definition by placing an `<object>`
* element with `class="GtkSizeGroup"` somewhere in the UI definition. The * element with `class="GtkSizeGroup"` somewhere in the UI definition. The
* widgets that belong to the size group are specified by a <widgets> element * widgets that belong to the size group are specified by a `<widgets>` element
* that may contain multiple <widget> elements, one for each member of the * that may contain multiple `<widget>` elements, one for each member of the
* size group. The name attribute gives the id of the widget. * size group. The name attribute gives the id of the widget.
* *
* An example of a UI definition fragment with GtkSizeGroup: * An example of a UI definition fragment with GtkSizeGroup:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkSizeGroup"> * <object class="GtkSizeGroup">
* <property name="mode">GTK_SIZE_GROUP_HORIZONTAL</property> * <property name="mode">GTK_SIZE_GROUP_HORIZONTAL</property>
* <widgets> * <widgets>

View File

@ -49,10 +49,11 @@
* *
* The GtkTextTagTable implementation of the GtkBuildable interface * The GtkTextTagTable implementation of the GtkBuildable interface
* supports adding tags by specifying tag as the type attribute * supports adding tags by specifying tag as the type attribute
* of a <child> element. * of a `<child>` element.
* *
* An example of a UI definition fragment specifying tags: * An example of a UI definition fragment specifying tags:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkTextTagTable"> * <object class="GtkTextTagTable">
* <child type="tag"> * <child type="tag">
* <object class="GtkTextTag"/> * <object class="GtkTextTag"/>

View File

@ -45,12 +45,13 @@
* # GtkTreeStore as GtkBuildable * # GtkTreeStore as GtkBuildable
* *
* The GtkTreeStore implementation of the #GtkBuildable interface allows * The GtkTreeStore implementation of the #GtkBuildable interface allows
* to specify the model columns with a <columns> element that may contain * to specify the model columns with a `<columns>` element that may contain
* multiple <column> elements, each specifying one model column. The type * multiple `<column>` elements, each specifying one model column. The type
* attribute specifies the data type for the column. * attribute specifies the data type for the column.
* *
* An example of a UI Definition fragment for a tree store: * An example of a UI Definition fragment for a tree store:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkTreeStore"> * <object class="GtkTreeStore">
* <columns> * <columns>
* <column type="gchararray"/> * <column type="gchararray"/>

View File

@ -99,11 +99,12 @@
* # GtkTreeView as GtkBuildable * # GtkTreeView as GtkBuildable
* *
* The GtkTreeView implementation of the GtkBuildable interface accepts * The GtkTreeView implementation of the GtkBuildable interface accepts
* #GtkTreeViewColumn objects as <child> elements and exposes the internal * #GtkTreeViewColumn objects as `<child>` elements and exposes the internal
* #GtkTreeSelection in UI definitions. * #GtkTreeSelection in UI definitions.
* *
* An example of a UI definition fragment with GtkTreeView: * An example of a UI definition fragment with GtkTreeView:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkTreeView" id="treeview"> * <object class="GtkTreeView" id="treeview">
* <property name="model">liststore1</property> * <property name="model">liststore1</property>
* <child> * <child>

View File

@ -275,23 +275,25 @@
* # GtkWidget as GtkBuildable * # GtkWidget as GtkBuildable
* *
* The GtkWidget implementation of the GtkBuildable interface supports a * The GtkWidget implementation of the GtkBuildable interface supports a
* custom <accelerator> element, which has attributes named key, modifiers * custom `<accelerator>` element, which has attributes named key, modifiers
* and signal and allows to specify accelerators. * and signal and allows to specify accelerators.
* *
* An example of a UI definition fragment specifying an accelerator: * An example of a UI definition fragment specifying an accelerator:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkButton"> * <object class="GtkButton">
* <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/> * <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/>
* </object> * </object>
* ]| * ]|
* *
* In addition to accelerators, GtkWidget also support a custom <accessible> * In addition to accelerators, GtkWidget also support a custom `<accessible>`
* element, which supports actions and relations. Properties on the accessible * element, which supports actions and relations. Properties on the accessible
* implementation of an object can be set by accessing the internal child * implementation of an object can be set by accessing the internal child
* accessible of a #GtkWidget. * accessible of a #GtkWidget.
* *
* An example of a UI definition fragment specifying an accessible: * An example of a UI definition fragment specifying an accessible:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkLabel" id="label1"/> * <object class="GtkLabel" id="label1"/>
* <property name="label">I am a Label for a Button</property> * <property name="label">I am a Label for a Button</property>
* </object> * </object>
@ -309,8 +311,9 @@
* ]| * ]|
* *
* Finally, GtkWidget allows style information such as style classes to * Finally, GtkWidget allows style information such as style classes to
* be associated with widgets, using the custom <style> element: * be associated with widgets, using the custom `<style>` element:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkButton" id="button1"> * <object class="GtkButton" id="button1">
* <style> * <style>
* <class name="my-special-button-class"/> * <class name="my-special-button-class"/>
@ -333,27 +336,28 @@
* is slightly different from regular #GtkBuilder XML. * is slightly different from regular #GtkBuilder XML.
* *
* Unlike regular interface descriptions, gtk_widget_class_set_template() will * Unlike regular interface descriptions, gtk_widget_class_set_template() will
* expect a <template> tag as a direct child of the toplevel <interface> * expect a `<template>` tag as a direct child of the toplevel `<interface>`
* tag. The <template> tag must specify the class attribute which must be * tag. The `<template>` tag must specify the class attribute which must be
* the type name of the widget. Optionally, the parent attribute may be * the type name of the widget. Optionally, the parent attribute may be
* specified to specify the direct parent type of the widget type, this is * specified to specify the direct parent type of the widget type, this is
* ignored by the GtkBuilder but required for Glade to introspect what kind * ignored by the GtkBuilder but required for Glade to introspect what kind
* of properties and internal children exist for a given type when the actual * of properties and internal children exist for a given type when the actual
* type does not exist. * type does not exist.
* *
* The XML which is contained inside the <template> tag behaves as if it were * The XML which is contained inside the `<template>` tag behaves as if it were
* added to the <object> tag defining @widget itself. You may set properties * added to the `<object>` tag defining "widget" itself. You may set properties
* on @widget by inserting <property> tags into the <template> tag, and also * on @widget by inserting `<property>` tags into the `<template>` tag, and also
* add <child> tags to add children and extend @widget in the normal way you * add `<child>` tags to add children and extend "widget" in the normal way you
* would with <object> tags. * would with `<object>` tags.
* *
* Additionally, <object> tags can also be added before and after the initial * Additionally, `<object>` tags can also be added before and after the initial
* <template> tag in the normal way, allowing one to define auxiliary objects * `<template>` tag in the normal way, allowing one to define auxiliary objects
* which might be referenced by other widgets declared as children of the * which might be referenced by other widgets declared as children of the
* <template> tag. * `<template>` tag.
* *
* An example of a GtkBuilder Template Definition: * An example of a GtkBuilder Template Definition:
* |[ *
* |[<!-- language="xml" -->
* <interface> * <interface>
* <template class="FooWidget" parent="GtkBox"> * <template class="FooWidget" parent="GtkBox">
* <property name="orientation">GTK_ORIENTATION_HORIZONTAL</property> * <property name="orientation">GTK_ORIENTATION_HORIZONTAL</property>

View File

@ -98,15 +98,16 @@
* # GtkWindow as GtkBuildable * # GtkWindow as GtkBuildable
* *
* The GtkWindow implementation of the #GtkBuildable interface supports a * The GtkWindow implementation of the #GtkBuildable interface supports a
* custom <accel-groups> element, which supports any number of <group> * custom `<accel-groups>` element, which supports any number of `<group>`
* elements representing the #GtkAccelGroup objects you want to add to * elements representing the #GtkAccelGroup objects you want to add to
* your window (synonymous with gtk_window_add_accel_group(). * your window (synonymous with gtk_window_add_accel_group().
* *
* It also supports the <initial-focus> element, whose name property names * It also supports the `<initial-focus>` element, whose name property names
* the widget to receive the focus when the window is mapped. * the widget to receive the focus when the window is mapped.
* *
* An example of a UI definition fragment with accel groups: * An example of a UI definition fragment with accel groups:
* |[ *
* |[<!-- language="xml" -->
* <object class="GtkWindow"> * <object class="GtkWindow">
* <accel-groups> * <accel-groups>
* <group name="accelgroup1"/> * <group name="accelgroup1"/>
@ -121,7 +122,7 @@
* *
* The GtkWindow implementation of the #GtkBuildable interface supports * The GtkWindow implementation of the #GtkBuildable interface supports
* setting a child as the titlebar by specifying titlebar as the type * setting a child as the titlebar by specifying titlebar as the type
* attribute of a <child> element. * attribute of a `<child>` element.
* *
* # CSS nodes * # CSS nodes
* *