← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimppageselector.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimppageselector.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="GimpPageSelector">
 
6
<refmeta>
 
7
<refentrytitle role="top_of_page">GimpPageSelector</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpPageSelector</refname>
 
14
<refpurpose></refpurpose>
 
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
16
</refnamediv>
 
17
 
 
18
<refsynopsisdiv role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
 
20
 
 
21
<synopsis>
 
22
 
 
23
 
 
24
 
 
25
                    <link linkend="GimpPageSelector-struct">GimpPageSelector</link>;
 
26
enum                <link linkend="GimpPageSelectorTarget">GimpPageSelectorTarget</link>;
 
27
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-page-selector-new">gimp_page_selector_new</link>              (void);
 
28
<link linkend="void">void</link>                <link linkend="gimp-page-selector-set-n-pages">gimp_page_selector_set_n_pages</link>      (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
29
                                                         <link linkend="gint">gint</link> n_pages);
 
30
<link linkend="gint">gint</link>                <link linkend="gimp-page-selector-get-n-pages">gimp_page_selector_get_n_pages</link>      (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);
 
31
<link linkend="void">void</link>                <link linkend="gimp-page-selector-set-target">gimp_page_selector_set_target</link>       (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
32
                                                         <link linkend="GimpPageSelectorTarget">GimpPageSelectorTarget</link> target);
 
33
<link linkend="GimpPageSelectorTarget">GimpPageSelectorTarget</link> <link linkend="gimp-page-selector-get-target">gimp_page_selector_get_target</link>    (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);
 
34
<link linkend="void">void</link>                <link linkend="gimp-page-selector-set-page-thumbnail">gimp_page_selector_set_page_thumbnail</link>
 
35
                                                        (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
36
                                                         <link linkend="gint">gint</link> page_no,
 
37
                                                         <link linkend="GdkPixbuf">GdkPixbuf</link> *thumbnail);
 
38
<link linkend="GdkPixbuf">GdkPixbuf</link>*          <link linkend="gimp-page-selector-get-page-thumbnail">gimp_page_selector_get_page_thumbnail</link>
 
39
                                                        (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
40
                                                         <link linkend="gint">gint</link> page_no);
 
41
<link linkend="void">void</link>                <link linkend="gimp-page-selector-set-page-label">gimp_page_selector_set_page_label</link>   (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
42
                                                         <link linkend="gint">gint</link> page_no,
 
43
                                                         const <link linkend="gchar">gchar</link> *label);
 
44
<link linkend="gchar">gchar</link>*              <link linkend="gimp-page-selector-get-page-label">gimp_page_selector_get_page_label</link>   (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
45
                                                         <link linkend="gint">gint</link> page_no);
 
46
<link linkend="void">void</link>                <link linkend="gimp-page-selector-select-all">gimp_page_selector_select_all</link>       (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);
 
47
<link linkend="void">void</link>                <link linkend="gimp-page-selector-unselect-all">gimp_page_selector_unselect_all</link>     (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);
 
48
<link linkend="void">void</link>                <link linkend="gimp-page-selector-select-page">gimp_page_selector_select_page</link>      (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
49
                                                         <link linkend="gint">gint</link> page_no);
 
50
<link linkend="void">void</link>                <link linkend="gimp-page-selector-unselect-page">gimp_page_selector_unselect_page</link>    (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
51
                                                         <link linkend="gint">gint</link> page_no);
 
52
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-page-selector-page-is-selected">gimp_page_selector_page_is_selected</link> (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
53
                                                         <link linkend="gint">gint</link> page_no);
 
54
<link linkend="gint">gint</link>*               <link linkend="gimp-page-selector-get-selected-pages">gimp_page_selector_get_selected_pages</link>
 
55
                                                        (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
56
                                                         <link linkend="gint">gint</link> *n_selected_pages);
 
57
<link linkend="void">void</link>                <link linkend="gimp-page-selector-select-range">gimp_page_selector_select_range</link>     (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
58
                                                         const <link linkend="gchar">gchar</link> *range);
 
59
<link linkend="gchar">gchar</link>*              <link linkend="gimp-page-selector-get-selected-range">gimp_page_selector_get_selected_range</link>
 
60
                                                        (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);
 
61
 
 
62
</synopsis>
 
63
</refsynopsisdiv>
 
