330 lines
17 KiB
XML
330 lines
17 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="libgimp-gimpgrid">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page">gimpgrid</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpgrid</refname>
|
|
<refpurpose></refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-grid-get-spacing">gimp_image_grid_get_spacing</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gdouble">gdouble</link> *xspacing,
|
|
<link linkend="gdouble">gdouble</link> *yspacing);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-grid-set-spacing">gimp_image_grid_set_spacing</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gdouble">gdouble</link> xspacing,
|
|
<link linkend="gdouble">gdouble</link> yspacing);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-grid-get-offset">gimp_image_grid_get_offset</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gdouble">gdouble</link> *xoffset,
|
|
<link linkend="gdouble">gdouble</link> *yoffset);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-grid-set-offset">gimp_image_grid_set_offset</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gdouble">gdouble</link> xoffset,
|
|
<link linkend="gdouble">gdouble</link> yoffset);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-grid-get-foreground-color">gimp_image_grid_get_foreground_color</link>
|
|
(<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="GimpRGB">GimpRGB</link> *fgcolor);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-grid-set-foreground-color">gimp_image_grid_set_foreground_color</link>
|
|
(<link linkend="gint32">gint32</link> image_ID,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *fgcolor);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-grid-get-background-color">gimp_image_grid_get_background_color</link>
|
|
(<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="GimpRGB">GimpRGB</link> *bgcolor);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-grid-set-background-color">gimp_image_grid_set_background_color</link>
|
|
(<link linkend="gint32">gint32</link> image_ID,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *bgcolor);
|
|
<link linkend="GimpGridStyle">GimpGridStyle</link> <link linkend="gimp-image-grid-get-style">gimp_image_grid_get_style</link> (<link linkend="gint32">gint32</link> image_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-grid-set-style">gimp_image_grid_set_style</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="GimpGridStyle">GimpGridStyle</link> style);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-get-spacing" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_get_spacing ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_get_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_grid_get_spacing (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gdouble">gdouble</link> *xspacing,
|
|
<link linkend="gdouble">gdouble</link> *yspacing);</programlisting>
|
|
<para>
|
|
Gets the spacing of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the horizontal and vertical spacing of an
|
|
image's grid. It takes the image as parameter.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>xspacing</parameter> :</term>
|
|
<listitem><simpara> The image's grid horizontal spacing.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>yspacing</parameter> :</term>
|
|
<listitem><simpara> The image's grid vertical spacing.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-set-spacing" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_set_spacing ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_set_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_grid_set_spacing (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gdouble">gdouble</link> xspacing,
|
|
<link linkend="gdouble">gdouble</link> yspacing);</programlisting>
|
|
<para>
|
|
Sets the spacing of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure sets the horizontal and vertical spacing of an
|
|
image's grid.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>xspacing</parameter> :</term>
|
|
<listitem><simpara> The image's grid horizontal spacing.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>yspacing</parameter> :</term>
|
|
<listitem><simpara> The image's grid vertical spacing.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-get-offset" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_get_offset ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_get_offset</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_grid_get_offset (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gdouble">gdouble</link> *xoffset,
|
|
<link linkend="gdouble">gdouble</link> *yoffset);</programlisting>
|
|
<para>
|
|
Gets the offset of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the horizontal and vertical offset of an
|
|
image's grid. It takes the image as parameter.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>xoffset</parameter> :</term>
|
|
<listitem><simpara> The image's grid horizontal offset.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>yoffset</parameter> :</term>
|
|
<listitem><simpara> The image's grid vertical offset.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-set-offset" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_set_offset ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_set_offset</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_grid_set_offset (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gdouble">gdouble</link> xoffset,
|
|
<link linkend="gdouble">gdouble</link> yoffset);</programlisting>
|
|
<para>
|
|
Sets the offset of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure sets the horizontal and vertical offset of an image's
|
|
grid.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>xoffset</parameter> :</term>
|
|
<listitem><simpara> The image's grid horizontal offset.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>yoffset</parameter> :</term>
|
|
<listitem><simpara> The image's grid vertical offset.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-get-foreground-color" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_get_foreground_color ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_get_foreground_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_grid_get_foreground_color
|
|
(<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="GimpRGB">GimpRGB</link> *fgcolor);</programlisting>
|
|
<para>
|
|
Sets the foreground color of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure gets the foreground color of an image's grid.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>fgcolor</parameter> :</term>
|
|
<listitem><simpara> The image's grid foreground color.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-set-foreground-color" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_set_foreground_color ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_set_foreground_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_grid_set_foreground_color
|
|
(<link linkend="gint32">gint32</link> image_ID,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *fgcolor);</programlisting>
|
|
<para>
|
|
Gets the foreground color of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure sets the foreground color of an image's grid.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>fgcolor</parameter> :</term>
|
|
<listitem><simpara> The new foreground color.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-get-background-color" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_get_background_color ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_get_background_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_grid_get_background_color
|
|
(<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="GimpRGB">GimpRGB</link> *bgcolor);</programlisting>
|
|
<para>
|
|
Sets the background color of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure gets the background color of an image's grid.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>bgcolor</parameter> :</term>
|
|
<listitem><simpara> The image's grid background color.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-set-background-color" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_set_background_color ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_set_background_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_grid_set_background_color
|
|
(<link linkend="gint32">gint32</link> image_ID,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *bgcolor);</programlisting>
|
|
<para>
|
|
Gets the background color of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure sets the background color of an image's grid.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>bgcolor</parameter> :</term>
|
|
<listitem><simpara> The new background color.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-get-style" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_get_style ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_get_style</primary></indexterm><programlisting><link linkend="GimpGridStyle">GimpGridStyle</link> gimp_image_grid_get_style (<link linkend="gint32">gint32</link> image_ID);</programlisting>
|
|
<para>
|
|
Gets the style of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the style of an image's grid.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The image's grid style.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-grid-set-style" role="function" condition="since:GIMP 2.4"/>gimp_image_grid_set_style ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_image_grid_set_style</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_grid_set_style (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="GimpGridStyle">GimpGridStyle</link> style);</programlisting>
|
|
<para>
|
|
Sets the style unit of an image's grid.
|
|
</para>
|
|
<para>
|
|
This procedure sets the style of an image's grid. It takes the image
|
|
and the new style as parameters.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>style</parameter> :</term>
|
|
<listitem><simpara> The image's grid style.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|