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
|
<?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>
<holder>Ericsson AB. All Rights Reserved.</holder></copyright>
<legalnotice>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</legalnotice>
<title>wxPrintDialogData</title>
</header>
<module>wxPrintDialogData</module>
<modulesummary>Functions for wxPrintDialogData class</modulesummary>
<description><p>This class holds information related to the visual characteristics of <seeerl marker="wxPrintDialog"><c>wxPrintDialog</c></seeerl>. It contains a <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> object with underlying printing settings.
</p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_printing.html#overview_printing">Overview printing</url>, <seeerl marker="wxPrintDialog"><c>wxPrintDialog</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_print">Overview cmndlg</url>
</p>
<p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_print_dialog_data.html">wxPrintDialogData</url></p>
</description>
<datatypes><datatype><name name="wxPrintDialogData"/></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>Copy constructor. </fsummary>
<desc><p>Copy constructor.
</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. </fsummary>
<desc><p>Enables or disables the "Help" button.
</p></desc>
</func>
<func>
<name name="enablePageNumbers" arity="2" clause_i="1" since=""/>
<fsummary>Enables or disables the "Page numbers" controls. </fsummary>
<desc><p>Enables or disables the "Page numbers" controls.
</p></desc>
</func>
<func>
<name name="enablePrintToFile" arity="2" clause_i="1" since=""/>
<fsummary>Enables or disables the "Print to file" checkbox. </fsummary>
<desc><p>Enables or disables the "Print to file" checkbox.
</p></desc>
</func>
<func>
<name name="enableSelection" arity="2" clause_i="1" since=""/>
<fsummary>Enables or disables the "Selection" radio button. </fsummary>
<desc><p>Enables or disables the "Selection" radio button.
</p></desc>
</func>
<func>
<name name="getAllPages" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the user requested that all pages be printed. </fsummary>
<desc><p>Returns true if the user requested that all pages be printed.
</p></desc>
</func>
<func>
<name name="getCollate" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the user requested that the document(s) be collated. </fsummary>
<desc><p>Returns true if the user requested that the document(s) be collated.
</p></desc>
</func>
<func>
<name name="getFromPage" arity="1" clause_i="1" since=""/>
<fsummary>Returns the <c>from</c> page number, as entered by the user. </fsummary>
<desc><p>Returns the <c>from</c> page number, as entered by the user.
</p></desc>
</func>
<func>
<name name="getMaxPage" arity="1" clause_i="1" since=""/>
<fsummary>Returns the <c>maximum</c> page number. </fsummary>
<desc><p>Returns the <c>maximum</c> page number.
</p></desc>
</func>
<func>
<name name="getMinPage" arity="1" clause_i="1" since=""/>
<fsummary>Returns the <c>minimum</c> page number. </fsummary>
<desc><p>Returns the <c>minimum</c> page number.
</p></desc>
</func>
<func>
<name name="getNoCopies" arity="1" clause_i="1" since=""/>
<fsummary>Returns the number of copies requested by the user. </fsummary>
<desc><p>Returns the number of copies requested by the user.
</p></desc>
</func>
<func>
<name name="getPrintData" arity="1" clause_i="1" since=""/>
<fsummary>Returns a reference to the internal <c>wxPrintData</c> object. </fsummary>
<desc><p>Returns a reference to the internal <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> object.
</p></desc>
</func>
<func>
<name name="getPrintToFile" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the user has selected printing to a file. </fsummary>
<desc><p>Returns true if the user has selected printing to a file.
</p></desc>
</func>
<func>
<name name="getSelection" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the user requested that the selection be printed (where "selection" is a concept specific to the application). </fsummary>
<desc><p>Returns true if the user requested that the selection be printed (where "selection" is a concept specific to the application).
</p></desc>
</func>
<func>
<name name="getToPage" arity="1" clause_i="1" since=""/>
<fsummary>Returns the <c>"print to"</c> page number, as entered by the user. </fsummary>
<desc><p>Returns the <c>"print to"</c> page number, as entered by the user.
</p></desc>
</func>
<func>
<name name="isOk" arity="1" clause_i="1" since=""/>
<fsummary>Returns true if the print data is valid for using in print dialogs. </fsummary>
<desc><p>Returns true if the print data is valid for using in print dialogs.
</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="setCollate" arity="2" clause_i="1" since=""/>
<fsummary>Sets the "Collate" checkbox to true or false. </fsummary>
<desc><p>Sets the "Collate" checkbox to true or false.
</p></desc>
</func>
<func>
<name name="setFromPage" arity="2" clause_i="1" since=""/>
<fsummary>Sets the <c>from</c> page number. </fsummary>
<desc><p>Sets the <c>from</c> page number.
</p></desc>
</func>
<func>
<name name="setMaxPage" arity="2" clause_i="1" since=""/>
<fsummary>Sets the <c>maximum</c> page number. </fsummary>
<desc><p>Sets the <c>maximum</c> page number.
</p></desc>
</func>
<func>
<name name="setMinPage" arity="2" clause_i="1" since=""/>
<fsummary>Sets the <c>minimum</c> page number. </fsummary>
<desc><p>Sets the <c>minimum</c> page number.
</p></desc>
</func>
<func>
<name name="setNoCopies" arity="2" clause_i="1" since=""/>
<fsummary>Sets the default number of copies the user has requested to be printed out. </fsummary>
<desc><p>Sets the default number of copies the user has requested to be printed out.
</p></desc>
</func>
<func>
<name name="setPrintData" arity="2" clause_i="1" since=""/>
<fsummary>Sets the internal <c>wxPrintData</c>. </fsummary>
<desc><p>Sets the internal <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl>.
</p></desc>
</func>
<func>
<name name="setPrintToFile" arity="2" clause_i="1" since=""/>
<fsummary>Sets the "Print to file" checkbox to true or false. </fsummary>
<desc><p>Sets the "Print to file" checkbox to true or false.
</p></desc>
</func>
<func>
<name name="setSelection" arity="2" clause_i="1" since=""/>
<fsummary>Selects the "Selection" radio button. </fsummary>
<desc><p>Selects the "Selection" radio button.
</p><p>The effect of printing the selection depends on how the application implements this command, if at all.
</p></desc>
</func>
<func>
<name name="setToPage" arity="2" clause_i="1" since=""/>
<fsummary>Sets the <c>"print to"</c> page number. </fsummary>
<desc><p>Sets the <c>"print to"</c> page number.
</p></desc>
</func>
</funcs>
</erlref>
|