64
 
 
65
<refsect1 role="object_hierarchy">
 
66
<title role="object_hierarchy.title">Object Hierarchy</title>
 
67
<synopsis>
 
68
 
 
69
  <link linkend="GObject">GObject</link>
 
70
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
71
         +----<link linkend="GtkObject">GtkObject</link>
 
72
               +----<link linkend="GtkWidget">GtkWidget</link>
 
73
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
74
                           +----<link linkend="GtkBox">GtkBox</link>
 
75
                                 +----<link linkend="GtkVBox">GtkVBox</link>
 
76
                                       +----GimpPageSelector
 
77
</synopsis>
 
78
 
 
79
</refsect1>
 
80
 
 
81
 
 
82
 
 
83
<refsect1 role="impl_interfaces">
 
84
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
85
<para>
 
86
GimpPageSelector implements
 
87
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
88
 
 
89
</refsect1>
 
90
 
 
91
 
 
92
<refsect1 role="properties">
 
93
<title role="properties.title">Properties</title>
 
94
<synopsis>
 
95
 
 
96
  &quot;<link linkend="GimpPageSelector--n-pages">n-pages</link>&quot;                  <link linkend="gint">gint</link>                  : Read / Write
 
97
  &quot;<link linkend="GimpPageSelector--target">target</link>&quot;                   <link linkend="GimpPageSelectorTarget">GimpPageSelectorTarget</link>  : Read / Write
 
98
</synopsis>
 
99
</refsect1>
 
100
 
 
101
<refsect1 role="signal_proto">
 
102
<title role="signal_proto.title">Signals</title>
 
103
<synopsis>
 
104
 
 
105
  &quot;<link linkend="GimpPageSelector-activate">activate</link>&quot;                                       : Run First / Action
 
106
  &quot;<link linkend="GimpPageSelector-selection-changed">selection-changed</link>&quot;                              : Run First
 
107
</synopsis>
 
108
</refsect1>
 
109
 
 
110
 
 
111
<refsect1 role="desc">
 
112
<title role="desc.title">Description</title>
 
113
<para>
 
114
 
 
115
</para>
 
116
</refsect1>
 
117
 
 
118
<refsect1 role="details">
 
119
<title role="details.title">Details</title>
 
120
<refsect2>
 
121
<title><anchor id="GimpPageSelector-struct" role="struct"/>GimpPageSelector</title>
 
122
<indexterm><primary>GimpPageSelector</primary></indexterm><programlisting>typedef struct _GimpPageSelector GimpPageSelector;</programlisting>
 
123
<para>
 
124
 
 
125
</para></refsect2>
 
126
<refsect2>
 
127
<title><anchor id="GimpPageSelectorTarget" role="enum"/>enum GimpPageSelectorTarget</title>
 
128
<indexterm><primary>GimpPageSelectorTarget</primary></indexterm><programlisting>typedef enum
 
129
{
 
130
  GIMP_PAGE_SELECTOR_TARGET_LAYERS, /*&lt; desc="Layers" &gt;*/
 
131
  GIMP_PAGE_SELECTOR_TARGET_IMAGES  /*&lt; desc="Images" &gt;*/
 
132
} GimpPageSelectorTarget;
 
133
</programlisting>
 
134
<para>
 
135
 
 
136
</para></refsect2>
 
137
<refsect2>
 
138
<title><anchor id="gimp-page-selector-new" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_new ()</title>
 
139
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_page_selector_new              (void);</programlisting>
 
140
<para>
 
141
Creates a new <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link> widget.</para>
 
142
<para>
 
143
 
 
144
</para><variablelist role="params">
 
145
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Pointer to the new <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link> widget.
 
146
 
 
147
</simpara></listitem></varlistentry>
 
148
</variablelist><para role="since">Since  GIMP 2.4
 
149
</para></refsect2>
 
150
<refsect2>
 
151
<title><anchor id="gimp-page-selector-set-n-pages" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_set_n_pages ()</title>
 
152
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_set_n_pages</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_page_selector_set_n_pages      (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
153
                                                         <link linkend="gint">gint</link> n_pages);</programlisting>
 
154
<para>
 
155
Sets the number of pages in the document to open.</para>
 
156
<para>
 
157
 
 
158
</para><variablelist role="params">
 
159
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
160
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
161
</simpara></listitem></varlistentry>
 
