[gtkmm] Regenerate *_docs.xml files.

From: Murray Cumming <murrayc src gnome org>
To: commits-list gnome org
Cc:
Subject: [gtkmm] Regenerate *_docs.xml files.
Date: Tue, 30 Jun 2015 09:34:32 +0000 (UTC)
commit 594a2a97aede7a83d69ecac82ea9fc5423116757
Author: Murray Cumming <murrayc murrayc com>
Date:   Tue Jun 30 10:12:19 2015 +0200

    Regenerate *_docs.xml files.

 gdk/src/gdk_docs.xml |   56 ++++++++
 gtk/src/gtk_docs.xml |  383 +++++++++++++++++++++++++++++++++++++++++++++-----
 2 files changed, 402 insertions(+), 37 deletions(-)
---
diff --git a/gdk/src/gdk_docs.xml b/gdk/src/gdk_docs.xml
index 9c6de2c..836e6c4 100644
--- a/gdk/src/gdk_docs.xml
+++ b/gdk/src/gdk_docs.xml
@@ -16548,6 +16548,25 @@ there are offscreen windows in the hierarchy.
 </return>
 </function>
 
+<function name="gdk_window_get_pass_through">
+<description>
+Returns whether input to the window is passed through to the window
+below.
+
+See gdk_window_set_pass_through() for details
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gdk_window_get_pointer">
 <description>
 Obtains the current pointer position and modifier state.
@@ -18502,6 +18521,43 @@ window in its implementation, for example.
 <return></return>
 </function>
 
+<function name="gdk_window_set_pass_through">
+<description>
+Sets whether input to the window is passed through to the window
+below.
+
+The default value of this is %FALSE, which means that pointer
+events that happen inside the window are send first to the window,
+but if the event is not selected by the event mask then the event
+is sent to the parent window, and so on up the hierarchy.
+
+If @pass_through is %TRUE then such pointer events happen as if the
+window wasn't there at all, and thus will be sent first to any
+windows below @window. This is useful if the window is used in a
+transparent fashion. In the terminology of the web this would be called
+&quot;pointer-events: none&quot;.
+
+Note that a window with @pass_through %TRUE can still have a subwindow
+without pass through, so you can get events on a subset of a window. And in
+that cases you would get the in-between related events such as the pointer
+enter/leave events on its way to the destination window.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="pass_through">
+<parameter_description> a boolean
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gdk_window_set_role">
 <description>
 When using GTK+, typically you should use gtk_window_set_role() instead
diff --git a/gtk/src/gtk_docs.xml b/gtk/src/gtk_docs.xml
index bb94c4e..e63c564 100644
--- a/gtk/src/gtk_docs.xml
+++ b/gtk/src/gtk_docs.xml
@@ -850,6 +850,8 @@ The padding to insert at the bottom of the widget.
 
 Since: 2.4
 
+Deprecated: 3.14: Use gtk_widget_set_margin_bottom() instead
+
 </description>
 </property>
 
@@ -859,6 +861,8 @@ The padding to insert at the left of the widget.
 
 Since: 2.4
 
+Deprecated: 3.14: Use gtk_widget_set_margin_start() instead
+
 </description>
 </property>
 
@@ -868,6 +872,8 @@ The padding to insert at the right of the widget.
 
 Since: 2.4
 
+Deprecated: 3.14: Use gtk_widget_set_margin_end() instead
+
 </description>
 </property>
 
@@ -877,6 +883,52 @@ The padding to insert at the top of the widget.
 
 Since: 2.4
 
