blob: cac5d18db99d6099b123d9c6603f3d4e703f12ea (
plain)
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
|
<?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-gtkprintoperationpreview">
<refnamediv>
<refname>gtk.PrintOperationPreview</refname>
<refpurpose>an interface for printing preview (new in PyGTK
2.10)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.PrintOperationPreview</classname></ooclass>
<ooclass><classname>gobject.GInterface</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperationpreview--render-page">render_page</link></methodname>
<methodparam><parameter role="keyword">page_nr</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperationpreview--end-preview">end_preview</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperationpreview--is-selected">is_selected</link></methodname>
<methodparam><parameter role="keyword">page_nr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1 id="signal-prototypes-gtkprintoperationpreview">
<title>gtk.PrintOperationPreview Signal Prototypes</title>
<variablelist>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperationpreview--got-page-size">got-page-size</link></term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>printoperationpreview</parameter></methodparam>
<methodparam><parameter>printcontext</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperationpreview--ready">ready</link></term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>printoperationpreview</parameter></methodparam>
<methodparam><parameter>printcontext</parameter></methodparam>
<methodparam><parameter>pagesetup</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para><link
linkend="class-gtkprintoperationpreview"><classname>gtk.PrintOperationPreview</classname></link>
is an interface implemented by <link
linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
for previewing pages before printing.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkprintoperationpreview--render-page">
<title>gtk.PrintOperationPreview.render_page</title>
<programlisting><methodsynopsis language="python">
<methodname>render_page</methodname>
<methodparam><parameter role="keyword">page_nr</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page_nr</parameter> :</term>
<listitem><simpara>the number of the page to be
previewed</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
</refsect2>
<refsect2 id="method-gtkprintoperationpreview--end-preview">
<title>gtk.PrintOperationPreview.end_preview</title>
<programlisting><methodsynopsis language="python">
<methodname>end_preview</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
</refsect2>
<refsect2 id="method-gtkprintoperationpreview--is-selected">
<title>gtk.PrintOperationPreview.is_selected</title>
<programlisting><methodsynopsis language="python">
<methodname>is_selected</methodname>
<methodparam><parameter role="keyword">page_nr</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page_nr</parameter> :</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if
<parameter>page_nr</parameter> is the currently selected
page</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>Returns <literal>True</literal> if the page with the number
specified by <parameter>page_nr</parameter> is currently
selected.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkprintoperationpreview--got-page-size">
<title>The "got-page-size" gtk.PrintOperationPreview Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>printoperationpreview</parameter></methodparam>
<methodparam><parameter>printcontext</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>printoperationpreview</parameter> :</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>printcontext</parameter> :</term>
<listitem><simpara>the print context</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
</refsect2>
<refsect2 id="signal-gtkprintoperationpreview--ready">
<title>The "ready" gtk.PrintOperationPreview Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>printoperationpreview</parameter></methodparam>
<methodparam><parameter>printcontext</parameter></methodparam>
<methodparam><parameter>pagesetup</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>printoperationpreview</parameter> :</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>printcontext</parameter> :</term>
<listitem><simpara>the print context</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>pagesetup</parameter> :</term>
<listitem><simpara>the page setup</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
</refsect2>
</refsect1>
</refentry>
|