202 lines
9.5 KiB
XML
202 lines
9.5 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-gimpguides">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page">gimpguides</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpguides</refname>
|
|
<refpurpose>Functions for manipulating guides.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-image-add-hguide">gimp_image_add_hguide</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint">gint</link> yposition);
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-image-add-vguide">gimp_image_add_vguide</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint">gint</link> xposition);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-delete-guide">gimp_image_delete_guide</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> guide_ID);
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-image-find-next-guide">gimp_image_find_next_guide</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> guide_ID);
|
|
<link linkend="GimpOrientationType">GimpOrientationType</link> <link linkend="gimp-image-get-guide-orientation">gimp_image_get_guide_orientation</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> guide_ID);
|
|
<link linkend="gint">gint</link> <link linkend="gimp-image-get-guide-position">gimp_image_get_guide_position</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> guide_ID);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
Functions for manipulating guides.
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-add-hguide" role="function"/>gimp_image_add_hguide ()</title>
|
|
<indexterm><primary>gimp_image_add_hguide</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_image_add_hguide (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint">gint</link> yposition);</programlisting>
|
|
<para>
|
|
Add a horizontal guide to an image.
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>yposition</parameter> :</term>
|
|
<listitem><simpara> The guide's y-offset from top of image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new guide.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-add-vguide" role="function"/>gimp_image_add_vguide ()</title>
|
|
<indexterm><primary>gimp_image_add_vguide</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_image_add_vguide (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint">gint</link> xposition);</programlisting>
|
|
<para>
|
|
Add a vertical guide to an image.
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>xposition</parameter> :</term>
|
|
<listitem><simpara> The guide's x-offset from left of image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new guide.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-delete-guide" role="function"/>gimp_image_delete_guide ()</title>
|
|
<indexterm><primary>gimp_image_delete_guide</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_delete_guide (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> guide_ID);</programlisting>
|
|
<para>
|
|
Deletes a guide from an image.
|
|
</para>
|
|
<para>
|
|
This procedure takes an image and a guide ID as input and removes
|
|
the specified guide from the specified image.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>guide_ID</parameter> :</term>
|
|
<listitem><simpara> The ID of the guide to be removed.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-find-next-guide" role="function"/>gimp_image_find_next_guide ()</title>
|
|
<indexterm><primary>gimp_image_find_next_guide</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_image_find_next_guide (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> guide_ID);</programlisting>
|
|
<para>
|
|
Find next guide on an image.
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>guide_ID</parameter> :</term>
|
|
<listitem><simpara> The ID of the current guide (0 if first invocation).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The next guide's ID.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-get-guide-orientation" role="function"/>gimp_image_get_guide_orientation ()</title>
|
|
<indexterm><primary>gimp_image_get_guide_orientation</primary></indexterm><programlisting><link linkend="GimpOrientationType">GimpOrientationType</link> gimp_image_get_guide_orientation (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> guide_ID);</programlisting>
|
|
<para>
|
|
Get orientation of a guide on an image.
|
|
</para>
|
|
<para>
|
|
This procedure takes an image and a guide ID as input and returns
|
|
the orientations of the guide.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>guide_ID</parameter> :</term>
|
|
<listitem><simpara> The guide.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The guide's orientation.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-get-guide-position" role="function"/>gimp_image_get_guide_position ()</title>
|
|
<indexterm><primary>gimp_image_get_guide_position</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_image_get_guide_position (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> guide_ID);</programlisting>
|
|
<para>
|
|
Get position of a guide on an image.
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>guide_ID</parameter> :</term>
|
|
<listitem><simpara> The guide.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The guide's position relative to top or left of image.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|