+Deprecated: 3.14: Use gtk_widget_set_margin_top() instead
+
+</description>
+</property>
+
+<property name="GtkAlignment:xalign">
+<description>
+Horizontal position of child in available space. A value of 0.0
+will flush the child left (or right, in RTL locales); a value
+of 1.0 will flush the child right (or left, in RTL locales).
+
+Deprecated: 3.14: Use gtk_widget_set_halign() on the child instead
+
+</description>
+</property>
+
+<property name="GtkAlignment:xscale">
+<description>
+If available horizontal space is bigger than needed, how much
+of it to use for the child. A value of 0.0 means none; a value
+of 1.0 means all.
+
+Deprecated: 3.14: Use gtk_widget_set_hexpand() on the child instead
+
+</description>
+</property>
+
+<property name="GtkAlignment:yalign">
+<description>
+Vertical position of child in available space. A value of 0.0
+will flush the child to the top; a value of 1.0 will flush the
+child to the bottom.
+
+Deprecated: 3.14: Use gtk_widget_set_valign() on the child instead
+
+</description>
+</property>
+
+<property name="GtkAlignment:yscale">
+<description>
+If available vertical space is bigger than needed, how much
+of it to use for the child. A value of 0.0 means none; a value
+of 1.0 means all.
+
+Deprecated: 3.14: Use gtk_widget_set_vexpand() on the child instead
+
 </description>
 </property>
 
@@ -6447,16 +6499,6 @@ The font description as a #PangoFontDescription.
 </description>
 </property>
 
-<property name="GtkFontChooser:font-map">
-<description>
-A custom font map to use for this widget, instead of the
-default one.
-
-Since: 3.18
-
-</description>
-</property>
-
 <property name="GtkFontChooser:preview-text">
 <description>
 The string with which to preview the font.
@@ -6549,6 +6591,14 @@ Since: 3.16
 <parameter_description> the #GtkGLArea that emitted the signal
 </parameter_description>
 </parameter>
+<parameter name="width">
+<parameter_description> the width of the viewport
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the viewport
+</parameter_description>
+</parameter>
 </parameters>
 <return></return>
 </signal>
@@ -7917,7 +7967,7 @@ The Accel Group to use for stock accelerator keys
 
 Since: 2.16
 
-Deprecated: 3.10
+Deprecated: 3.10: Use gtk_widget_add_accelerator() instead 
 
 </description>
 </property>
@@ -7931,7 +7981,8 @@ without the image.
 
 Since: 2.16
 
-Deprecated: 3.10
+Deprecated: 3.10: Use a #GtkMenuItem containing a #GtkBox with
+a #GtkAccelLabel and a #GtkImage instead
 
 </description>
 </property>
@@ -7940,7 +7991,8 @@ Deprecated: 3.10
 <description>
 Child widget to appear next to the menu text.
 
-Deprecated: 3.10
+Deprecated: 3.10: Use a #GtkMenuItem containing a #GtkBox with
+a #GtkAccelLabel and a #GtkImage instead
 
 </description>
 </property>
@@ -7952,7 +8004,7 @@ stock id to select the stock item for the item.
 
 Since: 2.16
 
-Deprecated: 3.10
+Deprecated: 3.10: Use a named icon from the #GtkIconTheme instead
 
 </description>
 </property>
@@ -9572,6 +9624,51 @@ The type of message being displayed in the dialog.
 </parameters>
 </enum>
 
+<property name="GtkMisc:xalign">
+<description>
+The horizontal alignment. A value of 0.0 means left alignment (or right
+on RTL locales); a value of 1.0 means right alignment (or left on RTL
+locales).
+
+Deprecated: 3.14: Use gtk_widget_set_halign() instead. If you are using
+#GtkLabel, use #GtkLabel:xalign instead.
+
+</description>
+</property>
+
+<property name="GtkMisc:xpad">
+<description>
+The amount of space to add on the left and right of the widget, in
+pixels.
+
+Deprecated: 3.14: Use gtk_widget_set_margin_start() and
+gtk_widget_set_margin_end() instead
+
+</description>
+</property>
+
+<property name="GtkMisc:yalign">
+<description>
+The vertical alignment. A value of 0.0 means top alignment;
+a value of 1.0 means bottom alignment.
+
+Deprecated: 3.14: Use gtk_widget_set_valign() instead. If you are using
+#GtkLabel, use #GtkLabel:yalign instead.
+
+</description>
+</property>
+
+<property name="GtkMisc:ypad">
+<description>
+The amount of space to add on the top and bottom of the widget, in
+pixels.
+
+Deprecated: 3.14: Use gtk_widget_set_margin_top() and
+gtk_widget_set_margin_bottom() instead
+
+</description>
+</property>
+
 <property name="GtkModelButton:active">
 <description>
 The state of the button. This is reflecting the state of the associated
