File: wx.PrintDialog.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (239 lines) | stat: -rw-r--r-- 6,320 bytes parent folder | download
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
.. 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.PrintDialog:

==========================================================================================================================================
|phoenix_title|  **wx.PrintDialog**
==========================================================================================================================================

This class represents the print and print setup common dialogs.          

You may obtain a :ref:`wx.PrinterDC`  device context from a successfully dismissed print dialog. 







         



.. seealso:: :ref:`Printing Framework Overview <printing framework overview>`, :ref:`PrintDialog Overview <printdialog overview>`    







|

|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>PrintDialog</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.PrintDialog_inheritance.png" alt="Inheritance diagram of PrintDialog" 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.Object.html" title="wx.Object" alt="" coords="19,5,100,35"/> <area shape="rect" id="node2" href="wx.PrintDialog.html" title="wx.PrintDialog" alt="" coords="5,83,115,112"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.PrintDialog.__init__`                                                 Constructor.
:meth:`~wx.PrintDialog.GetPrintDC`                                               Returns the device context created by the print dialog, if any.
:meth:`~wx.PrintDialog.GetPrintData`                                             Returns the :ref:`print data <print data>`  associated with the print dialog.
:meth:`~wx.PrintDialog.GetPrintDialogData`                                       Returns the :ref:`print dialog data <print dialog data>`  associated with the print dialog.
:meth:`~wx.PrintDialog.ShowModal`                                                Shows the dialog, returning  ``ID_OK``   if the user pressed ``wx.OK``, and   ``ID_CANCEL``   otherwise.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.PrintDialog.PrintDC`                                                  See :meth:`~wx.PrintDialog.GetPrintDC`
:attr:`~wx.PrintDialog.PrintData`                                                See :meth:`~wx.PrintDialog.GetPrintData`
:attr:`~wx.PrintDialog.PrintDialogData`                                          See :meth:`~wx.PrintDialog.GetPrintDialogData`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.PrintDialog(Object)

   **Possible constructors**::

       PrintDialog(parent, data=None)
       
       PrintDialog(parent, data)
       
   
   This class represents the print and print setup common dialogs.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      **~~~**

      
      **__init__** `(self, parent, data=None)`
      
      Constructor.                  
      
      Pass a parent window, and optionally a pointer to a block of print data, which will be copied to the print dialog's print data. 
      
                      
      
      
      :param `parent`: 
      :type `parent`: wx.Window
      :param `data`: 
      :type `data`: wx.PrintDialogData
      
      
      
      
      
      
      .. seealso:: :ref:`wx.PrintDialogData`    
      
      
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, parent, data)`
      
      
      
      
      :param `parent`: 
      :type `parent`: wx.Window
      :param `data`: 
      :type `data`: wx.PrintData
      
      
      
      
      
      
      **~~~**






   .. method:: GetPrintDC(self)

      Returns the device context created by the print dialog, if any.                  

      When this function has been called, the ownership of the device context is transferred to the application, so it must then be deleted explicitly.                  

      :rtype: :ref:`wx.DC`








   .. method:: GetPrintData(self)

      Returns the :ref:`print data <print data>`  associated with the print dialog.                  

      :rtype: :ref:`wx.PrintData`








   .. method:: GetPrintDialogData(self)

      Returns the :ref:`print dialog data <print dialog data>`  associated with the print dialog.                  

      :rtype: :ref:`wx.PrintDialogData`








   .. method:: ShowModal(self)

      Shows the dialog, returning  ``ID_OK``   if the user pressed ``wx.OK``, and   ``ID_CANCEL``   otherwise.                   

      After this function is called, a device context may be retrievable using :meth:`GetPrintDC` .                  

      :rtype: `int`








   .. attribute:: PrintDC

      See :meth:`~wx.PrintDialog.GetPrintDC`


   .. attribute:: PrintData

      See :meth:`~wx.PrintDialog.GetPrintData`


   .. attribute:: PrintDialogData

      See :meth:`~wx.PrintDialog.GetPrintDialogData`