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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Printer:
==========================================================================================================================================
|phoenix_title| **wx.Printer**
==========================================================================================================================================
This class represents the Windows or PostScript printer, and is the vehicle through which printing may be launched by an application.
Printing can also be achieved through using of lower functions and classes, but this and associated classes provide a more convenient and general method of printing.
.. seealso:: :ref:`Printing Framework Overview <printing framework overview>`, :ref:`wx.PrinterDC`, :ref:`wx.PrintDialog`, :ref:`wx.Printout`, :ref:`wx.PrintPreview`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>Printer</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.Printer_inheritance.png" alt="Inheritance diagram of Printer" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Printer.html" title="wx.Printer" alt="" coords="5,83,88,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Printer.__init__` Constructor.
:meth:`~wx.Printer.CreateAbortWindow` Creates the default printing abort window, with a cancel button.
:meth:`~wx.Printer.GetAbort` Returns ``True`` if the user has aborted the print job.
:meth:`~wx.Printer.GetLastError` Return last error.
:meth:`~wx.Printer.GetPrintDialogData` Returns the :ref:`print data <print data>` associated with the printer object.
:meth:`~wx.Printer.Print` Starts the printing process.
:meth:`~wx.Printer.PrintDialog` Invokes the print dialog.
:meth:`~wx.Printer.ReportError` Default error-reporting function.
:meth:`~wx.Printer.Setup` Invokes the print setup dialog.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Printer.Abort` See :meth:`~wx.Printer.GetAbort`
:attr:`~wx.Printer.PrintDialogData` See :meth:`~wx.Printer.GetPrintDialogData`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Printer(Object)
**Possible constructors**::
Printer(data=None)
This class represents the Windows or PostScript printer, and is the
vehicle through which printing may be launched by an application.
.. method:: __init__(self, data=None)
Constructor.
Pass an optional pointer to a block of print dialog data, which will be copied to the printer object's local data.
:param `data`:
:type `data`: wx.PrintDialogData
.. seealso:: :ref:`wx.PrintDialogData`, :ref:`wx.PrintData`
.. method:: CreateAbortWindow(self, parent, printout)
Creates the default printing abort window, with a cancel button.
:param `parent`:
:type `parent`: wx.Window
:param `printout`:
:type `printout`: wx.Printout
:rtype: :ref:`wx.PrintAbortDialog`
.. method:: GetAbort(self)
Returns ``True`` if the user has aborted the print job.
:rtype: `bool`
.. staticmethod:: GetLastError()
Return last error.
Valid after calling :meth:`Print` , :ref:`wx.PrintDialog` or :meth:`wx.PrintPreview.Print` .
These functions set last error to ``PRINTER_NO_ERROR`` if no error happened.
Returned value is one of the following:
=========================== ======================================
``wx.PRINTER_NO_ERROR`` No error happened.
``wx.PRINTER_CANCELLED`` The user cancelled printing.
``wx.PRINTER_ERROR`` There was an error during printing.
=========================== ======================================
|
:rtype: :ref:`wx.PrinterError`
.. method:: GetPrintDialogData(self)
Returns the :ref:`print data <print data>` associated with the printer object.
:rtype: :ref:`wx.PrintDialogData`
.. method:: Print(self, parent, printout, prompt=True)
Starts the printing process.
Provide a parent window, a user-defined :ref:`wx.Printout` object which controls the printing of a document, and whether the print dialog should be invoked first.
:meth:`Print` could return ``False`` if there was a problem initializing the printer device context (current printer not set, for example) or the user cancelled printing. Call :meth:`GetLastError` to get detailed information about the kind of the error.
:param `parent`:
:type `parent`: wx.Window
:param `printout`:
:type `printout`: wx.Printout
:param `prompt`:
:type `prompt`: bool
:rtype: `bool`
.. method:: PrintDialog(self, parent)
Invokes the print dialog.
If successful (the user did not press Cancel and no error occurred), a suitable device context will be returned; otherwise ``None`` is returned; call :meth:`GetLastError` to get detailed information about the kind of the error.
:param `parent`:
:type `parent`: wx.Window
:rtype: :ref:`wx.DC`
.. note::
The application must delete this device context to avoid a memory leak.
.. method:: ReportError(self, parent, printout, message)
Default error-reporting function.
:param `parent`:
:type `parent`: wx.Window
:param `printout`:
:type `printout`: wx.Printout
:param `message`:
:type `message`: string
.. method:: Setup(self, parent)
Invokes the print setup dialog.
:param `parent`:
:type `parent`: wx.Window
:rtype: `bool`
.. note::
The setup dialog is obsolete from Windows 95, though retained for backward compatibility.
.. attribute:: Abort
See :meth:`~wx.Printer.GetAbort`
.. attribute:: PrintDialogData
See :meth:`~wx.Printer.GetPrintDialogData`
|
