GNOME.org
 

[gtkmm] Regenerate gtk docs.xml.

commit 603dffca04693a208c4b40c3bbd6a985237ccdc3
Author: Murray Cumming <murrayc murrayc com>
Date:   Tue Sep 15 10:22:27 2015 +0200

    Regenerate gtk docs.xml.

 gtk/src/gtk_docs.xml |  254 ++++++++++++++++++++++++++++++++++----------------
 1 files changed, 172 insertions(+), 82 deletions(-)
---
diff --git a/gtk/src/gtk_docs.xml b/gtk/src/gtk_docs.xml
index 2c74fd1..8acedd5 100644
--- a/gtk/src/gtk_docs.xml
+++ b/gtk/src/gtk_docs.xml
@@ -3091,10 +3091,10 @@ and store @new_text at the position indicated by @path.
 
 <property name="GtkCellRendererText:alignment">
 <description>
-Specifies how to align the lines of text with respect to each other. 
+Specifies how to align the lines of text with respect to each other.
 
-Note that this property describes how to align the lines of text in 
-case there are several of them. The &quot;xalign&quot; property of #GtkCellRenderer, 
+Note that this property describes how to align the lines of text in
+case there are several of them. The &quot;xalign&quot; property of #GtkCellRenderer,
 on the other hand, sets the horizontal alignment of the whole text.
 
 Since: 2.10
@@ -3122,8 +3122,8 @@ Since: 3.0
 
 <property name="GtkCellRendererText:ellipsize">
 <description>
-Specifies the preferred place to ellipsize the string, if the cell renderer 
-does not have enough room to display the entire string. Setting it to 
+Specifies the preferred place to ellipsize the string, if the cell renderer
+does not have enough room to display the entire string. Setting it to
 %PANGO_ELLIPSIZE_NONE turns off ellipsizing. See the wrap-width property
 for another way of making the text fit into a given width.
 
@@ -3152,7 +3152,7 @@ Since: 3.0
 
 <property name="GtkCellRendererText:max-width-chars">
 <description>
-The desired maximum width of the cell, in characters. If this property 
+The desired maximum width of the cell, in characters. If this property
 is set to -1, the width will be calculated automatically.
 
 For cell renderers that ellipsize or wrap text; this property
@@ -3189,8 +3189,8 @@ Since: 2.6
 
 <property name="GtkCellRendererText:wrap-mode">
 <description>
-Specifies how to break the string into multiple lines, if the cell 
-renderer does not have enough room to display the entire string. 
+Specifies how to break the string into multiple lines, if the cell
+renderer does not have enough room to display the entire string.
 This property has no effect unless the wrap-width property is set.
 
 Since: 2.8
@@ -3200,7 +3200,7 @@ Since: 2.8
 
 <property name="GtkCellRendererText:wrap-width">
 <description>
-Specifies the minimum width at which the text is wrapped. The wrap-mode property can 
+Specifies the minimum width at which the text is wrapped. The wrap-mode property can
 be used to influence at what character positions the line breaks can be placed.
 Setting wrap-width to -1 turns wrapping off.
 
@@ -4706,7 +4706,7 @@ Since: 3.6
 Whether password entries will show a warning when Caps Lock is on.
 
 Note that the warning is shown using a secondary icon, and thus
-does not work if you are using the secondary icon position for some 
+does not work if you are using the secondary icon position for some
 other purpose.
 
 Since: 2.16
@@ -4735,11 +4735,11 @@ Since: 2.16
 
 <property name="GtkEntry:im-module">
 <description>
-Which IM (input method) module should be used for this entry. 
+Which IM (input method) module should be used for this entry.
 See #GtkIMContext.
 
 Setting this to a non-%NULL value overrides the
-system-wide IM module setting. See the GtkSettings 
+system-wide IM module setting. See the GtkSettings
 #GtkSettings:gtk-im-module property.
 
 Since: 2.16
@@ -4855,10 +4855,10 @@ Since: 3.8
 <description>
 Whether the primary icon is activatable.
 
-GTK+ emits the #GtkEntry::icon-press and #GtkEntry::icon-release 
-signals only on sensitive, activatable icons. 
+GTK+ emits the #GtkEntry::icon-press and #GtkEntry::icon-release
+signals only on sensitive, activatable icons.
 
-Sensitive, but non-activatable icons can be used for purely 
+Sensitive, but non-activatable icons can be used for purely
 informational purposes.
 
 Since: 2.16
@@ -4897,8 +4897,8 @@ Since: 2.16
 <description>
 Whether the primary icon is sensitive.
 
-An insensitive icon appears grayed out. GTK+ does not emit the 
-#GtkEntry::icon-press and #GtkEntry::icon-release signals and 
+An insensitive icon appears grayed out. GTK+ does not emit the
+#GtkEntry::icon-press and #GtkEntry::icon-release signals and
 does not allow DND from insensitive icons.
 
 An icon should be set insensitive if the action that would trigger
