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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.printout
.. highlight:: python
.. _wx.lib.printout.SetPrintout:
==========================================================================================================================================
|phoenix_title| **wx.lib.printout.SetPrintout**
==========================================================================================================================================
Printout(title="Printout")
This class encapsulates the functionality of printing out an
application document.
|
|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>SetPrintout</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.lib.printout.SetPrintout_inheritance.png" alt="Inheritance diagram of SetPrintout" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.printout.SetPrintout.html" title="wx.lib.printout.SetPrintout" alt="" coords="5,160,197,189"/> <area shape="rect" id="node2" href="wx.Printout.html" title="wx.Printout" alt="" coords="53,83,149,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="58,5,145,35"/> </map>
</p>
</div>
|
|super_classes| Known Superclasses
==================================
:class:`wx.Printout`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.printout.SetPrintout.__init__` Initialize self. See help(type(self)) for accurate signature.
:meth:`~wx.lib.printout.SetPrintout.GetPageInfo` GetPageInfo() -> (minPage, maxPage, pageFrom, pageTo)
:meth:`~wx.lib.printout.SetPrintout.GetSize`
:meth:`~wx.lib.printout.SetPrintout.GetTotalSize`
:meth:`~wx.lib.printout.SetPrintout.HasPage` HasPage(pageNum) -> bool
:meth:`~wx.lib.printout.SetPrintout.OnBeginDocument` OnBeginDocument(startPage, endPage) -> bool
:meth:`~wx.lib.printout.SetPrintout.OnBeginPrinting` OnBeginPrinting()
:meth:`~wx.lib.printout.SetPrintout.OnEndDocument` OnEndDocument()
:meth:`~wx.lib.printout.SetPrintout.OnPreparePrinting` OnPreparePrinting()
:meth:`~wx.lib.printout.SetPrintout.OnPrintPage` OnPrintPage(pageNum) -> bool
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: SetPrintout(wx.Printout)
Printout(title="Printout")
This class encapsulates the functionality of printing out an
application document.
.. method:: __init__(self, canvas)
Initialize self. See help(type(self)) for accurate signature.
.. method:: GetPageInfo(self)
GetPageInfo() -> (minPage, maxPage, pageFrom, pageTo)
Called by the framework to obtain information from the application
about minimum and maximum page values that the user can select, and
the required page range to be printed.
.. method:: GetSize(self)
.. method:: GetTotalSize(self)
.. method:: HasPage(self, page)
HasPage(pageNum) -> bool
Should be overridden to return true if the document has this page, or
false if not.
.. method:: OnBeginDocument(self, start, end)
OnBeginDocument(startPage, endPage) -> bool
Called by the framework at the start of document printing.
.. method:: OnBeginPrinting(self)
OnBeginPrinting()
Called by the framework at the start of printing.
.. method:: OnEndDocument(self)
OnEndDocument()
Called by the framework at the end of document printing.
.. method:: OnPreparePrinting(self)
OnPreparePrinting()
Called once by the framework before any other demands are made of the
wxPrintout object.
.. method:: OnPrintPage(self, page)
OnPrintPage(pageNum) -> bool
Called by the framework when a page should be printed.
|
