Files
gimp/devel-docs/libgimp/html/libgimp-gimpgrid.html
2010-08-11 01:22:21 -04:00

634 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpgrid</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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-gimpfloatingsel.html" title="gimpfloatingsel">
<link rel="next" href="libgimp-gimpguides.html" title="gimpguides">
<meta name="generator" content="GTK-Doc V1.8 (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="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="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-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">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpfloatingsel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpguides.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="#id2588618" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2638402" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpgrid"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2588618"></a><span class="refentrytitle">gimpgrid</span>
</h2>
<p>gimpgrid</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-get-spacing">gimp_image_grid_get_spacing</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *xspacing,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *yspacing);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-set-spacing">gimp_image_grid_set_spacing</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> xspacing,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> yspacing);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-get-offset">gimp_image_grid_get_offset</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *xoffset,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *yoffset);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-set-offset">gimp_image_grid_set_offset</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> xoffset,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> yoffset);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-get-foreground-color">gimp_image_grid_get_foreground_color</a>
(<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *fgcolor);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-set-foreground-color">gimp_image_grid_set_foreground_color</a>
(<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *fgcolor);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-get-background-color">gimp_image_grid_get_background_color</a>
(<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *bgcolor);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-set-background-color">gimp_image_grid_set_background_color</a>
(<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *bgcolor);
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpGridStyle"
>GimpGridStyle</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-get-style">gimp_image_grid_get_style</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgrid.html#gimp-image-grid-set-style">gimp_image_grid_set_style</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpGridStyle"
>GimpGridStyle</a> style);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2638402"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2638418"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2638428"></a><h3>
<a name="gimp-image-grid-get-spacing"></a>gimp_image_grid_get_spacing ()</h3>
<a class="indexterm" name="id2638442"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_grid_get_spacing (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *xspacing,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *yspacing);</pre>
<p>
Gets the spacing of an image's grid.
</p>
<p>
This procedure retrieves the horizontal and vertical spacing of an
image's grid. It takes the image as parameter.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>xspacing</code></em>&#160;:</span></td>
<td> The image's grid horizontal spacing.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>yspacing</code></em>&#160;:</span></td>
<td> The image's grid vertical spacing.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2638557"></a><h3>
<a name="gimp-image-grid-set-spacing"></a>gimp_image_grid_set_spacing ()</h3>
<a class="indexterm" name="id2638570"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_grid_set_spacing (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> xspacing,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> yspacing);</pre>
<p>
Sets the spacing of an image's grid.
</p>
<p>
This procedure sets the horizontal and vertical spacing of an
image's grid.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>xspacing</code></em>&#160;:</span></td>
<td> The image's grid horizontal spacing.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>yspacing</code></em>&#160;:</span></td>
<td> The image's grid vertical spacing.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623882"></a><h3>
<a name="gimp-image-grid-get-offset"></a>gimp_image_grid_get_offset ()</h3>
<a class="indexterm" name="id2623896"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_grid_get_offset (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *xoffset,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *yoffset);</pre>
<p>
Gets the offset of an image's grid.
</p>
<p>
This procedure retrieves the horizontal and vertical offset of an
image's grid. It takes the image as parameter.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>xoffset</code></em>&#160;:</span></td>
<td> The image's grid horizontal offset.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>yoffset</code></em>&#160;:</span></td>
<td> The image's grid vertical offset.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624012"></a><h3>
<a name="gimp-image-grid-set-offset"></a>gimp_image_grid_set_offset ()</h3>
<a class="indexterm" name="id2624026"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_grid_set_offset (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> xoffset,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> yoffset);</pre>
<p>
Sets the offset of an image's grid.
</p>
<p>
This procedure sets the horizontal and vertical offset of an image's
grid.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>xoffset</code></em>&#160;:</span></td>
<td> The image's grid horizontal offset.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>yoffset</code></em>&#160;:</span></td>
<td> The image's grid vertical offset.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624141"></a><h3>
<a name="gimp-image-grid-get-foreground-color"></a>gimp_image_grid_get_foreground_color ()</h3>
<a class="indexterm" name="id2624157"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_grid_get_foreground_color
(<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *fgcolor);</pre>
<p>
Sets the foreground color of an image's grid.
</p>
<p>
This procedure gets the foreground color of an image's grid.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>fgcolor</code></em>&#160;:</span></td>
<td> The image's grid foreground color.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637042"></a><h3>
<a name="gimp-image-grid-set-foreground-color"></a>gimp_image_grid_set_foreground_color ()</h3>
<a class="indexterm" name="id2637058"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_grid_set_foreground_color
(<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *fgcolor);</pre>
<p>
Gets the foreground color of an image's grid.
</p>
<p>
This procedure sets the foreground color of an image's grid.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>fgcolor</code></em>&#160;:</span></td>
<td> The new foreground color.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637153"></a><h3>
<a name="gimp-image-grid-get-background-color"></a>gimp_image_grid_get_background_color ()</h3>
<a class="indexterm" name="id2637169"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_grid_get_background_color
(<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *bgcolor);</pre>
<p>
Sets the background color of an image's grid.
</p>
<p>
This procedure gets the background color of an image's grid.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>bgcolor</code></em>&#160;:</span></td>
<td> The image's grid background color.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637265"></a><h3>
<a name="gimp-image-grid-set-background-color"></a>gimp_image_grid_set_background_color ()</h3>
<a class="indexterm" name="id2637281"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_grid_set_background_color
(<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *bgcolor);</pre>
<p>
Gets the background color of an image's grid.
</p>
<p>
This procedure sets the background color of an image's grid.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>bgcolor</code></em>&#160;:</span></td>
<td> The new background color.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637377"></a><h3>
<a name="gimp-image-grid-get-style"></a>gimp_image_grid_get_style ()</h3>
<a class="indexterm" name="id2637390"></a><pre class="programlisting"><a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpGridStyle"
>GimpGridStyle</a> gimp_image_grid_get_style (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<p>
Gets the style of an image's grid.
</p>
<p>
This procedure retrieves the style of an image's grid.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The image's grid style.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2639410"></a><h3>
<a name="gimp-image-grid-set-style"></a>gimp_image_grid_set_style ()</h3>
<a class="indexterm" name="id2639423"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_grid_set_style (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpGridStyle"
>GimpGridStyle</a> style);</pre>
<p>
Sets the style unit of an image's grid.
</p>
<p>
This procedure sets the style of an image's grid. It takes the image
and the new style as parameters.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>style</code></em>&#160;:</span></td>
<td> The image's grid style.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>