162
<varlistentry><term><parameter>n_pages</parameter>&nbsp;:</term>
 
163
<listitem><simpara>  The number of pages.
 
164
</simpara></listitem></varlistentry>
 
165
</variablelist><para role="since">Since  GIMP 2.4
 
166
</para></refsect2>
 
167
<refsect2>
 
168
<title><anchor id="gimp-page-selector-get-n-pages" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_get_n_pages ()</title>
 
169
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_get_n_pages</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_page_selector_get_n_pages      (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);</programlisting>
 
170
<para>
 
171
</para>
 
172
<para>
 
173
 
 
174
</para><variablelist role="params">
 
175
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
176
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
177
</simpara></listitem></varlistentry>
 
178
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the number of pages in the document to open.
 
179
 
 
180
</simpara></listitem></varlistentry>
 
181
</variablelist><para role="since">Since  GIMP 2.4
 
182
</para></refsect2>
 
183
<refsect2>
 
184
<title><anchor id="gimp-page-selector-set-target" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_set_target ()</title>
 
185
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_set_target</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_page_selector_set_target       (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
186
                                                         <link linkend="GimpPageSelectorTarget">GimpPageSelectorTarget</link> target);</programlisting>
 
187
<para>
 
188
</para>
 
189
<para>
 
190
 
 
191
</para><variablelist role="params">
 
192
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
193
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
194
</simpara></listitem></varlistentry>
 
195
<varlistentry><term><parameter>target</parameter>&nbsp;:</term>
 
196
<listitem><simpara>   How to open the selected pages.
 
197
</simpara></listitem></varlistentry>
 
198
</variablelist><para role="since">Since  GIMP 2.4
 
199
</para></refsect2>
 
200
<refsect2>
 
201
<title><anchor id="gimp-page-selector-get-target" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_get_target ()</title>
 
202
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_get_target</primary></indexterm><programlisting><link linkend="GimpPageSelectorTarget">GimpPageSelectorTarget</link> gimp_page_selector_get_target    (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);</programlisting>
 
203
<para>
 
204
</para>
 
205
<para>
 
206
 
 
207
</para><variablelist role="params">
 
208
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
209
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
210
</simpara></listitem></varlistentry>
 
211
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> How the selected pages should be opened.
 
212
 
 
213
</simpara></listitem></varlistentry>
 
214
</variablelist><para role="since">Since  GIMP 2.4
 
215
</para></refsect2>
 
216
<refsect2>
 
217
<title><anchor id="gimp-page-selector-set-page-thumbnail" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_set_page_thumbnail ()</title>
 
218
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_set_page_thumbnail</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_page_selector_set_page_thumbnail
 
219
                                                        (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
220
                                                         <link linkend="gint">gint</link> page_no,
 
221
                                                         <link linkend="GdkPixbuf">GdkPixbuf</link> *thumbnail);</programlisting>
 
222
<para>
 
223
Sets the thumbnail for given <link linkend="page-no"><literal>page_no</literal></link>. A default "page" icon will
 
224
be used if no page thumbnail is set.</para>
 
225
<para>
 
226
 
 
227
</para><variablelist role="params">
 
228
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
229
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
230
</simpara></listitem></varlistentry>
 
231
<varlistentry><term><parameter>page_no</parameter>&nbsp;:</term>
 
232
<listitem><simpara> The number of the page to set the thumbnail for.
 
233
</simpara></listitem></varlistentry>
 
234
<varlistentry><term><parameter>thumbnail</parameter>&nbsp;:</term>
 
235
<listitem><simpara> The thumbnail pixbuf.
 
236
</simpara></listitem></varlistentry>
 
237
</variablelist><para role="since">Since  GIMP 2.4
 
238
</para></refsect2>
 
239
<refsect2>
 
240
<title><anchor id="gimp-page-selector-get-page-thumbnail" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_get_page_thumbnail ()</title>
 
241
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_get_page_thumbnail</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>*          gimp_page_selector_get_page_thumbnail
 
242
                                                        (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
243
                                                         <link linkend="gint">gint</link> page_no);</programlisting>
 
244
<para>
 
245
</para>
 
246
<para>
 
247
 
 
248
</para><variablelist role="params">
 
249
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
250
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
251
</simpara></listitem></varlistentry>
 
