1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
<?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>
|
