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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
|
.. 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.PrintPreview:
==========================================================================================================================================
|phoenix_title| **wx.PrintPreview**
==========================================================================================================================================
Objects of this class manage the print preview process.
The object is passed a :ref:`wx.Printout` object, and the :ref:`wx.PrintPreview` object itself is passed to a :ref:`wx.PreviewFrame` object. Previewing is started by initializing and showing the preview frame. Unlike :meth:`wx.Printer.Print` , flow of control returns to the application immediately after the frame is shown.
.. note::
The preview shown is only exact on Windows. On other platforms, the :ref:`wx.DC` used for preview is different from what is used for printing and the results may be significantly different, depending on how is the output created. In particular, printing code relying on :meth:`wx.DC.GetTextExtent` heavily (for example, :ref:`wx.html.HtmlEasyPrinting` and other HTML classes do) is affected. It is recommended to use native preview functionality on platforms that offer it (OS X, GTK+).
.. seealso:: :ref:`Printing Framework Overview <printing framework overview>`, :ref:`wx.PrinterDC`, :ref:`wx.PrintDialog`, :ref:`wx.Printout`, :ref:`wx.Printer`, :ref:`wx.PreviewCanvas`, :ref:`wx.PreviewControlBar`, :ref:`wx.PreviewFrame`
|
|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>PrintPreview</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.PrintPreview_inheritance.png" alt="Inheritance diagram of PrintPreview" 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.PrintPreview.html" title="wx.PrintPreview" alt="" coords="5,83,123,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="23,5,104,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PrintPreview.__init__` Constructor.
:meth:`~wx.PrintPreview.GetCanvas` Gets the preview window used for displaying the print preview image.
:meth:`~wx.PrintPreview.GetCurrentPage` Gets the page currently being previewed.
:meth:`~wx.PrintPreview.GetFrame` Gets the frame used for displaying the print preview canvas and control bar.
:meth:`~wx.PrintPreview.GetMaxPage` Returns the maximum page number.
:meth:`~wx.PrintPreview.GetMinPage` Returns the minimum page number.
:meth:`~wx.PrintPreview.GetPrintout` Gets the preview printout object associated with the :ref:`wx.PrintPreview` object.
:meth:`~wx.PrintPreview.GetPrintoutForPrinting` Gets the printout object to be used for printing from within the preview interface, or ``None`` if none exists.
:meth:`~wx.PrintPreview.IsOk` Returns ``True`` if the :ref:`wx.PrintPreview` is valid, ``False`` otherwise.
:meth:`~wx.PrintPreview.PaintPage` This refreshes the preview window with the preview image.
:meth:`~wx.PrintPreview.Print` Invokes the print process using the second :ref:`wx.Printout` object supplied in the :ref:`wx.PrintPreview` constructor.
:meth:`~wx.PrintPreview.RenderPage` Renders a page into a :ref:`wx.MemoryDC`.
:meth:`~wx.PrintPreview.SetCanvas` Sets the window to be used for displaying the print preview image.
:meth:`~wx.PrintPreview.SetCurrentPage` Sets the current page to be previewed.
:meth:`~wx.PrintPreview.SetFrame` Sets the frame to be used for displaying the print preview canvas and control bar.
:meth:`~wx.PrintPreview.SetPrintout` Associates a printout object with the :ref:`wx.PrintPreview` object.
:meth:`~wx.PrintPreview.SetZoom` Sets the percentage preview zoom, and refreshes the preview canvas accordingly.
:meth:`~wx.PrintPreview.__bool__`
:meth:`~wx.PrintPreview.__nonzero__`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.PrintPreview.Canvas` See :meth:`~wx.PrintPreview.GetCanvas` and :meth:`~wx.PrintPreview.SetCanvas`
:attr:`~wx.PrintPreview.CurrentPage` See :meth:`~wx.PrintPreview.GetCurrentPage` and :meth:`~wx.PrintPreview.SetCurrentPage`
:attr:`~wx.PrintPreview.Frame` See :meth:`~wx.PrintPreview.GetFrame` and :meth:`~wx.PrintPreview.SetFrame`
:attr:`~wx.PrintPreview.MaxPage` See :meth:`~wx.PrintPreview.GetMaxPage`
:attr:`~wx.PrintPreview.MinPage` See :meth:`~wx.PrintPreview.GetMinPage`
:attr:`~wx.PrintPreview.Printout` See :meth:`~wx.PrintPreview.GetPrintout` and :meth:`~wx.PrintPreview.SetPrintout`
:attr:`~wx.PrintPreview.PrintoutForPrinting` See :meth:`~wx.PrintPreview.GetPrintoutForPrinting`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PrintPreview(Object)
**Possible constructors**::
PrintPreview(printout, printoutForPrinting=None, data=None)
PrintPreview(printout, printoutForPrinting, data)
Objects of this class manage the print preview process.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, printout, printoutForPrinting=None, data=None)`
Constructor.
Pass a printout object, an optional printout object to be used for actual printing, and the address of an optional block of printer data, which will be copied to the print preview object's print data.
If `printoutForPrinting` is non-NULL, a **"Print..."** button will be placed on the preview frame so that the user can print directly from the preview interface.
Use :meth:`IsOk` to check whether the :ref:`wx.PrintPreview` object was created correctly.
:param `printout`:
:type `printout`: wx.Printout
:param `printoutForPrinting`:
:type `printoutForPrinting`: wx.Printout
:param `data`:
:type `data`: wx.PrintDialogData
.. note::
Do not explicitly delete the printout objects once this constructor has been called, since they will be deleted in the :ref:`wx.PrintPreview` destructor. The same does not apply to the `data` argument.
**~~~**
**__init__** `(self, printout, printoutForPrinting, data)`
:param `printout`:
:type `printout`: wx.Printout
:param `printoutForPrinting`:
:type `printoutForPrinting`: wx.Printout
:param `data`:
:type `data`: wx.PrintData
**~~~**
.. method:: GetCanvas(self)
Gets the preview window used for displaying the print preview image.
:rtype: :ref:`wx.PreviewCanvas`
.. method:: GetCurrentPage(self)
Gets the page currently being previewed.
:rtype: `int`
.. method:: GetFrame(self)
Gets the frame used for displaying the print preview canvas and control bar.
:rtype: :ref:`wx.Frame`
.. method:: GetMaxPage(self)
Returns the maximum page number.
:rtype: `int`
.. method:: GetMinPage(self)
Returns the minimum page number.
:rtype: `int`
.. method:: GetPrintout(self)
Gets the preview printout object associated with the :ref:`wx.PrintPreview` object.
:rtype: :ref:`wx.Printout`
.. method:: GetPrintoutForPrinting(self)
Gets the printout object to be used for printing from within the preview interface, or ``None`` if none exists.
:rtype: :ref:`wx.Printout`
.. method:: IsOk(self)
Returns ``True`` if the :ref:`wx.PrintPreview` is valid, ``False`` otherwise.
It could return ``False`` if there was a problem initializing the printer device context (current printer not set, for example).
:rtype: `bool`
.. method:: PaintPage(self, canvas, dc)
This refreshes the preview window with the preview image.
It must be called from the preview window's OnPaint member.
The implementation simply blits the preview bitmap onto the canvas, creating a new preview bitmap if none exists.
:param `canvas`:
:type `canvas`: wx.PreviewCanvas
:param `dc`:
:type `dc`: wx.DC
:rtype: `bool`
.. method:: Print(self, prompt)
Invokes the print process using the second :ref:`wx.Printout` object supplied in the :ref:`wx.PrintPreview` constructor.
Will normally be called by the **Print**... panel item on the preview frame's control bar.
Returns ``False`` in case of error :meth:`wx.Printer.GetLastError` to get detailed information about the kind of the error.
:param `prompt`:
:type `prompt`: bool
:rtype: `bool`
.. method:: RenderPage(self, pageNum)
Renders a page into a :ref:`wx.MemoryDC`.
Used internally by :ref:`wx.PrintPreview`.
:param `pageNum`:
:type `pageNum`: int
:rtype: `bool`
.. method:: SetCanvas(self, window)
Sets the window to be used for displaying the print preview image.
:param `window`:
:type `window`: wx.PreviewCanvas
.. method:: SetCurrentPage(self, pageNum)
Sets the current page to be previewed.
:param `pageNum`:
:type `pageNum`: int
:rtype: `bool`
.. method:: SetFrame(self, frame)
Sets the frame to be used for displaying the print preview canvas and control bar.
:param `frame`:
:type `frame`: wx.Frame
.. method:: SetPrintout(self, printout)
Associates a printout object with the :ref:`wx.PrintPreview` object.
:param `printout`:
:type `printout`: wx.Printout
.. method:: SetZoom(self, percent)
Sets the percentage preview zoom, and refreshes the preview canvas accordingly.
:param `percent`:
:type `percent`: int
.. method:: __bool__(self)
:rtype: `int`
.. method:: __nonzero__(self)
:rtype: `int`
.. attribute:: Canvas
See :meth:`~wx.PrintPreview.GetCanvas` and :meth:`~wx.PrintPreview.SetCanvas`
.. attribute:: CurrentPage
See :meth:`~wx.PrintPreview.GetCurrentPage` and :meth:`~wx.PrintPreview.SetCurrentPage`
.. attribute:: Frame
See :meth:`~wx.PrintPreview.GetFrame` and :meth:`~wx.PrintPreview.SetFrame`
.. attribute:: MaxPage
See :meth:`~wx.PrintPreview.GetMaxPage`
.. attribute:: MinPage
See :meth:`~wx.PrintPreview.GetMinPage`
.. attribute:: Printout
See :meth:`~wx.PrintPreview.GetPrintout` and :meth:`~wx.PrintPreview.SetPrintout`
.. attribute:: PrintoutForPrinting
See :meth:`~wx.PrintPreview.GetPrintoutForPrinting`
|
