Imported Upstream version 2.4.6

This commit is contained in:
Ari Pollak
2010-08-11 01:24:52 -04:00
parent 9398f19fe7
commit 478f5ecc84
539 changed files with 157836 additions and 69286 deletions

View File

@ -1,21 +1,21 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpguides</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" 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.9 (XML mode)">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
@ -31,94 +31,88 @@
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpimage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2608590" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2655845" class="shortcut">Description</a></nobr></td></tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgimp-gimpguides.synopsis" class="shortcut">Top</a>
 | 
<a href="#libgimp-gimpguides.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpguides"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2608590"></a><span class="refentrytitle">gimpguides</span>
</h2>
<p>gimpguides &#8212; Functions for manipulating guides.</p>
<h2><span class="refentrytitle"><a name="libgimp-gimpguides.top_of_page"></a>gimpguides</span></h2>
<p>gimpguides — Functions for manipulating guides.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="libgimp-gimpguides.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> <a class="link" href="libgimp-gimpguides.html#gimp-image-add-hguide">gimp_image_add_hguide</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> <a class="link" href="libgimp-gimpguides.html#gimp-image-add-hguide" title="gimp_image_add_hguide ()">gimp_image_add_hguide</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> yposition);
<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> <a class="link" href="libgimp-gimpguides.html#gimp-image-add-vguide">gimp_image_add_vguide</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> <a class="link" href="libgimp-gimpguides.html#gimp-image-add-vguide" title="gimp_image_add_vguide ()">gimp_image_add_vguide</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> xposition);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpguides.html#gimp-image-delete-guide">gimp_image_delete_guide</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpguides.html#gimp-image-delete-guide" title="gimp_image_delete_guide ()">gimp_image_delete_guide</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);
<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> <a class="link" href="libgimp-gimpguides.html#gimp-image-find-next-guide">gimp_image_find_next_guide</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</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> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);
<a class="link" href="libgimp-gimpenums.html#GimpOrientationType">GimpOrientationType</a> <a class="link" href="libgimp-gimpguides.html#gimp-image-get-guide-orientation">gimp_image_get_guide_orientation</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
<a class="link" href="libgimp-gimpenums.html#GimpOrientationType" title="enum GimpOrientationType">GimpOrientationType</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> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="libgimp-gimpguides.html#gimp-image-get-guide-position">gimp_image_get_guide_position</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</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> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2655845"></a><h2>Description</h2>
<a name="libgimp-gimpguides.description"></a><h2>Description</h2>
<p>
Functions for manipulating guides.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2655861"></a><h2>Details</h2>
<a name="libgimp-gimpguides.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2655872"></a><h3>
<a name="gimp-image-add-hguide"></a>gimp_image_add_hguide ()</h3>
<a class="indexterm" name="id2655883"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint32"
<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"
>gint32</a> gimp_image_add_hguide (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> yposition);</pre>
<p>
Add a horizontal guide to an image.
@ -134,17 +128,17 @@ returns the guide ID of the new guide.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>yposition</code></em>&#160;:</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The new guide.
</td>
</tr>
@ -153,15 +147,14 @@ returns the guide ID of the new guide.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2655970"></a><h3>
<a name="gimp-image-add-vguide"></a>gimp_image_add_vguide ()</h3>
<a class="indexterm" name="id2655982"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint32"
<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"
>gint32</a> gimp_image_add_vguide (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> xposition);</pre>
<p>
Add a vertical guide to an image.
@ -177,17 +170,17 @@ the guide ID of the new guide.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xposition</code></em>&#160;:</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The new guide.
</td>
</tr>
@ -196,15 +189,14 @@ the guide ID of the new guide.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2655546"></a><h3>
<a name="gimp-image-delete-guide"></a>gimp_image_delete_guide ()</h3>
<a class="indexterm" name="id2655557"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
<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"
>gboolean</a> gimp_image_delete_guide (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);</pre>
<p>
Deletes a guide from an image.
@ -219,17 +211,17 @@ the specified guide from the specified image.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em>&#160;:</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE on success.
</td>
</tr>
@ -238,15 +230,14 @@ the specified guide from the specified image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2655644"></a><h3>
<a name="gimp-image-find-next-guide"></a>gimp_image_find_next_guide ()</h3>
<a class="indexterm" name="id2655655"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint32"
<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"
>gint32</a> gimp_image_find_next_guide (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);</pre>
<p>
Find next guide on an image.
@ -264,17 +255,17 @@ as an argument or the image has no guides.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em>&#160;:</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The next guide's ID.
</td>
</tr>
@ -283,13 +274,12 @@ as an argument or the image has no guides.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637274"></a><h3>
<a name="gimp-image-get-guide-orientation"></a>gimp_image_get_guide_orientation ()</h3>
<a class="indexterm" name="id2637285"></a><pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpOrientationType">GimpOrientationType</a> gimp_image_get_guide_orientation (<a
href="../glib/glib-Basic-Types.html#gint32"
<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">GimpOrientationType</a> gimp_image_get_guide_orientation (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);</pre>
<p>
Get orientation of a guide on an image.
@ -304,17 +294,17 @@ the orientations of the guide.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em>&#160;:</span></p></td>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em> :</span></p></td>
<td> The guide.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The guide's orientation.
</td>
</tr>
@ -323,15 +313,14 @@ the orientations of the guide.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637370"></a><h3>
<a name="gimp-image-get-guide-position"></a>gimp_image_get_guide_position ()</h3>
<a class="indexterm" name="id2637382"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
<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"
>gint</a> gimp_image_get_guide_position (<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);</pre>
<p>
Get position of a guide on an image.
@ -346,17 +335,17 @@ the position of the guide relative to the top or left of the image.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em>&#160;:</span></p></td>
<td><p><span class="term"><em class="parameter"><code>guide_ID</code></em> :</span></p></td>
<td> The guide.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<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>
</tr>
@ -364,11 +353,9 @@ the position of the guide relative to the top or left of the image.</p>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2637471"></a><div class="refsect2" lang="en"><a name="id2637472"></a></div>
</div>
<div class="footer">
<hr>
<div class="refsect2" lang="en"><a name="id2637473"></a></div>
</div>
</div>
Generated by GTK-Doc V1.10</div>
</body>
</html>