GNOME.org
 

[gtkmm] Regenerate _docs.xml files.

commit 509ce0fb3da24991b7697a03128b24d3a4cdf0ec
Author: Murray Cumming <murrayc murrayc com>
Date:   Mon Mar 16 09:22:14 2015 +0100

    Regenerate _docs.xml files.

 gdk/src/gdk_docs.xml |  227 +++++++++++++++++++++++++++++++++++++++++++++-----
 gtk/src/gtk_docs.xml |   43 ++++++++--
 2 files changed, 242 insertions(+), 28 deletions(-)
---
diff --git a/gdk/src/gdk_docs.xml b/gdk/src/gdk_docs.xml
index 2323fc1..c597fbe 100644
--- a/gdk/src/gdk_docs.xml
+++ b/gdk/src/gdk_docs.xml
@@ -711,6 +711,9 @@ A set of bit-flags to indicate which events a window is to receive.
 Most of these masks map onto one or more of the #GdkEventType event types
 above.
 
+See the [input handling overview][chap-input-handling] for details of
+[event masks][event-masks] and [event propagation][event-propagation].
+
 %GDK_POINTER_MOTION_HINT_MASK is deprecated. It is a special mask
 to reduce the number of %GDK_MOTION_NOTIFY events received. When using
 %GDK_POINTER_MOTION_HINT_MASK, fewer %GDK_MOTION_NOTIFY events will
@@ -1251,22 +1254,24 @@ Since: 3.8
 </parameters>
 </enum>
 
-<enum name="GdkGLProfile">
+<enum name="GdkGLError">
 <description>
-...
+Error enumeration for #GdkGLContext.
+
+Since: 3.16
 
 </description>
 <parameters>
-<parameter name="GDK_GL_PROFILE_DEFAULT">
-<parameter_description> ...
+<parameter name="GDK_GL_ERROR_NOT_AVAILABLE">
+<parameter_description> OpenGL support is not available
 </parameter_description>
 </parameter>
-<parameter name="GDK_GL_PROFILE_LEGACY">
-<parameter_description> ...
+<parameter name="GDK_GL_ERROR_UNSUPPORTED_FORMAT">
+<parameter_description> The requested visual format is not supported
 </parameter_description>
 </parameter>
-<parameter name="GDK_GL_PROFILE_3_2_CORE">
-<parameter_description> ...
+<parameter name="GDK_GL_ERROR_UNSUPPORTED_PROFILE">
+<parameter_description> The requested profile is not supported
 </parameter_description>
 </parameter>
 </parameters>
@@ -7653,6 +7658,24 @@ Since: 3.16
 </return>
 </function>
 
+<function name="gdk_gl_context_get_debug_enabled">
+<description>
+Retrieves the value set using gdk_gl_context_set_debug_enabled().
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GdkGLContext
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if debugging is enabled
+
+</return>
+</function>
+
 <function name="gdk_gl_context_get_display">
 <description>
 Retrieves the #GdkDisplay the @context is created for
@@ -7671,9 +7694,9 @@ Since: 3.16
 </return>
 </function>
 
-<function name="gdk_gl_context_get_profile">
+<function name="gdk_gl_context_get_forward_compatible">
 <description>
-Retrieves the #GdkGLProfile that @context was created for.
+Retrieves the value set using gdk_gl_context_set_forward_compatible().
 
 Since: 3.16
 
@@ -7684,11 +7707,36 @@ Since: 3.16
 </parameter_description>
 </parameter>
 </parameters>
-<return> a #GdkGLProfile
+<return> %TRUE if the context should be forward compatible
 
 </return>
 </function>
 
+<function name="gdk_gl_context_get_required_version">
+<description>
+Retrieves the major and minor version requested by calling
+gdk_gl_context_set_required_version().
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GdkGLContext
+</parameter_description>
+</parameter>
+<parameter name="major">
+<parameter_description> return location for the major version to request
+</parameter_description>
+</parameter>
+<parameter name="minor">
+<parameter_description> return location for the minor version to request
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gdk_gl_context_get_shared_context">
 <description>
 Retrieves the #GdkGLContext that this @context share data with.
@@ -7707,6 +7755,32 @@ Since: 3.16
 </return>
 </function>
 
+<function name="gdk_gl_context_get_version">
+<description>
+Retrieves the OpenGL version of the @context.
+
+The @context must be realized prior to calling this function.
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GdkGLContext
+</parameter_description>
+</parameter>
+<parameter name="major">
+<parameter_description> return location for the major version
+</parameter_description>
+</parameter>
+<parameter name="minor">
+<parameter_description> return location for the minor version
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gdk_gl_context_get_window">
 <description>
 Retrieves the #GdkWindow used by the @context.