252
<varlistentry><term><parameter>page_no</parameter>&nbsp;:</term>
 
253
<listitem><simpara> The number of the page to get the thumbnail for.
 
254
</simpara></listitem></varlistentry>
 
255
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The page's thumbnail, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none is set. The returned
 
256
         pixbuf is owned by <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link> and must not be
 
257
         unref'ed when no longer needed.
 
258
 
 
259
</simpara></listitem></varlistentry>
 
260
</variablelist><para role="since">Since  GIMP 2.4
 
261
</para></refsect2>
 
262
<refsect2>
 
263
<title><anchor id="gimp-page-selector-set-page-label" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_set_page_label ()</title>
 
264
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_set_page_label</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_page_selector_set_page_label   (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
265
                                                         <link linkend="gint">gint</link> page_no,
 
266
                                                         const <link linkend="gchar">gchar</link> *label);</programlisting>
 
267
<para>
 
268
</para>
 
269
<para>
 
270
 
 
271
</para><variablelist role="params">
 
272
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
273
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
274
</simpara></listitem></varlistentry>
 
275
<varlistentry><term><parameter>page_no</parameter>&nbsp;:</term>
 
276
<listitem><simpara> The number of the page to set the label for.
 
277
</simpara></listitem></varlistentry>
 
278
<varlistentry><term><parameter>label</parameter>&nbsp;:</term>
 
279
<listitem><simpara> The label.
 
280
</simpara></listitem></varlistentry>
 
281
</variablelist><para role="since">Since  GIMP 2.4
 
282
</para></refsect2>
 
283
<refsect2>
 
284
<title><anchor id="gimp-page-selector-get-page-label" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_get_page_label ()</title>
 
285
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_get_page_label</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_page_selector_get_page_label   (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
286
                                                         <link linkend="gint">gint</link> page_no);</programlisting>
 
287
<para>
 
288
</para>
 
289
<para>
 
290
 
 
291
</para><variablelist role="params">
 
292
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
293
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
294
</simpara></listitem></varlistentry>
 
295
<varlistentry><term><parameter>page_no</parameter>&nbsp;:</term>
 
296
<listitem><simpara> The number of the page to get the thumbnail for.
 
297
</simpara></listitem></varlistentry>
 
298
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The page's label, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none is set. This is a newly
 
299
         allocated string that should be <link linkend="g-free"><function>g_free()</function></link>'d when no longer
 
300
         needed.
 
301
 
 
302
</simpara></listitem></varlistentry>
 
303
</variablelist><para role="since">Since  GIMP 2.4
 
304
</para></refsect2>
 
305
<refsect2>
 
306
<title><anchor id="gimp-page-selector-select-all" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_select_all ()</title>
 
307
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_select_all</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_page_selector_select_all       (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);</programlisting>
 
308
<para>
 
309
Selects all pages.</para>
 
310
<para>
 
311
 
 
312
</para><variablelist role="params">
 
313
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
314
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
315
</simpara></listitem></varlistentry>
 
316
</variablelist><para role="since">Since  GIMP 2.4
 
317
</para></refsect2>
 
318
<refsect2>
 
319
<title><anchor id="gimp-page-selector-unselect-all" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_unselect_all ()</title>
 
320
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_unselect_all</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_page_selector_unselect_all     (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);</programlisting>
 
321
<para>
 
322
Unselects all pages.</para>
 
323
<para>
 
324
 
 
325
</para><variablelist role="params">
 
326
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
327
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
328
</simpara></listitem></varlistentry>
 
329
</variablelist><para role="since">Since  GIMP 2.4
 
330
</para></refsect2>
 
331
<refsect2>
 
332
<title><anchor id="gimp-page-selector-select-page" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_select_page ()</title>
 
333
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_select_page</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_page_selector_select_page      (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
334
                                                         <link linkend="gint">gint</link> page_no);</programlisting>
 
335
<para>
 
336
Adds a page to the selection.</para>
 
337
<para>
 
338
 
 
339
</para><variablelist role="params">
 
340
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
341
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
342
</simpara></listitem></varlistentry>
 
343
<varlistentry><term><parameter>page_no</parameter>&nbsp;:</term>
 
344
<listitem><simpara> The number of the page to select.
 
345
</simpara></listitem></varlistentry>
 