@@ -13475,7 +13572,11 @@ Whether images should be shown on buttons
 
 Since: 2.4
 
-Deprecated: 3.10: This setting is deprecated
+Deprecated: 3.10: This setting is deprecated. Application developers
+control whether a button should show an icon or now, 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>
@@ -13487,7 +13588,11 @@ Deprecated: 3.10: This setting is deprecated
 <description>
 Whether images should be shown in menu items
 
-Deprecated: 3.10: This setting is deprecated
+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>
@@ -14043,7 +14148,7 @@ occurs on the titlebar of client-side decorated windows.
 Recognized actions are minimize, toggle-maximize, menu, lower
 or none.
 
-Since: 3.14.1
+Since: 3.14
 
 </description>
 </property>
@@ -14056,7 +14161,7 @@ occurs on the titlebar of client-side decorated windows.
 Recognized actions are minimize, toggle-maximize, menu, lower
 or none.
 
-Since: 3.14.1
+Since: 3.14
 
 </description>
 </property>
@@ -14069,7 +14174,7 @@ occurs on the titlebar of client-side decorated windows.
 Recognized actions are minimize, toggle-maximize, menu, lower
 or none.
 
-Since: 3.14.1
+Since: 3.14
 
 </description>
 </property>
@@ -17404,7 +17509,8 @@ Since: 2.12
 <description>
 Sets a hint to the theme to draw rows in alternating colors.
 
-Deprecated: 3.14
+Deprecated: 3.14: The theme is responsible for drawing rows
+using zebra striping
 
 </description>
 </property>
@@ -18289,7 +18395,7 @@ things done in #GtkWidget::drag-begin.
 <signal name="GtkWidget::drag-failed">
 <description>
 The ::drag-failed signal is emitted on the drag source when a drag has
-failed. The signal handler may hook custom code to handle a failed DND
+failed. The signal handler may hook custom code to handle a failed DnD
 operation based on the type of error, it returns %TRUE is the failure has
 been already handled (not showing the default &quot;drag operation failed&quot;
 animation), otherwise it returns %FALSE.
@@ -26438,6 +26544,27 @@ Since: 2.10
 </return>
 </function>
 
+<function name="gtk_assistant_get_page_has_padding">
+<description>
+Gets whether page has padding.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
+</parameter_description>
+</parameter>
+<parameter name="page">
+<parameter_description> a page of @assistant
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @page has padding
+</return>
+</function>
+
 <function name="gtk_assistant_get_page_header_image">
 <description>
 Gets the header image for @page.
@@ -26771,6 +26898,31 @@ Since: 2.10
 <return></return>
 </function>
 
+<function name="gtk_assistant_set_page_has_padding">
+<description>
+Sets whether the assistant is adding padding around
+the page.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
+</parameter_description>
+</parameter>
+<parameter name="page">
+<parameter_description> a page of @assistant
+</parameter_description>
+</parameter>
+<parameter name="has_padding">
+<parameter_description> whether this page has padding
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gtk_assistant_set_page_header_image">
 <description>
 Sets a header image for @page.
@@ -63148,6 +63300,29 @@ Since: 3.2
 <return></return>
 </function>
 
+<function name="gtk_overlay_get_overlay_pass_through">
+<description>
+Convenience function to get the value of the #GtkOverlay:pass-through
+child property for @widget.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="overlay">
+<parameter_description> a #GtkOverlay
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> an overlay child of #GtkOverlay
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether the widget is a pass through child.
+
+</return>
+</function>
+
 <function name="gtk_overlay_new">
 <description>
 Creates a new #GtkOverlay.
@@ -63162,6 +63337,61 @@ Since: 3.2
 </return>
 </function>
 