@@ -7741,6 +7815,112 @@ Since: 3.16
 <return></return>
 </function>
 
+<function name="gdk_gl_context_realize">
+<description>
+Realizes the given #GdkGLContext.
+
+It is safe to call this function on a realized #GdkGLContext.
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GdkGLContext
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the context is realized
+
+</return>
+</function>
+
+<function name="gdk_gl_context_set_debug_enabled">
+<description>
+Sets whether the #GdkGLContext should perform extra validations and
+run time checking. This is useful during development, but has
+additional overhead.
+
+The #GdkGLContext must not be realized or made current prior to
+calling this function.
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GdkGLContext
+</parameter_description>
+</parameter>
+<parameter name="enabled">
+<parameter_description> whether to enable debugging in the context
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_gl_context_set_forward_compatible">
+<description>
+Sets whether the #GdkGLContext should be forward compatible.
+
+Forward compatibile contexts must not support OpenGL functionality that
+has been marked as deprecated in the requested version; non-forward
+compatible contexts, on the other hand, must support both deprecated and
+non deprecated functionality.
+
+The #GdkGLContext must not be realized or made current prior to calling
+this function.
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GdkGLContext
+</parameter_description>
+</parameter>
+<parameter name="compatible">
+<parameter_description> whether the context should be forward compatible
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_gl_context_set_required_version">
+<description>
+Sets the major and minor version of OpenGL to request.
+
+Setting @major and @minor to zero will use the default values.
+
+The #GdkGLContext must not be realized or made current prior to calling
+this function.
+
+Since: 3.16
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GdkGLContext
+</parameter_description>
+</parameter>
+<parameter name="major">
+<parameter_description> the major version to request
+</parameter_description>
+</parameter>
+<parameter name="minor">
+<parameter_description> the minor version to request
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="gdk_gl_get_flags">
 <description>
 Returns the currently active GL flags.
@@ -14690,7 +14870,7 @@ Since: 2.22
 
 <function name="gdk_wayland_device_get_wl_keyboard">
 <description>
-Returns the Wayland wl_keyboard of a #GdkDevice
+Returns the Wayland wl_keyboard of a #GdkDevice.
 
 Since: 3.10
 
@@ -14708,7 +14888,7 @@ Since: 3.10
 
 <function name="gdk_wayland_device_get_wl_pointer">
 <description>
-Returns the Wayland wl_pointer of a #GdkDevice
+Returns the Wayland wl_pointer of a #GdkDevice.
 
 Since: 3.10
 
@@ -14726,7 +14906,7 @@ Since: 3.10
 
 <function name="gdk_wayland_device_get_wl_seat">
 <description>
-Returns the Wayland wl_seat of a #GdkDevice
+Returns the Wayland wl_seat of a #GdkDevice.
 
 Since: 3.10
 
@@ -14744,7 +14924,7 @@ Since: 3.10
 
 <function name="gdk_wayland_display_get_wl_compositor">
 <description>
-Returns the Wayland global singleton compositor of a #GdkDisplay
+Returns the Wayland global singleton compositor of a #GdkDisplay.
 
 Since: 3.8
 
@@ -14762,7 +14942,7 @@ Since: 3.8
 
 <function name="gdk_wayland_display_get_wl_display">
 <description>
-Returns the Wayland wl_display of a #GdkDisplay
+Returns the Wayland wl_display of a #GdkDisplay.
 
 Since: 3.8
 
@@ -14780,7 +14960,7 @@ Since: 3.8
 
 <function name="gdk_wayland_display_get_xdg_shell">
 <description>
-Returns the Wayland global singleton shell of a #GdkDisplay
+Returns the Wayland global singleton shell of a #GdkDisplay.
 
 Since: 3.8
 
@@ -14845,7 +15025,7 @@ position of a #GdkWindow in &quot;fake root&quot; coordinates.
 
 <function name="gdk_wayland_window_get_wl_surface">
 <description>
-Returns the Wayland surface of a #GdkWindow
+Returns the Wayland surface of a #GdkWindow.
 
 Since: 3.8
 
@@ -15406,6 +15586,9 @@ is disconnected from any particular window or surface.
 
 If the creation of the #GdkGLContext failed, @error will be set.
 
+Before using the returned #GdkGLContext, you will need to
+call gdk_gl_context_make_current() or gdk_gl_context_realize().
+
 Since: 3.16
 
 </description>
