Imported Upstream version 2.6.12

This commit is contained in:
Ari Pollak
2012-02-18 13:51:51 -05:00
parent 357cf155b6
commit 3fcab19200
550 changed files with 140833 additions and 99740 deletions

View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpguides</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="prev" href="libgimp-gimpgrid.html" title="gimpgrid">
<link rel="next" href="libgimp-gimpimage.html" title="gimpimage">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -26,7 +26,7 @@
<a href="#libgimp-gimpguides.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="gimpguides">
<div class="refentry">
<a name="libgimp-gimpguides"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
@ -35,34 +35,34 @@
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<div class="refsynopsisdiv">
<a name="libgimp-gimpguides.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-add-hguide" title="gimp_image_add_hguide ()">gimp_image_add_hguide</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> yposition</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-add-vguide" title="gimp_image_add_vguide ()">gimp_image_add_vguide</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> xposition</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-delete-guide" title="gimp_image_delete_guide ()">gimp_image_delete_guide</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-find-next-guide" title="gimp_image_find_next_guide ()">gimp_image_find_next_guide</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);
<a class="link" href="libgimp-gimpenums.html#GimpOrientationType" title="enum GimpOrientationType"><span class="returnvalue">GimpOrientationType</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-get-guide-orientation" title="gimp_image_get_guide_orientation ()">gimp_image_get_guide_orientation</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-get-guide-position" title="gimp_image_get_guide_position ()">gimp_image_get_guide_position</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);
<pre class="synopsis"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-add-hguide" title="gimp_image_add_hguide ()">gimp_image_add_hguide</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> yposition</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-add-vguide" title="gimp_image_add_vguide ()">gimp_image_add_vguide</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> xposition</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-delete-guide" title="gimp_image_delete_guide ()">gimp_image_delete_guide</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-find-next-guide" title="gimp_image_find_next_guide ()">gimp_image_find_next_guide</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);
<a class="link" href="libgimp-gimpenums.html#GimpOrientationType" title="enum GimpOrientationType"><span class="returnvalue">GimpOrientationType</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-get-guide-orientation" title="gimp_image_get_guide_orientation ()">gimp_image_get_guide_orientation</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgimp-gimpguides.html#gimp-image-get-guide-position" title="gimp_image_get_guide_position ()">gimp_image_get_guide_position</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<div class="refsect1">
<a name="libgimp-gimpguides.description"></a><h2>Description</h2>
<p>
Functions for manipulating guides.
</p>
</div>
<div class="refsect1" title="Details">
<div class="refsect1">
<a name="libgimp-gimpguides.details"></a><h2>Details</h2>
<div class="refsect2" title="gimp_image_add_hguide ()">
<div class="refsect2">
<a name="gimp-image-add-hguide"></a><h3>gimp_image_add_hguide ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> gimp_image_add_hguide (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> yposition</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> gimp_image_add_hguide (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> yposition</code></em>);</pre>
<p>
Add a horizontal guide to an image.
</p>
@ -76,27 +76,24 @@ returns the guide ID of the new guide.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The image.
</td>
<td>The image.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>yposition</code></em> :</span></p></td>
<td>The guide's y-offset from top of image.
</td>
<td>The guide's y-offset from top of image.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The new guide.
</td>
<td>The new guide.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_image_add_vguide ()">
<div class="refsect2">
<a name="gimp-image-add-vguide"></a><h3>gimp_image_add_vguide ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> gimp_image_add_vguide (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> xposition</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> gimp_image_add_vguide (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> xposition</code></em>);</pre>
<p>
Add a vertical guide to an image.
</p>
@ -110,27 +107,24 @@ the guide ID of the new guide.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The image.
</td>
<td>The image.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xposition</code></em> :</span></p></td>
<td>The guide's x-offset from left of image.
</td>
<td>The guide's x-offset from left of image.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The new guide.
</td>
<td>The new guide.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_image_delete_guide ()">
<div class="refsect2">
<a name="gimp-image-delete-guide"></a><h3>gimp_image_delete_guide ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_image_delete_guide (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_image_delete_guide (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);</pre>
<p>
Deletes a guide from an image.
</p>
@ -143,27 +137,24 @@ the specified guide from the specified image.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The image.
</td>
<td>The image.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em> :</span></p></td>
<td>The ID of the guide to be removed.
</td>
<td>The ID of the guide to be removed.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE on success.
</td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_image_find_next_guide ()">
<div class="refsect2">
<a name="gimp-image-find-next-guide"></a><h3>gimp_image_find_next_guide ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> gimp_image_find_next_guide (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="returnvalue">gint32</span></a> gimp_image_find_next_guide (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);</pre>
<p>
Find next guide on an image.
</p>
@ -179,27 +170,24 @@ as an argument or the image has no guides.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The image.
</td>
<td>The image.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em> :</span></p></td>
<td>The ID of the current guide (0 if first invocation).
</td>
<td>The ID of the current guide (0 if first invocation).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The next guide's ID.
</td>
<td>The next guide's ID.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_image_get_guide_orientation ()">
<div class="refsect2">
<a name="gimp-image-get-guide-orientation"></a><h3>gimp_image_get_guide_orientation ()</h3>
<pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpOrientationType" title="enum GimpOrientationType"><span class="returnvalue">GimpOrientationType</span></a> gimp_image_get_guide_orientation (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);</pre>
<pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpOrientationType" title="enum GimpOrientationType"><span class="returnvalue">GimpOrientationType</span></a> gimp_image_get_guide_orientation (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);</pre>
<p>
Get orientation of a guide on an image.
</p>
@ -212,27 +200,24 @@ the orientations of the guide.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The image.
</td>
<td>The image.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em> :</span></p></td>
<td>The guide.
</td>
<td>The guide.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The guide's orientation.
</td>
<td>The guide's orientation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_image_get_guide_position ()">
<div class="refsect2">
<a name="gimp-image-get-guide-position"></a><h3>gimp_image_get_guide_position ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gimp_image_get_guide_position (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gimp_image_get_guide_position (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> guide_ID</code></em>);</pre>
<p>
Get position of a guide on an image.
</p>
@ -245,18 +230,15 @@ the position of the guide relative to the top or left of the image.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The image.
</td>
<td>The image.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em> :</span></p></td>
<td>The guide.
</td>
<td>The guide.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The guide's position relative to top or left of image.
</td>
<td>The guide's position relative to top or left of image.</td>
</tr>
</tbody>
</table></div>
@ -265,6 +247,6 @@ the position of the guide relative to the top or left of the image.
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
Generated by GTK-Doc V1.18</div>
</body>
</html>