+<function name="gtk_overlay_reorder_overlay">
+<description>
+Moves @child to a new @index in the list of @overlay children.
+The list contains overlays in the order that these were
+added to @overlay.
+
+A widget’s index in the @overlay children list determines which order
+the children are drawn if they overlap. The first child is drawn at
+the bottom. It also affects the default focus chain order.
+
+</description>
+<parameters>
+<parameter name="overlay">
+<parameter_description> a #GtkOverlay
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> the overlaid #GtkWidget to move
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the new index for @child in the list of overlay children
+of @overlay, starting from 0. If negative, indicates the end of
+the list
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_overlay_set_overlay_pass_through">
+<description>
+Convenience function to set the value of the #GtkOverlay:pass-through
+child property for @widget.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="overlay">
+<parameter_description> a #GtkOverlay
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> an overlay child of #GtkOverlay
+</parameter_description>
+</parameter>
+<parameter name="pass_through">
+<parameter_description> whether the child should pass the input through
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gtk_page_setup_copy">
 <description>
 Copies a #GtkPageSetup.
@@ -65885,6 +66115,24 @@ Since: 3.14
 </return>
 </function>
 
+<function name="gtk_places_sidebar_get_show_recent">
+<description>
+Returns the value previously set with gtk_places_sidebar_set_show_recent()
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="sidebar">
+<parameter_description> a places sidebar
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the sidebar will display a builtin shortcut for recent files
+
+</return>
+</function>
+
 <function name="gtk_places_sidebar_list_shortcuts">
 <description>
 Gets the list of shortcuts.
@@ -65949,6 +66197,39 @@ Since: 3.10
 <return></return>
 </function>
 
+<function name="gtk_places_sidebar_set_drop_targets_visible">
+<description>
+Make the GtkPlacesSidebar show drop targets, so it can show the available drop
+targets and a &quot;new bookmark&quot; row. This improves the drag and drop
+experience of the user and allow applications to show at once the available
+drop targets.
+This needs to be called when the application is aware of a drag and when
+the applications is aware of the end of a drag.
+It's not needed to take care of the drag if it finish in GtkPlacesSidebar, so
+it's not needed to conect to their signals to call gtk_places_sidebar_set_drop_targets_visible
+manually, just call it when the drag ends on some other widget on your application.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="sidebar">
+<parameter_description> a places sidebar.
+</parameter_description>
+</parameter>
+<parameter name="visible">
+<parameter_description> whether to show the valid targets or not.
+</parameter_description>
+</parameter>
+<parameter name="context">
+<parameter_description> drag context used to ask the source about the action that wants to
+perform, so hints are more accurate.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gtk_places_sidebar_set_local_only">
 <description>
 Sets whether the @sidebar should only show local files.
@@ -66094,6 +66375,29 @@ Since: 3.14
 <return></return>
 </function>
 
+<function name="gtk_places_sidebar_set_show_recent">
+<description>
+Sets whether the @sidebar should show an item for recent files.
+The default value for this option is determined by the desktop
+environment, but this function can be used to override it on a
+per-application basis.
+
+Since: 3.18
+
+</description>
+<parameters>
+<parameter name="sidebar">
+<parameter_description> a places sidebar
+</parameter_description>
+</parameter>
+<parameter name="show_recent">
+<parameter_description> whether to show an item for recent files
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gtk_plug_construct">
 <description>
 Finish the initialization of @plug for a given #GtkSocket identified by
@@ -103884,8 +104188,8 @@ Since: 3.2
 
 <function name="gtk_widget_class_set_connect_func">
 <description>
-For use in lanuage bindings, this will override the default #GtkBuilderConnectFunc to be
-used when parsing GtkBuilder xml from this class’s template data.
+For use in language bindings, this will override the default #GtkBuilderConnectFunc to be
+used when parsing GtkBuilder XML from this class’s template data.
 
 Note that this must be called from a composite widget classes class
 initializer after calling gtk_widget_class_set_template().
@@ -105540,7 +105844,7 @@ Since: 2.18
 </parameter_description>
 </parameter>
 </parameters>
-<return> %TRUE if @widget acts as the default widget when focussed,
+<return> %TRUE if @widget acts as the default widget when focused,
 %FALSE otherwise
 
 </return>
@@ -105722,7 +106026,7 @@ to a particular #GdkScreen.
 Gets the size request that was explicitly set for the widget using
 gtk_widget_set_size_request(). A value of -1 stored in @width or
 @height indicates that that dimension has not been set explicitly
