RubyGems - gio2 - Versions diffs - 0.90.3-x86-mingw32 - Mend

gio2 0.90.3-x86-mingw32

Files changed (856) hide show

data/vendor/local/share/gtk-doc/html/gobject/gobject-Value-arrays.html ADDED

@@ -0,0 +1,416 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Value arrays</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="GObject Reference Manual">
+<link rel="up" href="rn01.html" title="API Reference">
+<link rel="prev" href="gobject-Closures.html" title="Closures">
+<link rel="next" href="GBinding.html" title="GBinding">
+<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+<tr valign="middle">
+<td><a accesskey="p" href="gobject-Closures.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">GObject Reference Manual</th>
+<td><a accesskey="n" href="GBinding.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#gobject-Value-arrays.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#gobject-Value-arrays.description" class="shortcut">Description</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="gobject-Value-arrays"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="gobject-Value-arrays.top_of_page"></a>Value arrays</span></h2>
+<p>Value arrays — A container structure to maintain an array of
+    generic values</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="gobject-Value-arrays.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">
+#include &lt;glib-object.h&gt;
+                    <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray">GValueArray</a>;
+<a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="returnvalue">GValue</span></a> *		          <a class="link" href="gobject-Value-arrays.html#g-value-array-get-nth" title="g_value_array_get_nth ()">g_value_array_get_nth</a>               (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> index_</code></em>);
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      <a class="link" href="gobject-Value-arrays.html#g-value-array-new" title="g_value_array_new ()">g_value_array_new</a>                   (<em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_prealloced</code></em>);
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      <a class="link" href="gobject-Value-arrays.html#g-value-array-copy" title="g_value_array_copy ()">g_value_array_copy</a>                  (<em class="parameter"><code>const <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="gobject-Value-arrays.html#g-value-array-free" title="g_value_array_free ()">g_value_array_free</a>                  (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>);
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      <a class="link" href="gobject-Value-arrays.html#g-value-array-append" title="g_value_array_append ()">g_value_array_append</a>                (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code>const <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> *value</code></em>);
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      <a class="link" href="gobject-Value-arrays.html#g-value-array-prepend" title="g_value_array_prepend ()">g_value_array_prepend</a>               (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code>const <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> *value</code></em>);
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      <a class="link" href="gobject-Value-arrays.html#g-value-array-insert" title="g_value_array_insert ()">g_value_array_insert</a>                (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> index_</code></em>,
+                                                         <em class="parameter"><code>const <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> *value</code></em>);
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      <a class="link" href="gobject-Value-arrays.html#g-value-array-remove" title="g_value_array_remove ()">g_value_array_remove</a>                (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> index_</code></em>);
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      <a class="link" href="gobject-Value-arrays.html#g-value-array-sort" title="g_value_array_sort ()">g_value_array_sort</a>                  (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GCompareFunc"><span class="type">GCompareFunc</span></a> compare_func</code></em>);
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      <a class="link" href="gobject-Value-arrays.html#g-value-array-sort-with-data" title="g_value_array_sort_with_data ()">g_value_array_sort_with_data</a>        (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GCompareDataFunc"><span class="type">GCompareDataFunc</span></a> compare_func</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="gobject-Value-arrays.description"></a><h2>Description</h2>
+<p>
+The prime purpose of a <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> is for it to be used as an
+object property that holds an array of values. A <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> wraps
+an array of <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> elements in order for it to be used as a boxed
+type through <a class="link" href="gobject-Generic-values.html#G-TYPE-VALUE-ARRAY:CAPS" title="G_TYPE_VALUE_ARRAY"><code class="literal">G_TYPE_VALUE_ARRAY</code></a>.
+</p>
+</div>
+<div class="refsect1">
+<a name="gobject-Value-arrays.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="GValueArray"></a><h3>GValueArray</h3>
+<pre class="programlisting">typedef struct {
+  guint   n_values;
+  GValue *values;
+} GValueArray;
+</pre>
+<p>
+A <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> contains an array of <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> elements.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GValueArray.n-values"></a>n_values</code></em>;</span></p></td>
+<td>number of values contained in the array
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> *<em class="structfield"><code><a name="GValueArray.values"></a>values</code></em>;</span></p></td>
+<td>array of values
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-get-nth"></a><h3>g_value_array_get_nth ()</h3>
+<pre class="programlisting"><a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="returnvalue">GValue</span></a> *		          g_value_array_get_nth               (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> index_</code></em>);</pre>
+<p>
+Return a pointer to the value at <em class="parameter"><code>index_</code></em> containd in <em class="parameter"><code>value_array</code></em>.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> to get a value from
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
+<td>index of the value of interest
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> pointer to a value at <em class="parameter"><code>index_</code></em> in <em class="parameter"><code>value_array</code></em>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-new"></a><h3>g_value_array_new ()</h3>
+<pre class="programlisting"><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      g_value_array_new                   (<em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_prealloced</code></em>);</pre>
+<p>
+Allocate and initialize a new <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a>, optionally preserve space
+for <em class="parameter"><code>n_prealloced</code></em> elements. New arrays always contain 0 elements,
+regardless of the value of <em class="parameter"><code>n_prealloced</code></em>.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>n_prealloced</code></em> :</span></p></td>
+<td>number of values to preallocate space for
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> a newly allocated <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> with 0 values
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-copy"></a><h3>g_value_array_copy ()</h3>
+<pre class="programlisting"><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      g_value_array_copy                  (<em class="parameter"><code>const <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>);</pre>
+<p>
+Construct an exact copy of a <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> by duplicating all its
+contents.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> to copy
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> Newly allocated copy of <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-free"></a><h3>g_value_array_free ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                g_value_array_free                  (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>);</pre>
+<p>
+Free a <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> including its contents.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody><tr>
+<td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> to free
+</td>
+</tr></tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-append"></a><h3>g_value_array_append ()</h3>
+<pre class="programlisting"><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      g_value_array_append                (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code>const <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
+<p>
+Insert a copy of <em class="parameter"><code>value</code></em> as last element of <em class="parameter"><code>value_array</code></em>. If <em class="parameter"><code>value</code></em> is
+<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, an uninitialized value is appended.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> to add an element to
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> to copy into <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> passed in as <em class="parameter"><code>value_array</code></em>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-prepend"></a><h3>g_value_array_prepend ()</h3>
+<pre class="programlisting"><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      g_value_array_prepend               (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code>const <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
+<p>
+Insert a copy of <em class="parameter"><code>value</code></em> as first element of <em class="parameter"><code>value_array</code></em>. If <em class="parameter"><code>value</code></em> is
+<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, an uninitialized value is prepended.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> to add an element to
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> to copy into <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> passed in as <em class="parameter"><code>value_array</code></em>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-insert"></a><h3>g_value_array_insert ()</h3>
+<pre class="programlisting"><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      g_value_array_insert                (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> index_</code></em>,
+                                                         <em class="parameter"><code>const <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
+<p>
+Insert a copy of <em class="parameter"><code>value</code></em> at specified position into <em class="parameter"><code>value_array</code></em>. If <em class="parameter"><code>value</code></em>
+is <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, an uninitialized value is inserted.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> to add an element to
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
+<td>insertion position, must be &lt;= value_array-&gt;n_values
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> to copy into <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> passed in as <em class="parameter"><code>value_array</code></em>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-remove"></a><h3>g_value_array_remove ()</h3>
+<pre class="programlisting"><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      g_value_array_remove                (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> index_</code></em>);</pre>
+<p>
+Remove the value at position <em class="parameter"><code>index_</code></em> from <em class="parameter"><code>value_array</code></em>.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> to remove an element from
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
+<td>position of value to remove, must be &lt; value_array-&gt;n_values
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> passed in as <em class="parameter"><code>value_array</code></em>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-sort"></a><h3>g_value_array_sort ()</h3>
+<pre class="programlisting"><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      g_value_array_sort                  (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GCompareFunc"><span class="type">GCompareFunc</span></a> compare_func</code></em>);</pre>
+<p>
+Sort <em class="parameter"><code>value_array</code></em> using <em class="parameter"><code>compare_func</code></em> to compare the elements accoring to
+the semantics of <a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GCompareFunc"><span class="type">GCompareFunc</span></a>.
+</p>
+<p>
+The current implementation uses Quick-Sort as sorting algorithm.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> to sort
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>compare_func</code></em> :</span></p></td>
+<td>function to compare elements
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> passed in as <em class="parameter"><code>value_array</code></em>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-value-array-sort-with-data"></a><h3>g_value_array_sort_with_data ()</h3>
+<pre class="programlisting"><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="returnvalue">GValueArray</span></a> *	      g_value_array_sort_with_data        (<em class="parameter"><code><a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> *value_array</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GCompareDataFunc"><span class="type">GCompareDataFunc</span></a> compare_func</code></em>,
+                                                         <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
+<p>
+Sort <em class="parameter"><code>value_array</code></em> using <em class="parameter"><code>compare_func</code></em> to compare the elements accoring
+to the semantics of <a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GCompareDataFunc"><span class="type">GCompareDataFunc</span></a>.
+</p>
+<p>
+The current implementation uses Quick-Sort as sorting algorithm.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
+<td>
+<a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> to sort
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>compare_func</code></em> :</span></p></td>
+<td>function to compare elements
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
+<td>extra data argument provided for <em class="parameter"><code>compare_func</code></em>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the <a class="link" href="gobject-Value-arrays.html#GValueArray" title="GValueArray"><span class="type">GValueArray</span></a> passed in as <em class="parameter"><code>value_array</code></em>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<div class="refsect1">
+<a name="gobject-Value-arrays.see-also"></a><h2>See Also</h2>
+<a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a>, <a class="link" href="gobject-Standard-Parameter-and-Value-Types.html#GParamSpecValueArray" title="GParamSpecValueArray"><span class="type">GParamSpecValueArray</span></a>, <a class="link" href="gobject-Standard-Parameter-and-Value-Types.html#g-param-spec-value-array" title="g_param_spec_value_array ()"><code class="function">g_param_spec_value_array()</code></a>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.15.1</div>
+</body>
+</html>

data/vendor/local/share/gtk-doc/html/gobject/gobject-Varargs-Value-Collection.html ADDED

@@ -0,0 +1,260 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Varargs Value Collection</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="GObject Reference Manual">
+<link rel="up" href="rn01.html" title="API Reference">
+<link rel="prev" href="gobject-GParamSpec.html" title="GParamSpec">
+<link rel="next" href="gobject-Signals.html" title="Signals">
+<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+<tr valign="middle">
+<td><a accesskey="p" href="gobject-GParamSpec.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">GObject Reference Manual</th>
+<td><a accesskey="n" href="gobject-Signals.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#gobject-Varargs-Value-Collection.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#gobject-Varargs-Value-Collection.description" class="shortcut">Description</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="gobject-Varargs-Value-Collection"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="gobject-Varargs-Value-Collection.top_of_page"></a>Varargs Value Collection</span></h2>
+<p>Varargs Value Collection — Converting varargs to generic values</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="gobject-Varargs-Value-Collection.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">
+#include &lt;glib-object.h&gt;
+#include &lt;gobject/gvaluecollector.h&gt;
+union               <a class="link" href="gobject-Varargs-Value-Collection.html#GTypeCValue" title="union GTypeCValue">GTypeCValue</a>;
+#define             <a class="link" href="gobject-Varargs-Value-Collection.html#G-VALUE-COLLECT-INIT:CAPS" title="G_VALUE_COLLECT_INIT()">G_VALUE_COLLECT_INIT</a>                (value,
+                                                         _value_type,
+                                                         var_args,
+                                                         flags,
+                                                         __error)
+#define             <a class="link" href="gobject-Varargs-Value-Collection.html#G-VALUE-COLLECT:CAPS" title="G_VALUE_COLLECT()">G_VALUE_COLLECT</a>                     (value,
+                                                         var_args,
+                                                         flags,
+                                                         __error)
+#define             <a class="link" href="gobject-Varargs-Value-Collection.html#G-VALUE-LCOPY:CAPS" title="G_VALUE_LCOPY()">G_VALUE_LCOPY</a>                       (value,
+                                                         var_args,
+                                                         flags,
+                                                         __error)
+#define             <a class="link" href="gobject-Varargs-Value-Collection.html#G-VALUE-COLLECT-FORMAT-MAX-LENGTH:CAPS" title="G_VALUE_COLLECT_FORMAT_MAX_LENGTH">G_VALUE_COLLECT_FORMAT_MAX_LENGTH</a>
+</pre>
+</div>
+<div class="refsect1">
+<a name="gobject-Varargs-Value-Collection.description"></a><h2>Description</h2>
+<p>
+The macros in this section provide the varargs parsing support needed
+in variadic GObject functions such as <a class="link" href="gobject-The-Base-Object-Type.html#g-object-new" title="g_object_new ()"><code class="function">g_object_new()</code></a> or <a class="link" href="gobject-The-Base-Object-Type.html#g-object-set" title="g_object_set ()"><code class="function">g_object_set()</code></a>.
+They currently support the collection of integral types, floating point
+types and pointers.
+</p>
+</div>
+<div class="refsect1">
+<a name="gobject-Varargs-Value-Collection.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="GTypeCValue"></a><h3>union GTypeCValue</h3>
+<pre class="programlisting">union _GTypeCValue
+{
+  gint     v_int;
+  glong    v_long;
+  gint64   v_int64;
+  gdouble  v_double;
+  gpointer v_pointer;
+};
+</pre>
+<p>
+A union holding one collected value.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><a href="./../glib/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GTypeCValue.v-int"></a>v_int</code></em>;</span></p></td>
+<td>the field for holding integer values
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><a href="./../glib/glib/glib-Basic-Types.html#glong"><span class="type">glong</span></a> <em class="structfield"><code><a name="GTypeCValue.v-long"></a>v_long</code></em>;</span></p></td>
+<td>the field for holding long integer values
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><a href="./../glib/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> <em class="structfield"><code><a name="GTypeCValue.v-int64"></a>v_int64</code></em>;</span></p></td>
+<td>the field for holding 64 bit integer values
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><a href="./../glib/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> <em class="structfield"><code><a name="GTypeCValue.v-double"></a>v_double</code></em>;</span></p></td>
+<td>the field for holding floating point values
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GTypeCValue.v-pointer"></a>v_pointer</code></em>;</span></p></td>
+<td>the field for holding pointers
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="G-VALUE-COLLECT-INIT:CAPS"></a><h3>G_VALUE_COLLECT_INIT()</h3>
+<pre class="programlisting">#define             G_VALUE_COLLECT_INIT(value, _value_type, var_args, flags, __error)</pre>
+<p>
+Collects a variable argument value from a va_list. We have to
+implement the varargs collection as a macro, because on some systems
+va_list variables cannot be passed by reference.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
+<td>a <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> return location. <em class="parameter"><code>value</code></em> must contain only 0 bytes.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>_value_type</code></em> :</span></p></td>
+<td>the <a class="link" href="gobject-Type-Information.html#GType" title="GType"><span class="type">GType</span></a> to use for <em class="parameter"><code>value</code></em>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>var_args</code></em> :</span></p></td>
+<td>the va_list variable; it may be evaluated multiple times
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
+<td>flags which are passed on to the <code class="function">collect_value()</code> function of
+ the <a class="link" href="gobject-Type-Information.html#GTypeValueTable" title="GTypeValueTable"><span class="type">GTypeValueTable</span></a> of <em class="parameter"><code>value</code></em>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>__error</code></em> :</span></p></td>
+<td>a <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>** variable that will be modified to hold a <a href="./../glib/glib/glib-Memory-Allocation.html#g-new"><code class="function">g_new()</code></a>
+ allocated error messages if something fails
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.24</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="G-VALUE-COLLECT:CAPS"></a><h3>G_VALUE_COLLECT()</h3>
+<pre class="programlisting">#define             G_VALUE_COLLECT(value, var_args, flags, __error)</pre>
+<p>
+Collects a variable argument value from a va_list. We have to
+implement the varargs collection as a macro, because on some systems
+va_list variables cannot be passed by reference.
+</p>
+<p>
+Note: If you are creating the <em class="parameter"><code>value</code></em> argument just before calling this macro,
+you should use the <a class="link" href="gobject-Varargs-Value-Collection.html#G-VALUE-COLLECT-INIT:CAPS" title="G_VALUE_COLLECT_INIT()"><span class="type">G_VALUE_COLLECT_INIT</span></a> variant and pass the unitialized
+<a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a>. That variant is faster than <a class="link" href="gobject-Varargs-Value-Collection.html#G-VALUE-COLLECT:CAPS" title="G_VALUE_COLLECT()"><span class="type">G_VALUE_COLLECT</span></a>.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
+<td>a <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> return location. <em class="parameter"><code>value</code></em> is supposed to be initialized
+ according to the value type to be collected
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>var_args</code></em> :</span></p></td>
+<td>the va_list variable; it may be evaluated multiple times
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
+<td>flags which are passed on to the <code class="function">collect_value()</code> function of
+ the <a class="link" href="gobject-Type-Information.html#GTypeValueTable" title="GTypeValueTable"><span class="type">GTypeValueTable</span></a> of <em class="parameter"><code>value</code></em>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>__error</code></em> :</span></p></td>
+<td>a <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>** variable that will be modified to hold a <a href="./../glib/glib/glib-Memory-Allocation.html#g-new"><code class="function">g_new()</code></a>
+ allocated error messages if something fails
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="G-VALUE-LCOPY:CAPS"></a><h3>G_VALUE_LCOPY()</h3>
+<pre class="programlisting">#define             G_VALUE_LCOPY(value, var_args, flags, __error)</pre>
+<p>
+Collects a value's variable argument locations from a va_list. Usage is
+analogous to <a class="link" href="gobject-Varargs-Value-Collection.html#G-VALUE-COLLECT:CAPS" title="G_VALUE_COLLECT()"><code class="function">G_VALUE_COLLECT()</code></a>.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
+<td>a <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> return location. <em class="parameter"><code>value</code></em> is supposed to be initialized
+ according to the value type to be collected
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>var_args</code></em> :</span></p></td>
+<td>the va_list variable; it may be evaluated multiple times
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
+<td>flags which are passed on to the <code class="function">lcopy_value()</code> function of
+ the <a class="link" href="gobject-Type-Information.html#GTypeValueTable" title="GTypeValueTable"><span class="type">GTypeValueTable</span></a> of <em class="parameter"><code>value</code></em>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>__error</code></em> :</span></p></td>
+<td>a <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>** variable that will be modified to hold a <a href="./../glib/glib/glib-Memory-Allocation.html#g-new"><code class="function">g_new()</code></a>
+ allocated error messages if something fails
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="G-VALUE-COLLECT-FORMAT-MAX-LENGTH:CAPS"></a><h3>G_VALUE_COLLECT_FORMAT_MAX_LENGTH</h3>
+<pre class="programlisting">#define G_VALUE_COLLECT_FORMAT_MAX_LENGTH (8)
+</pre>
+<p>
+The maximal number of <a class="link" href="gobject-Varargs-Value-Collection.html#GTypeCValue" title="union GTypeCValue"><span class="type">GTypeCValue</span></a>s which can be collected for a
+single <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a>.
+</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="gobject-Varargs-Value-Collection.see-also"></a><h2>See Also</h2>
+<span class="type">GValueTable</span>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.15.1</div>
+</body>
+</html>