@@ -4997,10 +4997,10 @@ See gtk_search_bar_set_search_mode() for details.
 <description>
 Whether the secondary icon is activatable.
 
-GTK+ emits the #GtkEntry::icon-press and #GtkEntry::icon-release 
+GTK+ emits the #GtkEntry::icon-press and #GtkEntry::icon-release
 signals only on sensitive, activatable icons.
 
-Sensitive, but non-activatable icons can be used for purely 
+Sensitive, but non-activatable icons can be used for purely
 informational purposes.
 
 Since: 2.16
@@ -5039,8 +5039,8 @@ Since: 2.16
 <description>
 Whether the secondary icon is sensitive.
 
-An insensitive icon appears grayed out. GTK+ does not emit the 
-#GtkEntry::icon-press and #GtkEntry::icon-release signals and 
+An insensitive icon appears grayed out. GTK+ does not emit the
+#GtkEntry::icon-press and #GtkEntry::icon-release signals and
 does not allow DND from insensitive icons.
 
 An icon should be set insensitive if the action that would trigger
@@ -5096,7 +5096,7 @@ Since: 2.16
 
 <property name="GtkEntry:shadow-type">
 <description>
-Which kind of shadow to draw around the entry when 
+Which kind of shadow to draw around the entry when
 #GtkEntry:has-frame is set to %TRUE.
 
 Since: 2.12
@@ -5131,7 +5131,7 @@ Since: 2.10
 
 <property name="GtkEntry:xalign">
 <description>
-The horizontal alignment, from 0 (left) to 1 (right). 
+The horizontal alignment, from 0 (left) to 1 (right).
 Reversed for RTL layouts.
 
 Since: 2.4
@@ -5354,8 +5354,9 @@ Since: 3.14
 <description>
 The #GtkCellArea used to layout cell renderers in the treeview column.
 
-If no area is specified when creating the entry completion with gtk_entry_completion_new_with_area() 
-a horizontally oriented #GtkCellAreaBox will be used.
+If no area is specified when creating the entry completion with
+gtk_entry_completion_new_with_area() a horizontally oriented
+#GtkCellAreaBox will be used.
 
 Since: 3.0
 
@@ -7927,8 +7928,8 @@ Deprecated: 3.10: Use #GtkImage:icon-name instead.
 <property name="GtkImage:pixel-size">
 <description>
 The &quot;pixel-size&quot; property can be used to specify a fixed size
-overriding the #GtkImage:icon-size property for images of type 
-%GTK_IMAGE_ICON_NAME. 
+overriding the #GtkImage:icon-size property for images of type
+%GTK_IMAGE_ICON_NAME.
 
 Since: 2.6
 
@@ -8506,14 +8507,14 @@ Since: 2.6
 
 <property name="GtkLabel:ellipsize">
 <description>
-The preferred place to ellipsize the string, if the label does 
-not have enough room to display the entire string, specified as a 
-#PangoEllipsizeMode. 
+The preferred place to ellipsize the string, if the label does
+not have enough room to display the entire string, specified as a
+#PangoEllipsizeMode.
 
-Note that setting this property to a value other than 
-%PANGO_ELLIPSIZE_NONE has the side-effect that the label requests 
-only enough space to display the ellipsis &quot;...&quot;. In particular, this 
-means that ellipsizing labels do not work well in notebook tabs, unless 
+Note that setting this property to a value other than
+%PANGO_ELLIPSIZE_NONE has the side-effect that the label requests
+only enough space to display the ellipsis &quot;...&quot;. In particular, this
+means that ellipsizing labels do not work well in notebook tabs, unless
 the #GtkNotebook tab-expand child property is set to %TRUE. Other ways
 to set a label's width are gtk_widget_set_size_request() and
 gtk_label_set_width_chars().
@@ -8554,7 +8555,7 @@ Since: 3.10
 
 <property name="GtkLabel:max-width-chars">
 <description>
-The desired maximum width of the label, in characters. If this property 
+The desired maximum width of the label, in characters. If this property
 is set to -1, the width will be calculated automatically.
 
 See the section on [text layout][label-text-layout]
@@ -8571,7 +8572,7 @@ Since: 2.6
 Whether the label is in single line mode. In single line mode,
 the height of the label does not depend on the actual text, it
 is always set to ascent + descent of the font. This can be an
-advantage in situations where resizing the label because of text 
+advantage in situations where resizing the label because of text
 changes would be distracting, e.g. in a statusbar.
 
 Since: 2.6
@@ -8606,8 +8607,8 @@ Since: 2.6
 
 <property name="GtkLabel:wrap-mode">
 <description>
