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
|
.. 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.PreviewFrame:
==========================================================================================================================================
|phoenix_title| **wx.PreviewFrame**
==========================================================================================================================================
This class provides the default method of managing the print preview interface.
Member functions may be overridden to replace functionality, or the class may be used without derivation.
.. seealso:: :ref:`wx.PreviewCanvas`, :ref:`wx.PreviewControlBar`, :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>PreviewFrame</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.PreviewFrame_inheritance.png" alt="Inheritance diagram of PreviewFrame" 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.Frame.html" title="wx.Frame" alt="" coords="63,392,144,421"/> <area shape="rect" id="node8" href="wx.PreviewFrame.html" title="wx.PreviewFrame" alt="" coords="39,469,168,499"/> <area shape="rect" id="node2" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="33,315,175,344"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="25,237,183,267"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PreviewFrame.__init__` Constructor.
:meth:`~wx.PreviewFrame.CreateCanvas` Creates a :ref:`wx.PreviewCanvas`.
:meth:`~wx.PreviewFrame.CreateControlBar` Creates a :ref:`wx.PreviewControlBar`.
:meth:`~wx.PreviewFrame.Initialize` Initializes the frame elements and prepares for showing it.
:meth:`~wx.PreviewFrame.InitializeWithModality` Initializes the frame elements and prepares for showing it with the given modality kind.
:meth:`~wx.PreviewFrame.OnCloseWindow` Enables any disabled frames in the application, and deletes the print preview object, implicitly deleting any printout objects associated with the print preview object.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PreviewFrame(Frame)
**Possible constructors**::
PreviewFrame(preview, parent, title="PrintPreview", pos=DefaultPosition,
size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr)
This class provides the default method of managing the print preview
interface.
.. method:: __init__(self, preview, parent, title="PrintPreview", pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr)
Constructor.
Pass a print preview object plus other normal frame arguments. The print preview object will be destroyed by the frame when it closes.
:param `preview`:
:type `preview`: wx.PrintPreview
:param `parent`:
:type `parent`: wx.Window
:param `title`:
:type `title`: string
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
.. method:: CreateCanvas(self)
Creates a :ref:`wx.PreviewCanvas`.
Override this function to allow a user-defined preview canvas object to be created.
.. method:: CreateControlBar(self)
Creates a :ref:`wx.PreviewControlBar`.
Override this function to allow a user-defined preview control bar object to be created.
.. method:: Initialize(self)
Initializes the frame elements and prepares for showing it.
Calling this method is equivalent to calling :meth:`InitializeWithModality` with PreviewFrame_AppModal argument, please see its documentation for more details.
Please notice that this function is virtual mostly for backwards compatibility only, there is no real need to override it as it's never called by wxWidgets itself.
.. method:: InitializeWithModality(self, kind)
Initializes the frame elements and prepares for showing it with the given modality kind.
This method creates the frame elements by calling :meth:`CreateCanvas` and :meth:`CreateControlBar` methods (which may be overridden to customize them) and prepares to show the frame according to the value of `kind` parameter:
- If it is PreviewFrame_AppModal, all the other application windows will be disabled when this frame is shown. This is the same behaviour as that of simple :ref:`wx.Initialize`.
- If it is PreviewFrame_WindowModal, only the parent window of the preview frame will be disabled when it is shown.
- And if it is PreviewFrame_NonModal, no windows at all will be disabled while the preview is shown.
Notice that this function (or :ref:`wx.Initialize`) must be called by the application prior to showing the frame but you still must call ``Show(true)`` to actually show it afterwards.
:param `kind`: The modality kind of preview frame.
:type `kind`: wx.PreviewFrameModalityKind
.. versionadded:: 2.9.2
.. method:: OnCloseWindow(self, event)
Enables any disabled frames in the application, and deletes the print preview object, implicitly deleting any printout objects associated with the print preview object.
:param `event`:
:type `event`: wx.CloseEvent
|