346
</variablelist><para role="since">Since  GIMP 2.4
 
347
</para></refsect2>
 
348
<refsect2>
 
349
<title><anchor id="gimp-page-selector-unselect-page" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_unselect_page ()</title>
 
350
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_unselect_page</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_page_selector_unselect_page    (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
351
                                                         <link linkend="gint">gint</link> page_no);</programlisting>
 
352
<para>
 
353
Removes a page from the selection.</para>
 
354
<para>
 
355
 
 
356
</para><variablelist role="params">
 
357
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
358
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
359
</simpara></listitem></varlistentry>
 
360
<varlistentry><term><parameter>page_no</parameter>&nbsp;:</term>
 
361
<listitem><simpara> The number of the page to unselect.
 
362
</simpara></listitem></varlistentry>
 
363
</variablelist><para role="since">Since  GIMP 2.4
 
364
</para></refsect2>
 
365
<refsect2>
 
366
<title><anchor id="gimp-page-selector-page-is-selected" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_page_is_selected ()</title>
 
367
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_page_is_selected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_page_selector_page_is_selected (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
368
                                                         <link linkend="gint">gint</link> page_no);</programlisting>
 
369
<para>
 
370
</para>
 
371
<para>
 
372
 
 
373
</para><variablelist role="params">
 
374
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
375
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
376
</simpara></listitem></varlistentry>
 
377
<varlistentry><term><parameter>page_no</parameter>&nbsp;:</term>
 
378
<listitem><simpara> The number of the page to check.
 
379
</simpara></listitem></varlistentry>
 
380
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the page is selected, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
 
381
 
 
382
</simpara></listitem></varlistentry>
 
383
</variablelist><para role="since">Since  GIMP 2.4
 
384
</para></refsect2>
 
385
<refsect2>
 
386
<title><anchor id="gimp-page-selector-get-selected-pages" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_get_selected_pages ()</title>
 
387
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_get_selected_pages</primary></indexterm><programlisting><link linkend="gint">gint</link>*               gimp_page_selector_get_selected_pages
 
388
                                                        (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
389
                                                         <link linkend="gint">gint</link> *n_selected_pages);</programlisting>
 
390
<para>
 
391
</para>
 
392
<para>
 
393
 
 
394
</para><variablelist role="params">
 
395
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
396
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
397
</simpara></listitem></varlistentry>
 
398
<varlistentry><term><parameter>n_selected_pages</parameter>&nbsp;:</term>
 
399
<listitem><simpara> Returns the number of selected pages.
 
400
</simpara></listitem></varlistentry>
 
401
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An array of page numbers of selected pages. Use <link linkend="g-free"><function>g_free()</function></link> if
 
402
         you don't need the array any longer.
 
403
 
 
404
</simpara></listitem></varlistentry>
 
405
</variablelist><para role="since">Since  GIMP 2.4
 
406
</para></refsect2>
 
407
<refsect2>
 
408
<title><anchor id="gimp-page-selector-select-range" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_select_range ()</title>
 
409
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_select_range</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_page_selector_select_range     (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector,
 
410
                                                         const <link linkend="gchar">gchar</link> *range);</programlisting>
 
411
<para>
 
412
Selectes the pages described by <link linkend="range"><literal>range</literal></link>. The range string is a
 
413
user-editable list of pages and ranges, e.g. "1,3,5-7,9-12,14".
 
414
Note that the page numbering in the range string starts with 1,
 
415
not 0.
 
416
</para>
 
417
<para>
 
418
Invalid pages and ranges will be silently ignored, duplicate and
 
419
overlapping pages and ranges will be merged.</para>
 
420
<para>
 
421
 
 
422
</para><variablelist role="params">
 
423
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
424
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
425
</simpara></listitem></varlistentry>
 
426
<varlistentry><term><parameter>range</parameter>&nbsp;:</term>
 
427
<listitem><simpara> A string representing the set of selected pages.
 
428
</simpara></listitem></varlistentry>
 
429
</variablelist><para role="since">Since  GIMP 2.4
 
430
</para></refsect2>
 
431
<refsect2>
 
432
<title><anchor id="gimp-page-selector-get-selected-range" role="function" condition="since:GIMP 2.4"/>gimp_page_selector_get_selected_range ()</title>
 
433
<indexterm role="GIMP 2.4"><primary>gimp_page_selector_get_selected_range</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_page_selector_get_selected_range
 
