[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: Mon, 17 Mar 2014 09:48:45 +0000 (UTC)
commit ed1f0761044897830cd26ee64bf9eca3d4bceb2b
Author: Murray Cumming <murrayc murrayc com>
Date: Mon Mar 17 10:48:30 2014 +0100
Regenerate docs XML files.
gdk/src/gdk_docs.xml | 90 +++++++++++++++++++++++++++++---------------------
gtk/src/gtk_docs.xml | 14 +++++++-
2 files changed, 65 insertions(+), 39 deletions(-)
---
diff --git a/gdk/src/gdk_docs.xml b/gdk/src/gdk_docs.xml
index 7efc0d8..fcfcfe5 100644
--- a/gdk/src/gdk_docs.xml
+++ b/gdk/src/gdk_docs.xml
@@ -3342,7 +3342,7 @@ Since: 3.10
</parameter_description>
</parameter>
<parameter name="for_window">
-<parameter_description> The window this will be drawn to, on %NULL.
+<parameter_description> The window this will be drawn to, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -4026,6 +4026,28 @@ Since: 2.20
</return>
</function>
+<function name="gdk_device_get_last_event_window">
+<description>
+Gets information about which window the given pointer device is in, based on
+that have been received so far from the display server. If another application
+has a pointer grab, or this application has a grab with owner_events = %FALSE,
+%NULL may be returned even if the pointer is physically over one of this
+application's windows.
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #GdkDevice, with a source other than %GDK_SOURCE_KEYBOARD
+</parameter_description>
+</parameter>
+</parameters>
+<return> the last window the device
+
+</return>
+</function>
+
<function name="gdk_device_get_mode">
<description>
Determines the mode of the device.
@@ -8829,10 +8851,7 @@ When the destination rectangle contains parts not in the source
image, the data at the edges of the source image is replicated
to infinity.
-<figure id="pixbuf-composite-diagram">
-<title>Compositing of pixbufs</title>
-<graphic fileref="composite.png" format="PNG"/>
-</figure>
+
</description>
<parameters>
@@ -9463,10 +9482,9 @@ Since: 2.2
<parameters>
</parameters>
<return> A list of
-#GdkPixbufFormat<!-- -->s describing the supported
-image formats. The list should be freed when it is no longer needed,
-but the structures themselves are owned by #GdkPixbuf and should not be
-freed.
+#GdkPixbufFormats describing the supported image formats. The list should
+be freed when it is no longer needed, but the structures themselves are
+owned by #GdkPixbuf and should not be freed.
</return>
</function>
@@ -9658,8 +9676,8 @@ Queries a pointer to the pixel data of a pixbuf.
</parameter>
</parameters>
<return> A pointer to the pixbuf's pixel data.
-Please see <xref linkend="image-data"/> for information about how
-the pixel data is stored in memory.
+Please see the section on [image data](image-data) for information
+about how the pixel data is stored in memory.
</return>
</function>
@@ -9681,17 +9699,16 @@ Since: 2.26
</parameter>
</parameters>
<return> A pointer to the pixbuf's
-pixel data. Please see <xref linkend="image-data"/>
-for information about how the pixel data is stored in
-memory.
+pixel data. Please see the section on [image data](image-data)
+for information about how the pixel data is stored in memory.
</return>
</function>
<function name="gdk_pixbuf_get_rowstride">
<description>
-Queries the rowstride of a pixbuf, which is the number of bytes between the start of a row
-and the start of the next row.
+Queries the rowstride of a pixbuf, which is the number of bytes between
+the start of a row and the start of the next row.
</description>
@@ -10254,28 +10271,27 @@ storing as inline data in a program. This is useful if you want to
ship a program with images, but don't want to depend on any
external files.
-gdk-pixbuf ships with a program called <command>gdk-pixbuf-csource</command>
+gdk-pixbuf ships with a program called [gdk-pixbuf-csource][gdk-pixbuf-csource],
which allows for conversion of #GdkPixbufs into such a inline representation.
-In almost all cases, you should pass the <option>--raw</option> flag to
-<command>gdk-pixbuf-csource</command>. A sample invocation would be:
+In almost all cases, you should pass the `--raw` option to
+`gdk-pixbuf-csource`. A sample invocation would be:
-<informalexample><programlisting>
+|[
gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
-</programlisting></informalexample>
+]|
For the typical case where the inline pixbuf is read-only static data,
you don't need to copy the pixel data unless you intend to write to
-it, so you can pass %FALSE for @copy_pixels. (If you pass
-<option>--rle</option> to <command>gdk-pixbuf-csource</command>, a copy
-will be made even if @copy_pixels is %FALSE, so using this option is
-generally a bad idea.)
+it, so you can pass %FALSE for @copy_pixels. (If you pass `--rle` to
+`gdk-pixbuf-csource`, a copy will be made even if @copy_pixels is %FALSE,
+so using this option is generally a bad idea.)
If you create a pixbuf from const inline data compiled into your
program, it's probably safe to ignore errors and disable length checks,
since things will always succeed:
-<informalexample><programlisting>
+|[
pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);
-</programlisting></informalexample>
+]|
For non-const inline data, you could get out of memory. For untrusted
inline data located at runtime, you could have corrupt inline data in
@@ -10739,10 +10755,9 @@ those in the #GDK_PIXBUF_ERROR domain and those in the #G_FILE_ERROR domain.
The variable argument list should be %NULL-terminated; if not empty,
it should contain pairs of strings that modify the save
parameters. For example:
-<informalexample><programlisting>
-gdk_pixbuf_save (pixbuf, handle, "jpeg", &error,
-"quality", "100", NULL);
-</programlisting></informalexample>
+|[
+gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, "quality", "100", NULL);
+]|
Currently only few parameters exist. JPEG images can be saved with a
"quality" parameter; its value should be in the range [0,100].
@@ -10757,16 +10772,14 @@ ICC color profiles can also be embedded into PNG, JPEG and TIFF images.
The "icc-profile" value should be the complete ICC profile encoded
into base64.
-<informalexample><programlisting>
+|[
gchar *contents;
gchar *contents_encode;
gsize length;
g_file_get_contents ("/home/hughsie/.color/icc/L225W.icm", &contents, &length, NULL);
contents_encode = g_base64_encode ((const guchar *) contents, length);
-gdk_pixbuf_save (pixbuf, handle, "png", &error,
-"icc-profile", contents_encode,
-NULL);
-</programlisting></informalexample>
+gdk_pixbuf_save (pixbuf, handle, "png", &error, "icc-profile", contents_encode,
NULL);
+]|
TIFF images recognize a "compression" option which acceps an integer value.
Among the codecs are 1 None, 2 Huffman, 5 LZW, 7 JPEG and 8 Deflate, see
@@ -11483,8 +11496,9 @@ structure.
Generates C source code suitable for compiling images directly
into programs.
-gdk-pixbuf ships with a program called <command>gdk-pixbuf-csource</command>
-which offers a command line interface to this function.
+gdk-pixbuf ships with a program called
+[gdk-pixbuf-csource][gdk-pixbuf-csource], which offers a command
+line interface to this function.
</description>
diff --git a/gtk/src/gtk_docs.xml b/gtk/src/gtk_docs.xml
index 447a005..af99126 100644
--- a/gtk/src/gtk_docs.xml
+++ b/gtk/src/gtk_docs.xml
@@ -41976,7 +41976,7 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="size">
-<parameter_description> the size at which to register the icon (different
+<parameter_description> the size in pixels at which to register the icon (different
images can be registered for the same icon name
at different sizes.)
</parameter_description>
@@ -69157,6 +69157,10 @@ visible child, the transition between the
two will be animated with the current
transition type of @stack.
+Note that the @child widget has to be visible itself
+(see gtk_widget_show()) in order to become the visible
+child of @stack.
+
Since: 3.10
</description>
@@ -69177,6 +69181,10 @@ Since: 3.10
<description>
Makes the child with the given name visible.
+Note that the child widget has to be visible itself
+(see gtk_widget_show()) in order to become the visible
+child of @stack.
+
Since: 3.10
</description>
@@ -69206,6 +69214,10 @@ visible child, the transition between the
two will be animated with the current
transition type of @stack.
+Note that the child widget has to be visible itself
+(see gtk_widget_show()) in order to become the visible
+child of @stack.
+
Since: 3.10
</description>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
