diff options
Diffstat (limited to 'devel-docs/libgimp/html/libgimp-gimpimageguides.html')
| -rw-r--r-- | devel-docs/libgimp/html/libgimp-gimpimageguides.html | 324 |
1 files changed, 324 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpimageguides.html b/devel-docs/libgimp/html/libgimp-gimpimageguides.html new file mode 100644 index 0000000..8e03484 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimageguides.html @@ -0,0 +1,324 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gimpimageguides: GIMP Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Library Reference Manual"> +<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties"> +<link rel="prev" href="libgimp-gimpimagegrid.html" title="gimpimagegrid"> +<link rel="next" href="libgimp-gimpimagesamplepoints.html" title="gimpimagesamplepoints"> +<meta name="generator" content="GTK-Doc V1.33.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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#libgimp-gimpimageguides.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimp-gimpimagegrid.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimp-gimpimagesamplepoints.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimp-gimpimageguides"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimp-gimpimageguides.top_of_page"></a>gimpimageguides</span></h2> +<p>gimpimageguides — Functions for manipulating an image's guides.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimp-gimpimageguides.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimageguides.html#gimp-image-add-hguide" title="gimp_image_add_hguide ()">gimp_image_add_hguide</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimageguides.html#gimp-image-add-vguide" title="gimp_image_add_vguide ()">gimp_image_add_vguide</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimageguides.html#gimp-image-delete-guide" title="gimp_image_delete_guide ()">gimp_image_delete_guide</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimageguides.html#gimp-image-find-next-guide" title="gimp_image_find_next_guide ()">gimp_image_find_next_guide</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../html/libgimpbase-gimpbaseenums.html#GimpOrientationType"><span class="returnvalue">GimpOrientationType</span></a> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimageguides.html#gimp-image-get-guide-orientation" title="gimp_image_get_guide_orientation ()">gimp_image_get_guide_orientation</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimageguides.html#gimp-image-get-guide-position" title="gimp_image_get_guide_position ()">gimp_image_get_guide_position</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpimageguides.description"></a><h2>Description</h2> +<p>Functions for manipulating an image's guides.</p> +</div> +<div class="refsect1"> +<a name="libgimp-gimpimageguides.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-image-add-hguide"></a><h3>gimp_image_add_hguide ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_add_hguide (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> 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> +<div class="refsect3"> +<a name="gimp-image-add-hguide.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>yposition</p></td> +<td class="parameter_description"><p>The guide's y-offset from top of image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-add-hguide.returns"></a><h4>Returns</h4> +<p> The new guide.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-add-vguide"></a><h3>gimp_image_add_vguide ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_add_vguide (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> 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> +<div class="refsect3"> +<a name="gimp-image-add-vguide.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>xposition</p></td> +<td class="parameter_description"><p>The guide's x-offset from left of image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-add-vguide.returns"></a><h4>Returns</h4> +<p> The new guide.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-delete-guide"></a><h3>gimp_image_delete_guide ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_delete_guide (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> 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> +<div class="refsect3"> +<a name="gimp-image-delete-guide.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>guide_ID</p></td> +<td class="parameter_description"><p>The ID of the guide to be removed.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-delete-guide.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-find-next-guide"></a><h3>gimp_image_find_next_guide ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_find_next_guide (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> guide_ID</code></em>);</pre> +<p>Find next guide on an image.</p> +<p>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> +<div class="refsect3"> +<a name="gimp-image-find-next-guide.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>guide_ID</p></td> +<td class="parameter_description"><p>The ID of the current guide (0 if first invocation).</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-find-next-guide.returns"></a><h4>Returns</h4> +<p> The next guide's ID.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-guide-orientation"></a><h3>gimp_image_get_guide_orientation ()</h3> +<pre class="programlisting"><a href="../html/libgimpbase-gimpbaseenums.html#GimpOrientationType"><span class="returnvalue">GimpOrientationType</span></a> +gimp_image_get_guide_orientation (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> 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> +<div class="refsect3"> +<a name="gimp-image-get-guide-orientation.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>guide_ID</p></td> +<td class="parameter_description"><p>The guide.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-guide-orientation.returns"></a><h4>Returns</h4> +<p> The guide's orientation.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-guide-position"></a><h3>gimp_image_get_guide_position ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_image_get_guide_position (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> 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> +<div class="refsect3"> +<a name="gimp-image-get-guide-position.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>guide_ID</p></td> +<td class="parameter_description"><p>The guide.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-guide-position.returns"></a><h4>Returns</h4> +<p> The guide's position relative to top or left of image.</p> +</div> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html>
\ No newline at end of file |