New upstream version 2.10.20

This commit is contained in:
Simon McVittie
2020-08-26 11:05:56 +01:00
794 changed files with 93349 additions and 84053 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpValueArray: GIMP Base Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="pt01.html" title="Part I. GIMP Base Library">
<link rel="prev" href="libgimpbase-gimputils.html" title="gimputils">
@ -66,7 +66,7 @@ generic values</p>
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libgimpbase-GimpValueArray.html#gimp-value-array-length" title="gimp_value_array_length ()">gimp_value_array_length</a> <span class="c_punctuation">()</span>
@ -74,7 +74,7 @@ generic values</p>
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *
<span class="returnvalue">GValue</span> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-GimpValueArray.html#gimp-value-array-index" title="gimp_value_array_index ()">gimp_value_array_index</a> <span class="c_punctuation">()</span>
@ -122,7 +122,7 @@ generic values</p>
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *
<span class="returnvalue">GParamSpec</span> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-GimpValueArray.html#gimp-param-spec-value-array" title="gimp_param_spec_value_array ()">gimp_param_spec_value_array</a> <span class="c_punctuation">()</span>
@ -154,7 +154,7 @@ generic values</p>
<a name="libgimpbase-GimpValueArray.description"></a><h2>Description</h2>
<p>The prime purpose of a <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> is for it to be used as an
object property that holds an array of values. A <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> wraps
an array of <a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> elements in order for it to be used as a boxed
an array of <span class="type">GValue</span> elements in order for it to be used as a boxed
type through <code class="literal">GIMP_TYPE_VALUE_ARRAY</code>.</p>
</div>
<div class="refsect1">
@ -162,7 +162,7 @@ type through <code class="literal">GIMP_TYPE_VALUE_ARRAY</code>.</p>
<div class="refsect2">
<a name="gimp-value-array-new"></a><h3>gimp_value_array_new ()</h3>
<pre class="programlisting"><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
gimp_value_array_new (<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_prealloced</code></em>);</pre>
gimp_value_array_new (<em class="parameter"><code><span class="type">gint</span> n_prealloced</code></em>);</pre>
<p>Allocate and initialize a new <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a>, optionally preserve space
for <em class="parameter"><code>n_prealloced</code></em>
elements. New arrays always contain 0 elements,
@ -244,15 +244,15 @@ array including its contents are freed.</p>
<hr>
<div class="refsect2">
<a name="gimp-value-array-length"></a><h3>gimp_value_array_length ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_value_array_length (<em class="parameter"><code>const <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> *value_array</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-value-array-index"></a><h3>gimp_value_array_index ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *
<pre class="programlisting"><span class="returnvalue">GValue</span> *
gimp_value_array_index (<em class="parameter"><code>const <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> *value_array</code></em>,
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> index</code></em>);</pre>
<em class="parameter"><code><span class="type">gint</span> index</code></em>);</pre>
<p>Return a pointer to the value at <em class="parameter"><code>index</code></em>
contained in <em class="parameter"><code>value_array</code></em>
.</p>
@ -292,12 +292,12 @@ in <em class="parameter"><code>value_array</code></em>
<a name="gimp-value-array-prepend"></a><h3>gimp_value_array_prepend ()</h3>
<pre class="programlisting"><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
gimp_value_array_prepend (<em class="parameter"><code><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> *value_array</code></em>,
<em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<em class="parameter"><code>const <span class="type">GValue</span> *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="/local/head/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, an uninitialized value is prepended.</p>
<code class="literal">NULL</code>, an uninitialized value is prepended.</p>
<div class="refsect3">
<a name="gimp-value-array-prepend.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
@ -314,7 +314,7 @@ gimp_value_array_prepend (<em class="parameter"><code><a class="link" href="libg
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p><a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to copy into <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a>, or <a href="/local/head/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_description"><p><span class="type">GValue</span> to copy into <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a>, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
@ -333,12 +333,12 @@ gimp_value_array_prepend (<em class="parameter"><code><a class="link" href="libg
<a name="gimp-value-array-append"></a><h3>gimp_value_array_append ()</h3>
<pre class="programlisting"><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
gimp_value_array_append (<em class="parameter"><code><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> *value_array</code></em>,
<em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<em class="parameter"><code>const <span class="type">GValue</span> *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="/local/head/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, an uninitialized value is appended.</p>
<code class="literal">NULL</code>, an uninitialized value is appended.</p>
<div class="refsect3">
<a name="gimp-value-array-append.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
@ -355,7 +355,7 @@ gimp_value_array_append (<em class="parameter"><code><a class="link" href="libgi
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p><a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to copy into <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a>, or <a href="/local/head/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_description"><p><span class="type">GValue</span> to copy into <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a>, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
@ -374,13 +374,13 @@ gimp_value_array_append (<em class="parameter"><code><a class="link" href="libgi
<a name="gimp-value-array-insert"></a><h3>gimp_value_array_insert ()</h3>
<pre class="programlisting"><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
gimp_value_array_insert (<em class="parameter"><code><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> *value_array</code></em>,
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> index</code></em>,
<em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<em class="parameter"><code><span class="type">gint</span> index</code></em>,
<em class="parameter"><code>const <span class="type">GValue</span> *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="/local/head/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, an uninitialized value is inserted.</p>
is <code class="literal">NULL</code>, an uninitialized value is inserted.</p>
<div class="refsect3">
<a name="gimp-value-array-insert.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
@ -402,7 +402,7 @@ is <a href="/local/head/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:C
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p><a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to copy into <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a>, or <a href="/local/head/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_description"><p><span class="type">GValue</span> to copy into <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a>, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
@ -421,7 +421,7 @@ is <a href="/local/head/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:C
<a name="gimp-value-array-remove"></a><h3>gimp_value_array_remove ()</h3>
<pre class="programlisting"><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
gimp_value_array_remove (<em class="parameter"><code><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> *value_array</code></em>,
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> index</code></em>);</pre>
<em class="parameter"><code><span class="type">gint</span> 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>
@ -461,17 +461,17 @@ gimp_value_array_remove (<em class="parameter"><code><a class="link" href="libgi
<a name="gimp-value-array-truncate"></a><h3>gimp_value_array_truncate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_value_array_truncate (<em class="parameter"><code><a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> *value_array</code></em>,
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_values</code></em>);</pre>
<em class="parameter"><code><span class="type">gint</span> n_values</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-param-spec-value-array"></a><h3>gimp_param_spec_value_array ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *
gimp_param_spec_value_array (<em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick</code></em>,
<em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *blurb</code></em>,
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *element_spec</code></em>,
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>);</pre>
<pre class="programlisting"><span class="returnvalue">GParamSpec</span> *
gimp_param_spec_value_array (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *nick</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *blurb</code></em>,
<em class="parameter"><code><span class="type">GParamSpec</span> *element_spec</code></em>,
<em class="parameter"><code><span class="type">GParamFlags</span> flags</code></em>);</pre>
</div>
</div>
<div class="refsect1">
@ -479,7 +479,7 @@ gimp_param_spec_value_array (<em class="parameter"><code>const <a href="/local/h
<div class="refsect2">
<a name="GimpValueArray"></a><h3>GimpValueArray</h3>
<pre class="programlisting">typedef struct _GimpValueArray GimpValueArray;</pre>
<p>A <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> contains an array of <a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> elements.</p>
<p>A <a class="link" href="libgimpbase-GimpValueArray.html#GimpValueArray" title="GimpValueArray"><span class="type">GimpValueArray</span></a> contains an array of <span class="type">GValue</span> elements.</p>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
@ -491,7 +491,7 @@ gimp_param_spec_value_array (<em class="parameter"><code>const <a href="/local/h
gint fixed_n_elements;
};
</pre>
<p>A <a href="/local/head/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> derived structure that contains the meta data for
<p>A <span class="type">GParamSpec</span> derived structure that contains the meta data for
value array properties.</p>
<div class="refsect3">
<a name="GimpParamSpecValueArray.members"></a><h4>Members</h4>
@ -503,12 +503,12 @@ value array properties.</p>
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="/local/head/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *<em class="structfield"><code><a name="GimpParamSpecValueArray.element-spec"></a>element_spec</code></em>;</p></td>
<td class="struct_member_description"><p>the <a href="/local/head/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> of the array elements</p></td>
<td class="struct_member_name"><p><span class="type">GParamSpec</span> *<em class="structfield"><code><a name="GimpParamSpecValueArray.element-spec"></a>element_spec</code></em>;</p></td>
<td class="struct_member_description"><p>the <span class="type">GParamSpec</span> of the array elements</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/local/head/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GimpParamSpecValueArray.fixed-n-elements"></a>fixed_n_elements</code></em>;</p></td>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpParamSpecValueArray.fixed-n-elements"></a>fixed_n_elements</code></em>;</p></td>
<td class="struct_member_description"><p>default length of the array</p></td>
<td class="struct_member_annotations"> </td>
</tr>
@ -519,7 +519,7 @@ value array properties.</p>
</div>
<div class="refsect1">
<a name="libgimpbase-GimpValueArray.see-also"></a><h2>See Also</h2>
<p><a href="/local/head/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, <a href="/local/head/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#GParamSpecValueArray"><span class="type">GParamSpecValueArray</span></a>, <a class="link" href="libgimpbase-GimpValueArray.html#gimp-param-spec-value-array" title="gimp_param_spec_value_array ()"><code class="function">gimp_param_spec_value_array()</code></a></p>
<p><span class="type">GValue</span>, <span class="type">GParamSpecValueArray</span>, <a class="link" href="libgimpbase-GimpValueArray.html#gimp-param-spec-value-array" title="gimp_param_spec_value_array ()"><code class="function">gimp_param_spec_value_array()</code></a></p>
</div>
</div>
<div class="footer">