434
                                                        (<link linkend="GimpPageSelector">GimpPageSelector</link> *selector);</programlisting>
 
435
<para>
 
436
</para>
 
437
<para>
 
438
 
 
439
</para><variablelist role="params">
 
440
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
 
441
<listitem><simpara> Pointer to a <link linkend="GimpPageSelector"><type>GimpPageSelector</type></link>.
 
442
</simpara></listitem></varlistentry>
 
443
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A newly allocated string representing the set of selected
 
444
         pages. See <link linkend="gimp-page-selector-set-selected-range"><function>gimp_page_selector_set_selected_range()</function></link> for the
 
445
         format of the string.
 
446
 
 
447
</simpara></listitem></varlistentry>
 
448
</variablelist><para role="since">Since  GIMP 2.4
 
449
</para></refsect2>
 
450
 
 
451
</refsect1>
 
452
<refsect1 role="property_details">
 
453
<title role="property_details.title">Property Details</title>
 
454
<refsect2><title><anchor id="GimpPageSelector--n-pages"/>The &quot;<literal>n-pages</literal>&quot; property</title>
 
455
<indexterm role="GIMP 2.4"><primary>GimpPageSelector:n-pages</primary></indexterm><programlisting>  &quot;n-pages&quot;                  <link linkend="gint">gint</link>                  : Read / Write</programlisting>
 
456
<para>
 
457
The number of pages of the document to open.</para>
 
458
<para>
 
459
 
 
460
</para><para>Allowed values: &gt;= 0</para>
 
461
<para>Default value: 0</para>
 
462
<para>Since  GIMP 2.4
 
463
</para>
 
464
</refsect2>
 
465
<refsect2><title><anchor id="GimpPageSelector--target"/>The &quot;<literal>target</literal>&quot; property</title>
 
466
<indexterm role="GIMP 2.4"><primary>GimpPageSelector:target</primary></indexterm><programlisting>  &quot;target&quot;                   <link linkend="GimpPageSelectorTarget">GimpPageSelectorTarget</link>  : Read / Write</programlisting>
 
467
<para>
 
468
The target to open the document to.</para>
 
469
<para>
 
470
 
 
471
</para><para>Default value: GIMP_PAGE_SELECTOR_TARGET_LAYERS</para>
 
472
<para>Since  GIMP 2.4
 
473
</para>
 
474
</refsect2>
 
475
 
 
476
</refsect1>
 
477
 
 
478
<refsect1 role="signals">
 
479
<title role="signals.title">Signal Details</title>
 
480
<refsect2><title><anchor id="GimpPageSelector-activate"/>The &quot;activate&quot; signal</title>
 
481
<indexterm role="GIMP 2.4"><primary>GimpPageSelector::activate</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpPageSelector">GimpPageSelector</link> *widget,
 
482
                                                        <link linkend="gpointer">gpointer</link>          user_data)      : Run First / Action</programlisting>
 
483
<para>
 
484
The "activate" signal on GimpPageSelector is an action signal. It
 
485
is emitted when a user double-clicks an item in the page selection.</para>
 
486
<para>
 
487
 
 
488
</para><variablelist role="params">
 
489
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
490
<listitem><simpara> the object which received the signal.
 
491
</simpara></listitem></varlistentry>
 
492
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
493
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
494
</variablelist><para>Since  GIMP 2.4
 
495
</para></refsect2><refsect2><title><anchor id="GimpPageSelector-selection-changed"/>The &quot;selection-changed&quot; signal</title>
 
496
<indexterm role="GIMP 2.4"><primary>GimpPageSelector::selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpPageSelector">GimpPageSelector</link> *widget,
 
497
                                                        <link linkend="gpointer">gpointer</link>          user_data)      : Run First</programlisting>
 
498
<para>
 
499
This signal is emitted whenever the set of selected pages changes.</para>
 
500
<para>
 
501
 
 
502
</para><variablelist role="params">
 
503
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
504
<listitem><simpara> the object which received the signal.
 
505
</simpara></listitem></varlistentry>
 
506
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
507
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
508
</variablelist><para>Since  GIMP 2.4
 
509
</para></refsect2>
 
510
</refsect1>
 
511
 
 
512
 
 
513
 
 
514
</refentry>