← Back to branch summary

~ubuntu-branches/ubuntu/hoary/gimp/hoary

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpguides.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-04-04 14:51:23 UTC
  • Revision ID: james.westby@ubuntu.com-20050404145123-9py049eeelfymur8
Tags: upstream-2.2.2
Import upstream version 2.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpguides.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="libgimp-gimpguides">
 
6
<refmeta>
 
7
<refentrytitle>gimpguides</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>gimpguides</refname><refpurpose>Functions for manipulating guides.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
<link linkend="gint32">gint32</link>      <link linkend="gimp-image-add-hguide">gimp_image_add_hguide</link>           (<link linkend="gint32">gint32</link> image_ID,
 
23
                                             <link linkend="gint">gint</link> yposition);
 
24
<link linkend="gint32">gint32</link>      <link linkend="gimp-image-add-vguide">gimp_image_add_vguide</link>           (<link linkend="gint32">gint32</link> image_ID,
 
25
                                             <link linkend="gint">gint</link> xposition);
 
26
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-image-delete-guide">gimp_image_delete_guide</link>         (<link linkend="gint32">gint32</link> image_ID,
 
27
                                             <link linkend="gint32">gint32</link> guide_ID);
 
28
<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,
 
29
                                             <link linkend="gint32">gint32</link> guide_ID);
 
30
<link linkend="GimpOrientationType">GimpOrientationType</link> <link linkend="gimp-image-get-guide-orientation">gimp_image_get_guide_orientation</link>
 
31
                                            (<link linkend="gint32">gint32</link> image_ID,
 
32
                                             <link linkend="gint32">gint32</link> guide_ID);
 
33
<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,
 
34
                                             <link linkend="gint32">gint32</link> guide_ID);
 
35
</synopsis>
 
36
</refsynopsisdiv>
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
<refsect1>
 
47
<title>Description</title>
 
48
<para>
 
49
Functions for manipulating guides.
 
50
 
 
51
</para>
 
52
</refsect1>
 
53
 
 
54
<refsect1>
 
55
<title>Details</title>
 
56
<refsect2>
 
57
<title><anchor id="gimp-image-add-hguide"/>gimp_image_add_hguide ()</title>
 
58
<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,
 
59
                                             <link linkend="gint">gint</link> yposition);</programlisting>
 
60
<para>
 
61
Add a horizontal guide to an image.
 
62
</para>
 
63
<para>
 
64
This procedure adds a horizontal guide to an image. It takes the
 
65
input image and the y-position of the new guide as parameters. It
 
66
returns the guide ID of the new guide.</para>
 
67
<para>
 
68
 
 
69
</para><variablelist role="params">
 
70
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
 
71
<listitem><simpara> The image.
 
72
</simpara></listitem></varlistentry>
 
73
<varlistentry><term><parameter>yposition</parameter>&nbsp;:</term>
 
74
<listitem><simpara> The guide's y-offset from top of image.
 
75
</simpara></listitem></varlistentry>
 
76
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new guide.
 
77
</simpara></listitem></varlistentry>
 
78
</variablelist></refsect2>
 
79
<refsect2>
 
80
<title><anchor id="gimp-image-add-vguide"/>gimp_image_add_vguide ()</title>
 
81
<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,
 
82
                                             <link linkend="gint">gint</link> xposition);</programlisting>
 
83
<para>
 
84
Add a vertical guide to an image.
 
85
</para>
 
86
<para>
 
87
This procedure adds a vertical guide to an image. It takes the input
 
88
image and the x-position of the new guide as parameters. It returns
 
89
the guide ID of the new guide.</para>
 
90
<para>
 
91
 
 
92
</para><variablelist role="params">
 
93
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
 
94
<listitem><simpara> The image.
 
95
</simpara></listitem></varlistentry>
 
96
<varlistentry><term><parameter>xposition</parameter>&nbsp;:</term>
 
97
<listitem><simpara> The guide's x-offset from left of image.
 
98
</simpara></listitem></varlistentry>
 
99
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new guide.
 
100
</simpara></listitem></varlistentry>
 
101
</variablelist></refsect2>
 
102
<refsect2>
 
103
<title><anchor id="gimp-image-delete-guide"/>gimp_image_delete_guide ()</title>
 
104
<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,
 
