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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
|
<?xml version="1.0" standalone="no"?>
<!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="class-gnomeprintuidialog">
<refnamediv>
<refname>gnomeprint.ui.Dialog</refname>
<refpurpose>Dialog object for GnomePrintui</refpurpose>
</refnamediv>
<!-- ************************************ -->
<!-- BEGIN OF GNOMEPRINTUIDIALOG SYNOPSIS -->
<!-- ************************************ -->
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gnomeprint.ui.Dialog</classname></ooclass>
<ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gnomeprintuidialog">gnomeprint.ui.Dialog</link></methodname>
<methodparam><parameter role="keyword">job</parameter></methodparam>
<methodparam><parameter role="keyword">title</parameter></methodparam>
<methodparam><parameter role="keyword">flags</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintuidialog--construct-range-any">construct_range_any</link></methodname>
<methodparam><parameter role="keyword">flags</parameter></methodparam>
<methodparam><parameter role="keyword">range_widget</parameter></methodparam>
<methodparam><parameter role="keyword">currentlabel</parameter></methodparam>
<methodparam><parameter role="keyword">rangelabel</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintuidialog--construct-range-custom">construct_range_custom</link></methodname>
<methodparam><parameter role="keyword">custom</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintuidialog--construct-range-page">construct_range_page</link></methodname>
<methodparam><parameter role="keyword">flags</parameter></methodparam>
<methodparam><parameter role="keyword">start</parameter></methodparam>
<methodparam><parameter role="keyword">end</parameter></methodparam>
<methodparam><parameter role="keyword">currentlabel</parameter></methodparam>
<methodparam><parameter role="keyword">rangelabel</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintuidialog--get-config">get_config</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintuidialog--get-copies">get_copies</link></methodname>
<methodparam><parameter role="keyword">copies</parameter></methodparam>
<methodparam><parameter role="keyword">collate</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintuidialog--get-range">get_range</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintuidialog--get-range-page">get_range_page</link></methodname>
<methodparam><parameter role="keyword">start</parameter></methodparam>
<methodparam><parameter role="keyword">end</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintuidialog--set-copies">set_copies</link></methodname>
<methodparam><parameter role="keyword">copies</parameter></methodparam>
<methodparam><parameter role="keyword">collate</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<!-- ************************************ -->
<!-- BEGIN OF GNOMEPRINTUIDIALOG ANCESTRY -->
<!-- ************************************ -->
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkbin">gtk.Bin</link>
+-- <link linkend="class-gtkwindow">gtk.Window</link>
+-- <link linkend="class-gtkdialog">gtk.Dialog</link>
+-- <link linkend="class-gnomeprintuidialog">gnomeprint.ui.Dialog</link>
</synopsis>
</refsect1>
<!-- ************************************** -->
<!-- BEGIN OF GNOMEPRINTUIDIALOG PROPERTIES -->
<!-- ************************************** -->
<refsect1>
<title>Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"print-config"</entry>
<entry>Read-Write</entry>
<entry>The printing configuration to be used.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<!-- *************************************** -->
<!-- BEGIN OF GNOMEPRINTUIDIALOG DESCRIPTION -->
<!-- *************************************** -->
<refsect1 id="description-gnomeprintuidialog">
<title>Description</title>
<para>
</para>
</refsect1>
<!-- *************************************** -->
<!-- BEGIN OF GNOMEPRINTUIDIALOG CONSTRUCTOR -->
<!-- *************************************** -->
<refsect1 id="constructor-gnomeprintuidialog">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gnomeprint.ui.Dialog</methodname>
<methodparam><parameter role="keyword">job</parameter></methodparam>
<methodparam><parameter role="keyword">title</parameter></methodparam>
<methodparam><parameter role="keyword">flags</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">job</parameter> :</term>
<listitem><simpara> a <link linkend="class-gnomeprintjob"><classname>gnomeprint.Job</classname></link>.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">title</parameter> :</term>
<listitem><simpara> title of the window.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">flags</parameter> :</term>
<listitem><simpara> options for created widget.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link linkend="class-gnomeprintuidialog"><classname>gnomeprint.ui.Dialog</classname></link>.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new <link linkend="class-gnomeprintuidialog"><classname>gnomeprint.ui.Dialog</classname></link> object, the following options flags
are available: gnomeprint.DIALOG_RANGE: A range widget container will be created. A range widget must be created separately,
using the constructor. gnomeprint.DIALOG_COPIES: A copies widget will be created.
</para>
</refsect1>
<!-- *********************************** -->
<!-- BEGIN OF GNOMEPRINTUIDIALOG METHODS -->
<!-- *********************************** -->
<refsect1>
<title>Methods</title>
<refsect2 id="method-gnomeprintuidialog--construct-range-any">
<title>gnomeprint.ui.Dialog.construct_range_any</title>
<programlisting><methodsynopsis language="python">
<methodname>construct_range_any</methodname>
<methodparam><parameter role="keyword">flags</parameter></methodparam>
<methodparam><parameter role="keyword">range_widget</parameter></methodparam>
<methodparam><parameter role="keyword">currentlabel</parameter></methodparam>
<methodparam><parameter role="keyword">rangelabel</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">flags</parameter> :</term>
<listitem><simpara> Options flags, which ranges are displayed.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">range_widget</parameter> :</term>
<listitem><simpara> Widget to display for the range option.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">currentlabel</parameter> :</term>
<listitem><simpara> Label to display next to the 'current page' button.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">rangelabel</parameter> :</term>
<listitem><simpara> Label to display next to the 'range' button.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>construct_range_any</methodname>() method create a generic range area within the print range dialogue.
The flags field contains a mask of which options you wish displayed: gnomeprint.RANGE_CURRENT: A label currentlabel will
be displayed. gnomeprint.RANGE_ALL: A label "All" will be displayed. gnomeprint.RANGE_RANGE: A label rangelabel will be displayed,
next to the range specification widget range_widget. gnomeprint.RANGE_SELECTION: A label "Selection" will be displayed.
</para>
</refsect2>
<refsect2 id="method-gnomeprintuidialog--construct-range-custom">
<title>gnomeprint.ui.Dialog.construct_range_custom</title>
<programlisting><methodsynopsis language="python">
<methodname>construct_range_custom</methodname>
<methodparam><parameter role="keyword">custom</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">custom</parameter> :</term>
<listitem><simpara> A widget which will be placed in a "Range" frame in the main display.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>construct_range_custom</methodname>() method install a custom range specification widget.
</para>
</refsect2>
<refsect2 id="method-gnomeprintuidialog--construct-range-page">
<title>gnomeprint.ui.Dialog.construct_range_page</title>
<programlisting><methodsynopsis language="python">
<methodname>construct_range_page</methodname>
<methodparam><parameter role="keyword">flags</parameter></methodparam>
<methodparam><parameter role="keyword">start</parameter></methodparam>
<methodparam><parameter role="keyword">end</parameter></methodparam>
<methodparam><parameter role="keyword">currentlabel</parameter></methodparam>
<methodparam><parameter role="keyword">rangelabel</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">flags</parameter> :</term>
<listitem><simpara> Options flags, see
<methodname><link linkend="method-gnomeprintuidialog--construct-range-any">construct_range_any</link></methodname>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">start</parameter> :</term>
<listitem><simpara> First page which may be printed.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">end</parameter> :</term>
<listitem><simpara> Last page which may be printed.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">currentlabel</parameter> :</term>
<listitem><simpara> Label text for current option.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">rangelabel</parameter> :</term>
<listitem><simpara> Label text for range option.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>construct_range_page</methodname>() method construct a generic page/sheet range area.
</para>
</refsect2>
<refsect2 id="method-gnomeprintuidialog--get-config">
<title>gnomeprint.ui.Dialog.get_config</title>
<programlisting><methodsynopsis language="python">
<methodname>get_config</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> the config.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_config</methodname>() method
</para>
</refsect2>
<refsect2 id="method-gnomeprintuidialog--get-copies">
<title>gnomeprint.ui.Dialog.get_copies</title>
<programlisting><methodsynopsis language="python">
<methodname>get_copies</methodname>
<methodparam><parameter role="keyword">copies</parameter></methodparam>
<methodparam><parameter role="keyword">collate</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">copies</parameter> :</term>
<listitem><simpara> Return for the number of copies.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">collate</parameter> :</term>
<listitem><simpara> Return for collation flag.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_copies</methodname>() method retrieves the number of copies and collation indicator from the print dialogue.
If the print dialogue does not have a copies indicator, then a default of 1 copy is returned.
</para>
</refsect2>
<refsect2 id="method-gnomeprintuidialog--get-range">
<title>gnomeprint.ui.Dialog.get_range</title>
<programlisting><methodsynopsis language="python">
<methodname>get_range</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> A bitmask with one option set.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_range</methodname>() method return the range option selected by the user.
This is a bitmask with only 1 bit set, out of:
gnomeprint.RANGE_CURRENT: The current option selected. gnomeprint.RANGE_ALL: The all option selected.
gnomeprint.RANGE_RANGE The range option selected. gnomeprint.RANGE_SELECTION: The selection option selected.
</para>
</refsect2>
<refsect2 id="method-gnomeprintuidialog--get-range-page">
<title>gnomeprint.ui.Dialog.get_range_page</title>
<programlisting><methodsynopsis language="python">
<methodname>get_range_page</methodname>
<methodparam><parameter role="keyword">start</parameter></methodparam>
<methodparam><parameter role="keyword">end</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">start</parameter> :</term>
<listitem><simpara> Return for the user-specified start page.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">end</parameter> :</term>
<listitem><simpara> Return for the user-specified end page.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> A bitmask with the user-selection set. See
<methodname><link linkend="method-gnomeprintuidialog--get-range">get_range</link></methodname></simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_range_page</methodname>() method retrieves the user choice for range type and range,
if the user has requested a range of pages to print.
</para>
</refsect2>
<refsect2 id="method-gnomeprintuidialog--set-copies">
<title>gnomeprint.ui.Dialog.set_copies</title>
<programlisting><methodsynopsis language="python">
<methodname>set_copies</methodname>
<methodparam><parameter role="keyword">copies</parameter></methodparam>
<methodparam><parameter role="keyword">collate</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">copies</parameter> :</term>
<listitem><simpara> New number of copies.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">collate</parameter> :</term>
<listitem><simpara> New collation status.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>set_copies</methodname>() method sets the print copies and collation status in the print dialogue.
</para>
</refsect2>
</refsect1>
</refentry>
|
