blob: 5577174dfd14c7cd498cf4680ad7676debf26c57 (
plain)
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
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<!-- THIS FILE IS GENERATED DO NOT EDIT -->
<erlref>
<header>
<copyright>
<year>2020</year><year>2021</year>
<holder>wxWidgets team.</holder></copyright>
<legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
</legalnotice>
<title>wxPageSetupDialogData</title>
</header>
<module>wxPageSetupDialogData</module>
<modulesummary>Functions for wxPageSetupDialogData class</modulesummary>
<description><p>This class holds a variety of information related to <seeerl marker="wxPageSetupDialog"><c>wxPageSetupDialog</c></seeerl>.
</p><p>It contains a <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> member which is used to hold basic printer configuration data (as opposed to the user-interface configuration settings stored by <seeerl marker="wxPageSetupDialogData"><c>wxPageSetupDialogData</c></seeerl>).
</p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_printing.html#overview_printing">Overview printing</url>, <seeerl marker="wxPageSetupDialog"><c>wxPageSetupDialog</c></seeerl>
</p>
<p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_page_setup_dialog_data.html">wxPageSetupDialogData</url></p>
</description>
<datatypes><datatype><name name="wxPageSetupDialogData"/></datatype></datatypes>
<funcs>
<func>
<name name="new" arity="0" clause_i="1" since=""/>
<fsummary>Default constructor. </fsummary>
<desc><p>Default constructor.
</p></desc>
</func>
<func>
<name name="new" arity="1" clause_i="1" since=""/>
<fsummary>Construct an object from a print data object. </fsummary>
<desc><p>Construct an object from a print data object.
</p></desc>
</func>
<func>
<name name="destroy" arity="1" clause_i="1" since=""/>
<fsummary>Destructor. </fsummary>
<desc><p>Destructor.
</p></desc>
</func>
<func>
<name name="enableHelp" arity="2" clause_i="1" since=""/>
<fsummary>Enables or disables the "Help" button (Windows only). </fsummary>
<desc><p>Enables or disables the "Help" button (Windows only).
</p></desc>
</func>
<func>
<name name="enableMargins" arity="2" clause_i="1" since=""/>
<fsummary>Enables or disables the margin controls (Windows only). </fsummary>
<desc><p>Enables or disables the margin controls (Windows only).
</p></desc>
</func>
<func>
<name name="enableOrientation" arity="2" clause_i="1" since=""/>
<fsummary>Enables or disables the orientation control (Windows only). </fsummary>
<desc><p>Enables or disables the orientation control (Windows only).
</p></desc>
</func>
<func>
<name name="enablePaper" arity="2" clause_i="1" since=""/>
<fsummary>Enables or disables the paper size control (Windows only). </fsummary>
<desc><p>Enables or disables the paper size control (Windows only).
</p></desc>
</func>
<func>
<name name="enablePrinter" arity="2" clause_i="1" since=""/>
<fsummary>Enables or disables the "Printer" button, which invokes a printer setup dialog. </fsummary>
<desc><p>Enables or disables the "Printer" button, which invokes a printer setup dialog.
</p></desc>
</func>
<func>
<name name="getDefaultMinMargins" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only). </fsummary>
<desc><p>Returns true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).
</p></desc>
</func>
<func>
<name name="getEnableMargins" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the margin controls are enabled (Windows only). </fsummary>
<desc><p>Returns true if the margin controls are enabled (Windows only).
</p></desc>
</func>
<func>
<name name="getEnableOrientation" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the orientation control is enabled (Windows only). </fsummary>
<desc><p>Returns true if the orientation control is enabled (Windows only).
</p></desc>
</func>
<func>
<name name="getEnablePaper" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the paper size control is enabled (Windows only). </fsummary>
<desc><p>Returns true if the paper size control is enabled (Windows only).
</p></desc>
</func>
<func>
<name name="getEnablePrinter" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the printer setup button is enabled. </fsummary>
<desc><p>Returns true if the printer setup button is enabled.
</p></desc>
</func>
<func>
<name name="getEnableHelp" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the printer setup button is enabled. </fsummary>
<desc><p>Returns true if the printer setup button is enabled.
</p></desc>
</func>
<func>
<name name="getDefaultInfo" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only). </fsummary>
<desc><p>Returns true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).
</p></desc>
</func>
<func>
<name name="getMarginTopLeft" arity="1" clause_i="1" since=""/>
<fsummary>Returns the left (x) and top (y) margins in millimetres. </fsummary>
<desc><p>Returns the left (x) and top (y) margins in millimetres.
</p></desc>
</func>
<func>
<name name="getMarginBottomRight" arity="1" clause_i="1" since=""/>
<fsummary>Returns the right (x) and bottom (y) margins in millimetres. </fsummary>
<desc><p>Returns the right (x) and bottom (y) margins in millimetres.
</p></desc>
</func>
<func>
<name name="getMinMarginTopLeft" arity="1" clause_i="1" since=""/>
<fsummary>Returns the left (x) and top (y) minimum margins the user can enter (Windows only). </fsummary>
<desc><p>Returns the left (x) and top (y) minimum margins the user can enter (Windows only).
</p><p>Units are in millimetres.
</p></desc>
</func>
<func>
<name name="getMinMarginBottomRight" arity="1" clause_i="1" since=""/>
<fsummary>Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). </fsummary>
<desc><p>Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).
</p><p>Units are in millimetres.
</p></desc>
</func>
<func>
<name name="getPaperId" arity="1" clause_i="1" since=""/>
<fsummary>Returns the paper id (stored in the internal <c>wxPrintData</c> object). </fsummary>
<desc><p>Returns the paper id (stored in the internal <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> object).
</p><p>See: <seemfa marker="wxPrintData#setPaperId/2"><c>wxPrintData:setPaperId/2</c></seemfa>
</p></desc>
</func>
<func>
<name name="getPaperSize" arity="1" clause_i="1" since=""/>
<fsummary>Returns the paper size in millimetres. </fsummary>
<desc><p>Returns the paper size in millimetres.
</p></desc>
</func>
<func>
<name name="getPrintData" arity="1" clause_i="1" since=""/>
<fsummary/>
<desc/>
</func>
<func>
<name name="isOk" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the print data associated with the dialog data is valid. </fsummary>
<desc><p>Returns true if the print data associated with the dialog data is valid.
</p><p>This can return false on Windows if the current printer is not set, for example. On all other platforms, it returns true.
</p></desc>
</func>
<func>
<name name="setDefaultInfo" arity="2" clause_i="1" since=""/>
<fsummary>Pass true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only). </fsummary>
<desc><p>Pass true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).
</p></desc>
</func>
<func>
<name name="setDefaultMinMargins" arity="2" clause_i="1" since=""/>
<fsummary>Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only). </fsummary>
<desc><p>Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).
</p><p>Units are in millimetres.
</p></desc>
</func>
<func>
<name name="setMarginTopLeft" arity="2" clause_i="1" since=""/>
<fsummary>Sets the left (x) and top (y) margins in millimetres. </fsummary>
<desc><p>Sets the left (x) and top (y) margins in millimetres.
</p></desc>
</func>
<func>
<name name="setMarginBottomRight" arity="2" clause_i="1" since=""/>
<fsummary>Sets the right (x) and bottom (y) margins in millimetres. </fsummary>
<desc><p>Sets the right (x) and bottom (y) margins in millimetres.
</p></desc>
</func>
<func>
<name name="setMinMarginTopLeft" arity="2" clause_i="1" since=""/>
<fsummary>Sets the left (x) and top (y) minimum margins the user can enter (Windows only). </fsummary>
<desc><p>Sets the left (x) and top (y) minimum margins the user can enter (Windows only).
</p><p>Units are in millimetres.
</p></desc>
</func>
<func>
<name name="setMinMarginBottomRight" arity="2" clause_i="1" since=""/>
<fsummary>Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). </fsummary>
<desc><p>Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
</p><p>Units are in millimetres.
</p></desc>
</func>
<func>
<name name="setPaperId" arity="2" clause_i="1" since=""/>
<fsummary>Sets the paper size id. </fsummary>
<desc><p>Sets the paper size id.
</p><p>Calling this function overrides the explicit paper dimensions passed in <seemfa marker="#setPaperSize/2"><c>setPaperSize/2</c></seemfa>.
</p><p>See: <seemfa marker="wxPrintData#setPaperId/2"><c>wxPrintData:setPaperId/2</c></seemfa>
</p></desc>
</func>
<func>
<name name="setPaperSize" arity="2" clause_i="1" since=""/>
<fsummary>Sets the paper size in millimetres. </fsummary>
<desc><p>Sets the paper size in millimetres.
</p><p>If a corresponding paper id is found, it will be set in the internal <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> object, otherwise the paper size overrides the paper id.
</p></desc>
</func>
<func>
<name name="setPrintData" arity="2" clause_i="1" since=""/>
<fsummary>Sets the print data associated with this object. </fsummary>
<desc><p>Sets the print data associated with this object.
</p></desc>
</func>
</funcs>
</erlref>
|