105
                                             <link linkend="gint32">gint32</link> guide_ID);</programlisting>
 
106
<para>
 
107
Deletes a guide from an image.
 
108
</para>
 
109
<para>
 
110
This procedure takes an image and a guide ID as input and removes
 
111
the specified guide from the specified image.</para>
 
112
<para>
 
113
 
 
114
</para><variablelist role="params">
 
115
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
 
116
<listitem><simpara> The image.
 
117
</simpara></listitem></varlistentry>
 
118
<varlistentry><term><parameter>guide_ID</parameter>&nbsp;:</term>
 
119
<listitem><simpara> The ID of the guide to be removed.
 
120
</simpara></listitem></varlistentry>
 
121
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
 
122
</simpara></listitem></varlistentry>
 
123
</variablelist></refsect2>
 
124
<refsect2>
 
125
<title><anchor id="gimp-image-find-next-guide"/>gimp_image_find_next_guide ()</title>
 
126
<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,
 
127
                                             <link linkend="gint32">gint32</link> guide_ID);</programlisting>
 
128
<para>
 
129
Find next guide on an image.
 
130
</para>
 
131
<para>
 
132
This procedure takes an image and a guide ID as input and finds the
 
133
guide ID of the successor of the given guide ID in the image's guide
 
134
list. If the supplied guide ID is 0, the procedure will return the
 
135
first Guide. The procedure will return 0 if given the final guide ID
 
136
as an argument or the image has no guides.</para>
 
137
<para>
 
138
 
 
139
</para><variablelist role="params">
 
140
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
 
141
<listitem><simpara> The image.
 
142
</simpara></listitem></varlistentry>
 
143
<varlistentry><term><parameter>guide_ID</parameter>&nbsp;:</term>
 
144
<listitem><simpara> The ID of the current guide (0 if first invocation).
 
145
</simpara></listitem></varlistentry>
 
146
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The next guide's ID.
 
147
</simpara></listitem></varlistentry>
 
148
</variablelist></refsect2>
 
149
<refsect2>
 
150
<title><anchor id="gimp-image-get-guide-orientation"/>gimp_image_get_guide_orientation ()</title>
 
151
<indexterm><primary>gimp_image_get_guide_orientation</primary></indexterm><programlisting><link linkend="GimpOrientationType">GimpOrientationType</link> gimp_image_get_guide_orientation
 
152
                                            (<link linkend="gint32">gint32</link> image_ID,
 
153
                                             <link linkend="gint32">gint32</link> guide_ID);</programlisting>
 
154
<para>
 
155
Get orientation of a guide on an image.
 
156
</para>
 
157
<para>
 
158
This procedure takes an image and a guide ID as input and returns
 
159
the orientations of the guide.</para>
 
160
<para>
 
161
 
 
162
</para><variablelist role="params">
 
163
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
 
164
<listitem><simpara> The image.
 
165
</simpara></listitem></varlistentry>
 
166
<varlistentry><term><parameter>guide_ID</parameter>&nbsp;:</term>
 
167
<listitem><simpara> The guide.
 
168
</simpara></listitem></varlistentry>
 
169
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The guide's orientation.
 
170
</simpara></listitem></varlistentry>
 
171
</variablelist></refsect2>
 
172
<refsect2>
 
173
<title><anchor id="gimp-image-get-guide-position"/>gimp_image_get_guide_position ()</title>
 
174
<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,
 
175
                                             <link linkend="gint32">gint32</link> guide_ID);</programlisting>
 
176
<para>
 
177
Get position of a guide on an image.
 
178
</para>
 
179
<para>
 
180
This procedure takes an image and a guide ID as input and returns
 
181
the position of the guide relative to the top or left of the image.</para>
 
182
<para>
 
183
 
 
184
</para><variablelist role="params">
 
185
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
 
186
<listitem><simpara> The image.
 
187
</simpara></listitem></varlistentry>
 
188
<varlistentry><term><parameter>guide_ID</parameter>&nbsp;:</term>
 
189
<listitem><simpara> The guide.
 
190
</simpara></listitem></varlistentry>
 
191
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The guide's position relative to top or left of image.
 
192
</simpara></listitem></varlistentry>
 
193
</variablelist></refsect2>
 
194
 
 
195
</refsect1>
 
196
 
 
197
 
 
198
 
 
199
 
 
200
</refentry>