@@ -15414,10 +15597,6 @@ Since: 3.16
 <parameter_description> a #GdkWindow
 </parameter_description>
 </parameter>
-<parameter name="profile">
-<parameter_description> the GL profile the context should target
-</parameter_description>
-</parameter>
 <parameter name="error">
 <parameter_description> return location for an error
 </parameter_description>
@@ -17877,6 +18056,8 @@ including #GDK_BUTTON_PRESS_MASK means the window should report button
 press events. The event mask is the bitwise OR of values from the
 #GdkEventMask enumeration.
 
+See the [input handling overview][event-masks] for details.
+
 Since: 3.0
 
 </description>
@@ -17932,6 +18113,8 @@ including #GDK_BUTTON_PRESS_MASK means the window should report button
 press events. The event mask is the bitwise OR of values from the
 #GdkEventMask enumeration.
 
+See the [input handling overview][event-masks] for details.
+
 </description>
 <parameters>
 <parameter name="window">
diff --git a/gtk/src/gtk_docs.xml b/gtk/src/gtk_docs.xml
index 4be9ed3..e295112 100644
--- a/gtk/src/gtk_docs.xml
+++ b/gtk/src/gtk_docs.xml
@@ -3327,7 +3327,7 @@ The ::location-popup-on-paste signal is a
 which gets emitted when the user asks for it.
 
 This is used to make the file chooser show a &quot;Location&quot;
-prompt when the user pastes #GtkFileChooserWidget.
+prompt when the user pastes into a #GtkFileChooserWidget.
 
 The default binding for this signal is `Control + V`.
 
@@ -41282,6 +41282,14 @@ Since: 3.16
 <parameter_description> a #GtkGLArea
 </parameter_description>
 </parameter>
+<parameter name="major">
+<parameter_description> the major version
+</parameter_description>
+</parameter>
+<parameter name="minor">
+<parameter_description> the minor version
+</parameter_description>
+</parameter>
 </parameters>
 <return></return>
 </function>
@@ -49975,7 +49983,7 @@ Since: 3.16
 <parameter_description> a #GtkLabel
 </parameter_description>
 </parameter>
-<parameter name="xalign">
+<parameter name="yalign">
 <parameter_description> the new yalign value, between 0 and 1
 </parameter_description>
 </parameter>
@@ -74498,6 +74506,15 @@ Since: 3.0
 <description>
 Gets the background color for a given state.
 
+This function is far less useful than it seems, and it should not be used in
+newly written code. CSS has no concept of &quot;background color&quot;, as a background
+can be an image, or a gradient, or any other pattern including solid colors.
+
+The only reason why you would call gtk_style_context_get_background_color() is
+to use the returned value to draw the background with it; the correct way to
+achieve this result is to use gtk_render_background() instead, along with CSS
+style classes to modify the color to be rendered.
+
 Since: 3.0
 
 Deprecated: 3.16: Use gtk_render_background() instead.
@@ -99939,7 +99956,12 @@ See gtk_widget_override_color().
 
 Since: 3.0
 
-Deprecated:3.16: Use a custom style provider and style classes instead
+Deprecated: 3.16: This function is not useful in the context of CSS-based
+rendering. If you wish to change the way a widget renders its background
+you should use a custom CSS style, through an application-specific
+#GtkStyleProvider and a CSS style class. You can also override the default
+drawing of a widget through the #GtkWidget::draw signal, and use Cairo to
+draw a specific color, regardless of the CSS style.
 
 </description>
 <parameters>
@@ -100024,7 +100046,10 @@ so the alpha value in @primary and @secondary will be ignored.
 
 Since: 3.0
 
-Deprecated:3.16: Use a custom style provider and style classes instead
+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
+application-specific #GtkStyleProvider and a CSS style class.
 
 </description>
 <parameters>
@@ -100055,7 +100080,10 @@ left untouched. See gtk_widget_override_color().
 
 Since: 3.0
 
-Deprecated:3.16: Use a custom style provider and style classes instead
+Deprecated: 3.16: This function is not useful in the context of CSS-based
+rendering. If you wish to change the font a widget uses to render its text
+you should use a custom CSS style, through an application-specific
+#GtkStyleProvider and a CSS style class.
 
 </description>
 <parameters>
@@ -100082,7 +100110,10 @@ or background color.
 
 Since: 3.0
 
-Deprecated:3.16: Use a custom style provider and style classes instead
+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 symbolic icons
+you should use a custom CSS style, through an application-specific
+#GtkStyleProvider and a CSS style class.
 
 </description>
 <parameters>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]