-If line wrapping is on (see the #GtkLabel:wrap property) this controls 
-how the line wrapping is done. The default is %PANGO_WRAP_WORD, which 
+If line wrapping is on (see the #GtkLabel:wrap property) this controls
+how the line wrapping is done. The default is %PANGO_WRAP_WORD, which
 means wrap on word boundaries.
 
 Since: 2.10
@@ -13509,7 +13510,7 @@ Since: 2.12
 
 <property name="GtkScrolledWindow:window-placement-set">
 <description>
-Whether &quot;window-placement&quot; should be used to determine the location 
+Whether &quot;window-placement&quot; should be used to determine the location
 of the contents with respect to the scrollbars.
 
 Since: 2.10
@@ -13661,40 +13662,6 @@ thumb is at the end
 </parameters>
 </enum>
 
-<signal name="GtkSettings::gtk-button-images">
-<description>
-Whether images should be shown on buttons
-
-Since: 2.4
-
-Deprecated: 3.10: This setting is deprecated. Application developers
-control whether a button should show an icon or not, on a
-per-button basis. If a #GtkButton should show an icon, use the
-#GtkButton:always-show-image property of #GtkButton, and pack a
-#GtkImage inside the #GtkButton
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</signal>
-
-<signal name="GtkSettings::gtk-menu-images">
-<description>
-Whether images should be shown in menu items
-
-Deprecated: 3.10: This setting is deprecated. Application developers
-control whether or not a #GtkMenuItem should have an icon or not,
-on a per widget basis. Either use a #GtkMenuItem with a #GtkBox
-containing a #GtkImage and a #GtkAccelLabel, or describe your menus
-using a #GMenu XML description
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</signal>
-
 <property name="GtkSettings:color-hash">
 <description>
 Holds a hash table representation of the #GtkSettings:gtk-color-scheme
@@ -13749,6 +13716,21 @@ Deprecated: 3.10: This setting is ignored
 </description>
 </property>
 
+<property name="GtkSettings:gtk-button-images">
+<description>
+Whether images should be shown on buttons
+
+Since: 2.4
+
+Deprecated: 3.10: This setting is deprecated. Application developers
+control whether a button should show an icon or not, on a
+per-button basis. If a #GtkButton should show an icon, use the
+#GtkButton:always-show-image property of #GtkButton, and pack a
+#GtkImage inside the #GtkButton
+
+</description>
+</property>
+
 <property name="GtkSettings:gtk-can-change-accels">
 <description>
 Whether menu accelerators can be changed by pressing a key over the menu item.
@@ -14082,6 +14064,19 @@ Deprecated: 3.10: This setting is ignored.
 </description>
 </property>
 
+<property name="GtkSettings:gtk-menu-images">
+<description>
+Whether images should be shown in menu items
+
+Deprecated: 3.10: This setting is deprecated. Application developers
+control whether or not a #GtkMenuItem should have an icon or not,
+on a per widget basis. Either use a #GtkMenuItem with a #GtkBox
+containing a #GtkImage and a #GtkAccelLabel, or describe your menus
+using a #GMenu XML description
+
+</description>
+</property>
+
 <property name="GtkSettings:gtk-menu-popdown-delay">
 <description>
 The time before hiding a submenu when the pointer is moving towards the submenu.
@@ -15825,8 +15820,8 @@ Since: 2.10
 
 <property name="GtkTextBuffer:cursor-position">
 <description>
-The position of the insert mark (as offset from the beginning 
-of the buffer). It is useful for getting notified when the 
+The position of the insert mark (as offset from the beginning
+of the buffer). It is useful for getting notified when the
 cursor moves.
 
 Since: 2.10
@@ -22113,7 +22108,10 @@ Since: 2.4
 
 <function name="gtk_accelerator_get_default_mod_mask">
 <description>
-Gets the value set by gtk_accelerator_set_default_mod_mask().
+Gets the modifier mask.
+
+The modifier mask determines which modifiers are considered significant
+for keyboard accelerators. See gtk_accelerator_set_default_mod_mask().
 
 
 </description>
@@ -22322,11 +22320,12 @@ modifier mask, %NULL
 <function name="gtk_accelerator_set_default_mod_mask">
 <description>
 Sets the modifiers that will be considered significant for keyboard
-accelerators. The default mod mask is #GDK_CONTROL_MASK |
-#GDK_SHIFT_MASK | #GDK_MOD1_MASK | #GDK_SUPER_MASK |
-#GDK_HYPER_MASK | #GDK_META_MASK, that is, Control, Shift, Alt,
-Super, Hyper and Meta. Other modifiers will by default be ignored
-by #GtkAccelGroup.
+accelerators. The default mod mask depends on the GDK backend in use,
+but will typically include #GDK_CONTROL_MASK | #GDK_SHIFT_MASK |
+#GDK_MOD1_MASK | #GDK_SUPER_MASK | #GDK_HYPER_MASK | #GDK_META_MASK.
+In other words, Control, Shift, Alt, Super, Hyper and Meta. Other
+modifiers will by default be ignored by #GtkAccelGroup.
+
 You must include at least the three modifiers Control, Shift
 and Alt in any value you pass to this function.
 
@@ -36872,7 +36871,7 @@ optionally by more name/return location pairs, followed by %NULL
 <description>
 Emits a #GtkWidget::child-notify signal for the
 [child property][child-properties]
- child_property on widget.
+ child_property on the child.
 
 This is an analogue of g_object_notify() for child properties.
 
@@ -36899,6 +36898,35 @@ the class of @container
 <return></return>
 </function>
 
+<function name="gtk_container_child_notify_by_pspec">
+<description>
+Emits a #GtkWidget::child-notify signal for the
+[child property][child-properties] specified by
+ pspec on the child.
+
+This is an analogue of g_object_notify_by_pspec() for child properties.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="container">
+<parameter_description> the #GtkContainer
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> the child widget
+</parameter_description>
+</parameter>
+<parameter name="pspec">
+<parameter_description> the #GParamSpec of a child property instealled on
+the class of @container
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gtk_container_child_set">
 <description>
 Sets one or more child properties for @child and @container.
@@ -37044,6 +37072,31 @@ for them.
 <return></return>
 </function>
 
+<function name="gtk_container_class_install_child_properties">
+<description>
+Installs child properties on a container class.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="cclass">
+<parameter_description> a #GtkContainerClass
+</parameter_description>
+</parameter>
+<parameter name="n_pspecs">
+<parameter_description> the length of the #GParamSpec array
+</parameter_description>
+</parameter>
+<parameter name="pspecs">
+<parameter_description> the #GParamSpec array defining the new
+child properties
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gtk_container_class_install_child_property">
 <description>
 Installs a child property on a container class.
@@ -45015,6 +45068,10 @@ It is undefined to add or remove widgets directly (for example, with
 gtk_flow_box_insert() or gtk_container_add()) while @box is bound to a
 model.
 
+Note that using a model is incompatible with the filtering and sorting
+functionality in GtkFlowBox. When using a model, filtering and sorting
+should be implemented by the model.
+
 Since: 3.18
 
 </description>
@@ -45502,6 +45559,9 @@ it will continue to be called each time a child changes (via
 gtk_flow_box_child_changed()) or when gtk_flow_box_invalidate_filter()
 is called.
 
+Note that using a filter function is incompatible with using a model
+(see gtk_flow_box_bind_model()).
+
 Since: 3.12
 
 </description>
@@ -45679,6 +45739,9 @@ and will continue to be called each time a child changes (via
 gtk_flow_box_child_changed()) and when gtk_flow_box_invalidate_sort()
 is called.
 
++ * Note that using a sort function is incompatible with using a model
++ * (see gtk_list_box_bind_model()).
+
 Since: 3.12
 
 </description>
@@ -58049,6 +58112,10 @@ It is undefined to add or remove widgets directly (for example, with
 gtk_list_box_insert() or gtk_container_add()) while @box is bound to a
 model.
 
+Note that using a model is incompatible with the filtering and sorting
+functionality in GtkListBox. When using a model, filtering and sorting
+should be implemented by the model.
+
 Since: 3.16
 
 </description>
@@ -58063,6 +58130,7 @@ Since: 3.16
 </parameter>
 <parameter name="create_widget_func">
 <parameter_description> a function that creates widgets for items
+or %NULL in case you also passed %NULL as @model
 </parameter_description>
 </parameter>
 <parameter name="user_data">
@@ -58705,6 +58773,9 @@ The @filter_func will be called for each row after the call, and it will
 continue to be called each time a row changes (via gtk_list_box_row_changed()) or
 when gtk_list_box_invalidate_filter() is called.
 
+Note that using a filter function is incompatible with using a model
+(see gtk_list_box_bind_model()).
+
 Since: 3.10
 
 </description>
@@ -58825,6 +58896,9 @@ The @sort_func will be called for each row after the call, and will continue to
 be called each time a row changes (via gtk_list_box_row_changed()) and when
 gtk_list_box_invalidate_sort() is called.
 
+Note that using a sort function is incompatible with using a model
+(see gtk_list_box_bind_model()).
+
 Since: 3.10
 
 </description>
@@ -66718,6 +66792,22 @@ Since: 3.18
 <return></return>
 </function>
 
+<function name="gtk_places_view_get_loading">
+<description>
+Returns %TRUE if the view is loading locations.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="view">
+<parameter_description> a #GtkPlacesView
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gtk_places_view_get_local_only">
 <description>
 Returns %TRUE if only local volumes are shown, i.e. no networks
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]