526 lines
18 KiB
HTML
526 lines
18 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.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-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 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-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="#id2603607" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2655526" 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="id2603607"></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">
|
|
|
|
|
|
|
|
gboolean <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-get-spacing">gimp_image_grid_get_spacing</a> (gint32 image_ID,
|
|
gdouble *xspacing,
|
|
gdouble *yspacing);
|
|
gboolean <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-set-spacing">gimp_image_grid_set_spacing</a> (gint32 image_ID,
|
|
gdouble xspacing,
|
|
gdouble yspacing);
|
|
gboolean <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-get-offset">gimp_image_grid_get_offset</a> (gint32 image_ID,
|
|
gdouble *xoffset,
|
|
gdouble *yoffset);
|
|
gboolean <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-set-offset">gimp_image_grid_set_offset</a> (gint32 image_ID,
|
|
gdouble xoffset,
|
|
gdouble yoffset);
|
|
gboolean <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-get-foreground-color">gimp_image_grid_get_foreground_color</a>
|
|
(gint32 image_ID,
|
|
<a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *fgcolor);
|
|
gboolean <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-set-foreground-color">gimp_image_grid_set_foreground_color</a>
|
|
(gint32 image_ID,
|
|
const <a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *fgcolor);
|
|
gboolean <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-get-background-color">gimp_image_grid_get_background_color</a>
|
|
(gint32 image_ID,
|
|
<a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *bgcolor);
|
|
gboolean <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-set-background-color">gimp_image_grid_set_background_color</a>
|
|
(gint32 image_ID,
|
|
const <a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *bgcolor);
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpGridStyle"
|
|
>GimpGridStyle</a> <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-get-style">gimp_image_grid_get_style</a> (gint32 image_ID);
|
|
gboolean <a class="link" href="libgimp-gimpgrid.html#gimp-image-grid-set-style">gimp_image_grid_set_style</a> (gint32 image_ID,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpGridStyle"
|
|
>GimpGridStyle</a> style);
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2655526"></a><h2>Description</h2>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2655541"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2655552"></a><h3>
|
|
<a name="gimp-image-grid-get-spacing"></a>gimp_image_grid_get_spacing ()</h3>
|
|
<a class="indexterm" name="id2655566"></a><pre class="programlisting">gboolean gimp_image_grid_get_spacing (gint32 image_ID,
|
|
gdouble *xspacing,
|
|
gdouble *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><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>xspacing</code></em> :</span></p></td>
|
|
<td> The image's grid horizontal spacing.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>yspacing</code></em> :</span></p></td>
|
|
<td> The image's grid vertical spacing.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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="id2655680"></a><h3>
|
|
<a name="gimp-image-grid-set-spacing"></a>gimp_image_grid_set_spacing ()</h3>
|
|
<a class="indexterm" name="id2655694"></a><pre class="programlisting">gboolean gimp_image_grid_set_spacing (gint32 image_ID,
|
|
gdouble xspacing,
|
|
gdouble 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><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>xspacing</code></em> :</span></p></td>
|
|
<td> The image's grid horizontal spacing.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>yspacing</code></em> :</span></p></td>
|
|
<td> The image's grid vertical spacing.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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="id2639806"></a><h3>
|
|
<a name="gimp-image-grid-get-offset"></a>gimp_image_grid_get_offset ()</h3>
|
|
<a class="indexterm" name="id2639819"></a><pre class="programlisting">gboolean gimp_image_grid_get_offset (gint32 image_ID,
|
|
gdouble *xoffset,
|
|
gdouble *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><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>xoffset</code></em> :</span></p></td>
|
|
<td> The image's grid horizontal offset.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>yoffset</code></em> :</span></p></td>
|
|
<td> The image's grid vertical offset.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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="id2639936"></a><h3>
|
|
<a name="gimp-image-grid-set-offset"></a>gimp_image_grid_set_offset ()</h3>
|
|
<a class="indexterm" name="id2639949"></a><pre class="programlisting">gboolean gimp_image_grid_set_offset (gint32 image_ID,
|
|
gdouble xoffset,
|
|
gdouble 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><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>xoffset</code></em> :</span></p></td>
|
|
<td> The image's grid horizontal offset.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>yoffset</code></em> :</span></p></td>
|
|
<td> The image's grid vertical offset.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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="id2640065"></a><h3>
|
|
<a name="gimp-image-grid-get-foreground-color"></a>gimp_image_grid_get_foreground_color ()</h3>
|
|
<a class="indexterm" name="id2640081"></a><pre class="programlisting">gboolean gimp_image_grid_get_foreground_color
|
|
(gint32 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><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>fgcolor</code></em> :</span></p></td>
|
|
<td> The image's grid foreground color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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="id2654204"></a><h3>
|
|
<a name="gimp-image-grid-set-foreground-color"></a>gimp_image_grid_set_foreground_color ()</h3>
|
|
<a class="indexterm" name="id2654220"></a><pre class="programlisting">gboolean gimp_image_grid_set_foreground_color
|
|
(gint32 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><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>fgcolor</code></em> :</span></p></td>
|
|
<td> The new foreground color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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="id2654316"></a><h3>
|
|
<a name="gimp-image-grid-get-background-color"></a>gimp_image_grid_get_background_color ()</h3>
|
|
<a class="indexterm" name="id2654332"></a><pre class="programlisting">gboolean gimp_image_grid_get_background_color
|
|
(gint32 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><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>bgcolor</code></em> :</span></p></td>
|
|
<td> The image's grid background color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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="id2654428"></a><h3>
|
|
<a name="gimp-image-grid-set-background-color"></a>gimp_image_grid_set_background_color ()</h3>
|
|
<a class="indexterm" name="id2654444"></a><pre class="programlisting">gboolean gimp_image_grid_set_background_color
|
|
(gint32 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><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>bgcolor</code></em> :</span></p></td>
|
|
<td> The new background color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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="id2654540"></a><h3>
|
|
<a name="gimp-image-grid-get-style"></a>gimp_image_grid_get_style ()</h3>
|
|
<a class="indexterm" name="id2654553"></a><pre class="programlisting"><a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpGridStyle"
|
|
>GimpGridStyle</a> gimp_image_grid_get_style (gint32 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><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"><span class="emphasis"><em>Returns</em></span> :</span></p></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="id2656561"></a><h3>
|
|
<a name="gimp-image-grid-set-style"></a>gimp_image_grid_set_style ()</h3>
|
|
<a class="indexterm" name="id2656574"></a><pre class="programlisting">gboolean gimp_image_grid_set_style (gint32 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><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>style</code></em> :</span></p></td>
|
|
<td> The image's grid style.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td> TRUE on success.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|