[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: Wed, 21 Jan 2015 09:09:59 +0000 (UTC)
commit d074a287f23a6fa5ad4b438a969c8f4652d61cb2
Author: Murray Cumming <murrayc murrayc com>
Date: Tue Jan 20 13:08:16 2015 +0100
Regenerate _docs.xml files.
gdk/src/gdk_docs.xml | 101 ++++++++++++++++++++++++-
gtk/src/gtk_docs.xml | 202 ++++++++++++++++++++++++++++++++------------------
2 files changed, 225 insertions(+), 78 deletions(-)
---
diff --git a/gdk/src/gdk_docs.xml b/gdk/src/gdk_docs.xml
index 1613fc9..2323fc1 100644
--- a/gdk/src/gdk_docs.xml
+++ b/gdk/src/gdk_docs.xml
@@ -4320,6 +4320,26 @@ the @device is on, or %NULL.
<return></return>
</function>
+<function name="gdk_device_get_product_id">
+<description>
+Returns the product ID of this device, or %NULL if this information couldn't
+be obtained. This ID is retrieved from the device, and is thus constant for
+it. See gdk_device_get_vendor_id() for more information.
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a slave #GdkDevice
+</parameter_description>
+</parameter>
+</parameters>
+<return> the product ID, or %NULL
+
+</return>
+</function>
+
<function name="gdk_device_get_source">
<description>
Determines the type of the device.
@@ -4368,6 +4388,49 @@ the axes of @device in, or %NULL.
<return></return>
</function>
+<function name="gdk_device_get_vendor_id">
+<description>
+Returns the vendor ID of this device, or %NULL if this information couldn't
+be obtained. This ID is retrieved from the device, and is thus constant for
+it.
+
+This function, together with gdk_device_get_product_id(), can be used to eg.
+compose #GSettings paths to store settings for this device.
+
+|[<!-- language="C" -->
+static GSettings *
+get_device_settings (GdkDevice *device)
+{
+const gchar *vendor, *product;
+GSettings *settings;
+GdkDevice *device;
+gchar *path;
+
+vendor = gdk_device_get_vendor_id (device);
+product = gdk_device_get_product_id (device);
+
+path = g_strdup_printf ("/org/example/app/devices/%s:%s/", vendor, product);
+settings = g_settings_new_with_path (DEVICE_SCHEMA, path);
+g_free (path);
+
+return settings;
+}
+]|
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a slave #GdkDevice
+</parameter_description>
+</parameter>
+</parameters>
+<return> the vendor ID, or %NULL
+
+</return>
+</function>
+
<function name="gdk_device_get_window_at_position">
<description>
Obtains the window underneath @device, returning the location of the device in @win_x and @win_y. Returns
@@ -14850,6 +14913,32 @@ Since: 3.10
<return></return>
</function>
+<function name="gdk_win32_display_get_wgl_version">
+<description>
+Retrieves the version of the WGL implementation.
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</parameter_description>
+</parameter>
+<parameter name="major">
+<parameter_description> return location for the WGL major version
+</parameter_description>
+</parameter>
+<parameter name="minor">
+<parameter_description> return location for the WGL minor version
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if WGL is available
+
+</return>
+</function>
+
<function name="gdk_window_add_filter">
<description>
Adds an event filter to @window, allowing you to intercept events
@@ -16398,7 +16487,7 @@ The position coordinates are relative to the window’s parent window.
<description>
Obtains the position of a window position in root
window coordinates. This is similar to
-gdk_window_get_origin() but allows you go pass
+gdk_window_get_origin() but allows you to pass
in any position in the window, not just the origin.
Since: 2.18
@@ -17511,10 +17600,12 @@ Since: 2.4
<function name="gdk_window_set_background">
<description>
-Sets the background color of @window. (However, when using GTK+,
-set the background of a widget with gtk_widget_modify_bg() - if
-you’re an application - or gtk_style_set_background() - if you're
-implementing a custom widget.)
+Sets the background color of @window.
+
+However, when using GTK+, influence the background of a widget
+using a style class or CSS — if you’re an application — or with
+gtk_style_context_set_background() — if you're implementing a
+custom widget.
See also gdk_window_set_background_pattern().
diff --git a/gtk/src/gtk_docs.xml b/gtk/src/gtk_docs.xml
index 2206df0..33e2cce 100644
--- a/gtk/src/gtk_docs.xml
+++ b/gtk/src/gtk_docs.xml
@@ -7801,9 +7801,9 @@ has been registered
<signal name="GtkRecentManager::changed">
<description>
-Emitted when the current recently used resources manager changes its
-contents, either by calling gtk_recent_manager_add_item() or by another
-application.
+Emitted when the current recently used resources manager changes
+its contents, either by calling gtk_recent_manager_add_item() or
+by another application.
Since: 2.10
@@ -9760,6 +9760,28 @@ Reading directions for text.
</parameters>
</enum>
+<enum name="GtkTextExtendSelection">
+<description>
+Granularity types that extend the text selection. Use the
+#GtkTextView::extend-selection signal to customize the selection.
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="GTK_TEXT_EXTEND_SELECTION_WORD">
+<parameter_description> Selects the current word. It is triggered by
+a double-click for example.
+</parameter_description>
+</parameter>
+<parameter name="GTK_TEXT_EXTEND_SELECTION_LINE">
+<parameter_description> Selects the current line. It is triggered by
+a triple-click for example.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
<enum name="GtkTextSearchFlags">
<description>
Flags affecting how a search is done.
@@ -9963,6 +9985,41 @@ backwords.
<return></return>
</signal>
+<signal name="GtkTextView::extend-selection">
+<description>
+The ::extend-selection signal is emitted when the selection needs to be
+extended at @location.
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="text_view">
+<parameter_description> the object which received the signal
+</parameter_description>
+</parameter>
+<parameter name="granularity">
+<parameter_description> the granularity type
+</parameter_description>
+</parameter>
+<parameter name="location">
+<parameter_description> the location where to extend the selection
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> where the selection should start
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> where the selection should end
+</parameter_description>
+</parameter>
+</parameters>
+<return> %GDK_EVENT_STOP to stop other handlers from being invoked for the
+event. %GDK_EVENT_PROPAGATE to propagate the event further.
+</return>
+</signal>
+
<signal name="GtkTextView::insert-at-cursor">
<description>
The ::insert-at-cursor signal is a
@@ -67049,8 +67106,9 @@ In case of error, @error will be set either with a
<function name="gtk_recent_info_exists">
<description>
-Checks whether the resource pointed by @info still exists. At
-the moment this check is done only on resources pointing to local files.
+Checks whether the resource pointed by @info still exists.
+At the moment this check is done only on resources pointing
+to local files.
Since: 2.10
@@ -67088,8 +67146,8 @@ the resource was added to the list, or -1 on failure.
<function name="gtk_recent_info_get_age">
<description>
-Gets the number of days elapsed since the last update of the resource
-pointed by @info.
+Gets the number of days elapsed since the last update
+of the resource pointed by @info.
Since: 2.10
@@ -67100,8 +67158,8 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> a positive integer containing the number of days elapsed
-since the time this resource was last modified.
+<return> a positive integer containing the number of days
+elapsed since the time this resource was last modified
</return>
</function>
@@ -67127,7 +67185,8 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="app_exec">
-<parameter_description> return location for the string containing the command line
+<parameter_description> return location for the string containing
+the command line
</parameter_description>
</parameter>
<parameter name="count">
@@ -67185,7 +67244,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> the description of the resource. The returned string
+<return> the description of the resource. The returned string
is owned by the recent manager, and should not be freed.
</return>
@@ -67193,7 +67252,7 @@ is owned by the recent manager, and should not be freed.
<function name="gtk_recent_info_get_display_name">
<description>
-Gets the name of the resource. If none has been defined, the basename
+Gets the name of the resource. If none has been defined, the basename
of the resource is obtained.
Since: 2.10
@@ -67205,7 +67264,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> the display name of the resource. The returned string
+<return> the display name of the resource. The returned string
is owned by the recent manager, and should not be freed.
</return>
@@ -67224,17 +67283,17 @@ Since: 2.22
</parameter_description>
</parameter>
</parameters>
-<return> a #GIcon containing the icon, or %NULL. Use
-g_object_unref() when finished using the icon
+<return> a #GIcon containing the icon, or %NULL.
+Use g_object_unref() when finished using the icon
</return>
</function>
<function name="gtk_recent_info_get_groups">
<description>
-Returns all groups registered for the recently used item @info. The
-array of returned group names will be %NULL terminated, so length might
-optionally be %NULL.
+Returns all groups registered for the recently used item @info.
+The array of returned group names will be %NULL terminated, so
+length might optionally be %NULL.
Since: 2.10
@@ -67292,7 +67351,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> the MIME type of the resource. The returned string
+<return> the MIME type of the resource. The returned string
is owned by the recent manager, and should not be freed.
</return>
@@ -67320,7 +67379,7 @@ the resource was last modified, or -1 on failure.
<function name="gtk_recent_info_get_private_hint">
<description>
-Gets the value of the “private” flag. Resources in the recently used
+Gets the value of the “private” flag. Resources in the recently used
list that have this flag set to %TRUE should only be displayed by the
applications that have registered them.
@@ -67333,15 +67392,16 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the private flag was found, %FALSE otherwise.
+<return> %TRUE if the private flag was found, %FALSE otherwise
</return>
</function>
<function name="gtk_recent_info_get_short_name">
<description>
-Computes a valid UTF-8 string that can be used as the name of the item in a
-menu or list. For example, calling this function on an item that refers to
+Computes a valid UTF-8 string that can be used as the
+name of the item in a menu or list. For example, calling
+this function on an item that refers to
“file:///foo/bar.txt” will yield “bar.txt”.
Since: 2.10
@@ -67353,8 +67413,8 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> A newly-allocated string in UTF-8 encoding; free it with
-g_free().
+<return> A newly-allocated string in UTF-8 encoding
+free it with g_free()
</return>
</function>
@@ -67372,7 +67432,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> the URI of the resource. The returned string is
+<return> the URI of the resource. The returned string is
owned by the recent manager, and should not be freed.
</return>
@@ -67380,7 +67440,7 @@ owned by the recent manager, and should not be freed.
<function name="gtk_recent_info_get_uri_display">
<description>
-Gets a displayable version of the resource’s URI. If the resource
+Gets a displayable version of the resource’s URI. If the resource
is local, it returns a local path; if the resource is not local,
it returns the UTF-8 encoded content of gtk_recent_info_get_uri().
@@ -67437,15 +67497,15 @@ Since: 2.10
</parameter>
</parameters>
<return> %TRUE if an application with name @app_name was found,
-%FALSE otherwise.
+%FALSE otherwise
</return>
</function>
<function name="gtk_recent_info_has_group">
<description>
-Checks whether @group_name appears inside the groups registered for the
-recently used item @info.
+Checks whether @group_name appears inside the groups
+registered for the recently used item @info.
Since: 2.10
@@ -67460,7 +67520,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the group was found.
+<return> %TRUE if the group was found
</return>
</function>
@@ -67479,7 +67539,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the resource is local.
+<return> %TRUE if the resource is local
</return>
</function>
@@ -67498,7 +67558,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> an application name. Use g_free() to free it.
+<return> an application name. Use g_free() to free it.
</return>
</function>
@@ -67521,8 +67581,8 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if both #GtkRecentInfo-struct point to se same
-resource, %FALSE otherwise.
+<return> %TRUE if both #GtkRecentInfo-struct point to the same
+resource, %FALSE otherwise
</return>
</function>
@@ -67540,15 +67600,15 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> the recent info object with its reference count increased
-by one.
+<return> the recent info object with its reference count
+increased by one
</return>
</function>
<function name="gtk_recent_info_unref">
<description>
-Decreases the reference count of @info by one. If the reference
+Decreases the reference count of @info by one. If the reference
count reaches zero, @info is deallocated, and the memory freed.
Since: 2.10
@@ -67566,8 +67626,8 @@ Since: 2.10
<function name="gtk_recent_manager_add_full">
<description>
Adds a new resource, pointed by @uri, into the recently used
-resources list, using the metadata specified inside the #GtkRecentData-struct
-passed in @recent_data.
+resources list, using the metadata specified inside the
+#GtkRecentData-struct passed in @recent_data.
The passed URI will be used to identify this resource inside the
list.
@@ -67580,9 +67640,9 @@ that is registering the item, and a command line to be used when
launching the item.
Optionally, a #GtkRecentData-struct might contain a UTF-8 string
-to be used when viewing the item instead of the last component of the
-URI; a short description of the item; whether the item should be
-considered private - that is, should be displayed only by the
+to be used when viewing the item instead of the last component of
+the URI; a short description of the item; whether the item should
+be considered private - that is, should be displayed only by the
applications that have registered it.
Since: 2.10
@@ -67603,7 +67663,7 @@ Since: 2.10
</parameter>
</parameters>
<return> %TRUE if the new item was successfully added to the
-recently used resources list, %FALSE otherwise.
+recently used resources list, %FALSE otherwise
</return>
</function>
@@ -67614,8 +67674,8 @@ Adds a new resource, pointed by @uri, into the recently used
resources list.
This function automatically retrieves some of the needed
-metadata and setting other metadata to common default values; it
-then feeds the data to gtk_recent_manager_add_full().
+metadata and setting other metadata to common default values;
+it then feeds the data to gtk_recent_manager_add_full().
See gtk_recent_manager_add_full() if you want to explicitly
define the metadata for the resource pointed by @uri.
@@ -67649,7 +67709,8 @@ Since: 2.10
</description>
<parameters>
</parameters>
-<return> A unique #GtkRecentManager. Do not ref or unref it.
+<return> A unique #GtkRecentManager. Do not ref or
+unref it.
</return>
</function>
@@ -67693,7 +67754,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the resource was found, %FALSE otherwise.
+<return> %TRUE if the resource was found, %FALSE otherwise
</return>
</function>
@@ -67723,7 +67784,7 @@ Since: 2.10
</parameters>
<return> a #GtkRecentInfo-struct containing information
about the resource pointed by @uri, or %NULL if the URI was
-not registered in the recently used resources list. Free with
+not registered in the recently used resources list. Free with
gtk_recent_info_unref().
</return>
@@ -67749,8 +67810,8 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="new_uri">
-<parameter_description> the new URI of the recently used resource, or %NULL to
-remove the item pointed by @uri in the list
+<parameter_description> the new URI of the recently used resource, or
+%NULL to remove the item pointed by @uri in the list
</parameter_description>
</parameter>
<parameter name="error">
@@ -67758,15 +67819,15 @@ remove the item pointed by @uri in the list
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success.
+<return> %TRUE on success
</return>
</function>
<function name="gtk_recent_manager_new">
<description>
-Creates a new recent manager object. Recent manager objects are used to
-handle the list of recently used resources. A #GtkRecentManager object
+Creates a new recent manager object. Recent manager objects are used to
+handle the list of recently used resources. A #GtkRecentManager object
monitors the recently used resources list, and emits the “changed” signal
each time something inside the list changes.
@@ -67778,7 +67839,7 @@ Since: 2.10
</description>
<parameters>
</parameters>
-<return> A newly created #GtkRecentManager object.
+<return> A newly created #GtkRecentManager object
</return>
</function>
@@ -67801,7 +67862,7 @@ Since: 2.10
</parameter>
</parameters>
<return> the number of items that have been removed from the
-recently used resources list.
+recently used resources list
</return>
</function>
@@ -67829,7 +67890,7 @@ Since: 2.10
</parameter>
</parameters>
<return> %TRUE if the item pointed by @uri has been successfully
-removed by the recently used resources list, and %FALSE otherwise.
+removed by the recently used resources list, and %FALSE otherwise
</return>
</function>
@@ -75050,11 +75111,13 @@ Since: 3.0
<function name="gtk_style_context_save">
<description>
-Saves the @context state, so all modifications done through
+Saves the @context state, so temporary modifications done through
gtk_style_context_add_class(), gtk_style_context_remove_class(),
-gtk_style_context_add_region(), gtk_style_context_remove_region()
-or gtk_style_context_set_junction_sides() can be reverted in one
-go through gtk_style_context_restore().
+gtk_style_context_set_state(), etc. can quickly be reverted
+in one go through gtk_style_context_restore().
+
+The matching call to gtk_style_context_restore() must be done
+before GTK returns to the main loop.
Since: 3.0
@@ -101401,23 +101464,16 @@ never should be called by an application.
<function name="gtk_widget_set_clip">
<description>
-Sets the widget’s clip. This must not be used
-directly, but from within a widget’s size_allocate method.
+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
+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
#GtkContainer, the area must contain all children's clips.
If this function is not called by @widget during a ::size-allocate handler,
-it is assumed to be equal to the allocation. However, if the function is
-not called, certain features that might extend a widget's allocation will
-not be available:
-
-* The #GtkWidget::draw signal will be clipped to the widget's allocation
-to avoid overdraw.
-* Calling gtk_render_background() will not draw outset shadows.
-
-It is therefore suggested that you always call gtk_widget_set_clip() during
-a ::size-allocate handler.
+the clip will be set to @widget's allocation.
Since: 3.14
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