-and the natural requisition of the widget will be used intead. See
+and the natural requisition of the widget will be used instead. See
 gtk_widget_set_size_request(). To get the size a widget will
 actually request, call gtk_widget_get_preferred_size() instead of
 this function.
@@ -106249,7 +106553,7 @@ Since: 2.2
 </parameter_description>
 </parameter>
 </parameters>
-<return> %TRUE if there is a #GdkScreen associcated
+<return> %TRUE if there is a #GdkScreen associated
 with the widget.
 
 </return>
@@ -106604,7 +106908,7 @@ value should be interpreted in a way similar to the return value of
 gtk_widget_child_focus():
 
 When %TRUE is returned, stay in the widget, the failed keyboard
-navigation is Ok and/or there is nowhere we can/should move the
+navigation is OK and/or there is nowhere we can/should move the
 focus to.
 
 When %FALSE is returned, the caller should continue with keyboard
@@ -107121,7 +107425,7 @@ Since: 3.0
 
 Deprecated: 3.16: This function is not useful in the context of CSS-based
 rendering. If you wish to change the color used to render the primary
-and seconday cursors you should use a custom CSS style, through an
+and secondary cursors you should use a custom CSS style, through an
 application-specific #GtkStyleProvider and a CSS style class.
 
 </description>
@@ -107165,7 +107469,7 @@ you should use a custom CSS style, through an application-specific
 </parameter_description>
 </parameter>
 <parameter name="font_desc">
-<parameter_description> the font descriptiong to use, or %NULL to undo
+<parameter_description> the font description to use, or %NULL to undo
 the effect of previous calls to gtk_widget_override_font()
 </parameter_description>
 </parameter>
@@ -108151,7 +108455,7 @@ the corresponding gtk_widget_pop_composite_child() call.
 
 A composite child is a child that’s an implementation detail of the
 container it’s inside and should not be visible to people using the
-container. Composite children aren’t treated differently by GTK (but
+container. Composite children aren’t treated differently by GTK+ (but
 see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
 builders might want to treat them in a different way.
 
@@ -108438,7 +108742,7 @@ Since: 2.4
 </parameter_description>
 </parameter>
 <parameter name="label">
-<parameter_description> a #GtkWidget that was previously set as a mnemnic label for
+<parameter_description> a #GtkWidget that was previously set as a mnemonic label for
 @widget with gtk_widget_add_mnemonic_label().
 </parameter_description>
 </parameter>
@@ -108592,7 +108896,7 @@ Deprecated:3.0: Use #GtkStyleContext instead, and gtk_widget_reset_style()
 
 <function name="gtk_widget_reset_style">
 <description>
-Updates the style context of @widget and all descendents
+Updates the style context of @widget and all descendants
 by updating its widget path. #GtkContainers may want
 to use this on a child when reordering it in a way that a different
 style might apply to it. See also gtk_container_get_path_for_child().
@@ -108864,7 +109168,7 @@ never should be called by an application.
 <description>
 Sets the widget’s clip.  This must not be used directly,
 but from within a widget’s size_allocate method.
-It must be called after gtk_widget_set_allocation() (or after chaning up
+It must be called after gtk_widget_set_allocation() (or after chaining up
 to the parent class), because that function resets the clip.
 
 The clip set should be the area that @widget draws on. If @widget is a
@@ -109039,11 +109343,16 @@ expose events, since even the clearing to the background color or
 pixmap will not happen automatically (as it is done in
 gdk_window_begin_paint_region()).
 
-Since 3.10 this function only works for widgets with native
-windows.
+In 3.10 GTK and GDK have been restructured for translucent drawing. Since
+then expose events for double-buffered widgets are culled into a single
+event to the toplevel GDK window. If you now unset double buffering, you
+will cause a separate rendering pass for every widget. This will likely
+cause rendering problems - in particular related to stacking - and usually
+increases rendering times significantly.
 
-Deprecated: 3.14: This does not work under non-X11 backends,
-and it should not be used in newly written code.
+Deprecated: 3.14: This function does not work under non-X11 backends or with
+non-native windows.
+It should not be used in newly written code.
 
 </description>
 <parameters>
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]