Imported Upstream version 2.6.10

This commit is contained in:
Ari Pollak
2010-08-11 01:28:26 -04:00
parent d302c2222c
commit 04341c96c0
875 changed files with 164198 additions and 146469 deletions

View File

@ -8,20 +8,8 @@
<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.11 (XML mode)">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<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 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">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</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">
@ -34,8 +22,8 @@
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimp-gimpguides.synopsis" class="shortcut">Top</a>
 | 
<a href="#libgimp-gimpguides.description" class="shortcut">Description</a>
 | 
<a href="#libgimp-gimpguides.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="gimpguides">
@ -49,53 +37,18 @@
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libgimp-gimpguides.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> yposition);
<a
href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> xposition);
<a
href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);
<a
href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);
<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);
<a
href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);
<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>
</div>
<div class="refsect1" title="Description">
@ -108,34 +61,27 @@ Functions for manipulating guides.
<a name="libgimp-gimpguides.details"></a><h2>Details</h2>
<div class="refsect2" title="gimp_image_add_hguide ()">
<a name="gimp-image-add-hguide"></a><h3>gimp_image_add_hguide ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> gimp_image_add_hguide (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> yposition);</pre>
<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>
<p>
Add a horizontal guide to an image.
</p>
<p>
This procedure adds a horizontal guide to an image. It takes the
input image and the y-position of the new guide as parameters. It
returns the guide ID of the new guide.</p>
<p>
returns the guide ID of the new guide.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<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>The guide's y-offset from top of image.
</td>
</tr>
<tr>
@ -149,34 +95,27 @@ returns the guide ID of the new guide.</p>
<hr>
<div class="refsect2" title="gimp_image_add_vguide ()">
<a name="gimp-image-add-vguide"></a><h3>gimp_image_add_vguide ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> gimp_image_add_vguide (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> xposition);</pre>
<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>
<p>
Add a vertical guide to an image.
</p>
<p>
This procedure adds a vertical guide to an image. It takes the input
image and the x-position of the new guide as parameters. It returns
the guide ID of the new guide.</p>
<p>
the guide ID of the new guide.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<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>The guide's x-offset from left of image.
</td>
</tr>
<tr>
@ -190,33 +129,26 @@ the guide ID of the new guide.</p>
<hr>
<div class="refsect2" title="gimp_image_delete_guide ()">
<a name="gimp-image-delete-guide"></a><h3>gimp_image_delete_guide ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_delete_guide (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);</pre>
<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>
<p>
Deletes a guide from an image.
</p>
<p>
This procedure takes an image and a guide ID as input and removes
the specified guide from the specified image.</p>
<p>
the specified guide from the specified image.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<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>The ID of the guide to be removed.
</td>
</tr>
<tr>
@ -230,14 +162,8 @@ the specified guide from the specified image.</p>
<hr>
<div class="refsect2" title="gimp_image_find_next_guide ()">
<a name="gimp-image-find-next-guide"></a><h3>gimp_image_find_next_guide ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> gimp_image_find_next_guide (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);</pre>
<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>
<p>
Find next guide on an image.
</p>
@ -246,20 +172,19 @@ This procedure takes an image and a guide ID as input and finds the
guide ID of the successor of the given guide ID in the image's guide
list. If the supplied guide ID is 0, the procedure will return the
first Guide. The procedure will return 0 if given the final guide ID
as an argument or the image has no guides.</p>
<p>
as an argument or the image has no guides.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<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>The ID of the current guide (0 if first invocation).
</td>
</tr>
<tr>
@ -273,31 +198,26 @@ as an argument or the image has no guides.</p>
<hr>
<div class="refsect2" title="gimp_image_get_guide_orientation ()">
<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);</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="/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>
<p>
Get orientation of a guide on an image.
</p>
<p>
This procedure takes an image and a guide ID as input and returns
the orientations of the guide.</p>
<p>
the orientations of the guide.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<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>The guide.
</td>
</tr>
<tr>
@ -311,33 +231,26 @@ the orientations of the guide.</p>
<hr>
<div class="refsect2" title="gimp_image_get_guide_position ()">
<a name="gimp-image-get-guide-position"></a><h3>gimp_image_get_guide_position ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> gimp_image_get_guide_position (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> guide_ID);</pre>
<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>
<p>
Get position of a guide on an image.
</p>
<p>
This procedure takes an image and a guide ID as input and returns
the position of the guide relative to the top or left of the image.</p>
<p>
the position of the guide relative to the top or left of the image.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<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>The guide.
</td>
</tr>
<tr>
@ -352,6 +265,6 @@ the position of the guide relative to the top or left of the image.</p>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
Generated by GTK-Doc V1.15</div>
</body>
</html>
</html>