1wxPrintDialogData(3)       Erlang Module Definition       wxPrintDialogData(3)
2
3
4

NAME

6       wxPrintDialogData - Functions for wxPrintDialogData class
7

DESCRIPTION

9       This  class  holds information related to the visual characteristics of
10       wxPrintDialog. It contains a wxPrintData object with underlying  print‐
11       ing settings.
12
13       See: Overview printing, wxPrintDialog, Overview cmndlg
14
15       wxWidgets docs: wxPrintDialogData
16

DATA TYPES

18       wxPrintDialogData() = wx:wx_object()
19

EXPORTS

21       new() -> wxPrintDialogData()
22
23              Default constructor.
24
25       new(DialogData) -> wxPrintDialogData()
26
27              Types:
28
29                 DialogData =
30                     wxPrintDialogData:wxPrintDialogData() |
31                     wxPrintData:wxPrintData()
32
33              Copy constructor.
34
35       destroy(This :: wxPrintDialogData()) -> ok
36
37              Destructor.
38
39       enableHelp(This, Flag) -> ok
40
41              Types:
42
43                 This = wxPrintDialogData()
44                 Flag = boolean()
45
46              Enables or disables the "Help" button.
47
48       enablePageNumbers(This, Flag) -> ok
49
50              Types:
51
52                 This = wxPrintDialogData()
53                 Flag = boolean()
54
55              Enables or disables the "Page numbers" controls.
56
57       enablePrintToFile(This, Flag) -> ok
58
59              Types:
60
61                 This = wxPrintDialogData()
62                 Flag = boolean()
63
64              Enables or disables the "Print to file" checkbox.
65
66       enableSelection(This, Flag) -> ok
67
68              Types:
69
70                 This = wxPrintDialogData()
71                 Flag = boolean()
72
73              Enables or disables the "Selection" radio button.
74
75       getAllPages(This) -> boolean()
76
77              Types:
78
79                 This = wxPrintDialogData()
80
81              Returns true if the user requested that all pages be printed.
82
83       getCollate(This) -> boolean()
84
85              Types:
86
87                 This = wxPrintDialogData()
88
89              Returns  true if the user requested that the document(s) be col‐
90              lated.
91
92       getFromPage(This) -> integer()
93
94              Types:
95
96                 This = wxPrintDialogData()
97
98              Returns the from page number, as entered by the user.
99
100       getMaxPage(This) -> integer()
101
102              Types:
103
104                 This = wxPrintDialogData()
105
106              Returns the maximum page number.
107
108       getMinPage(This) -> integer()
109
110              Types:
111
112                 This = wxPrintDialogData()
113
114              Returns the minimum page number.
115
116       getNoCopies(This) -> integer()
117
118              Types:
119
120                 This = wxPrintDialogData()
121
122              Returns the number of copies requested by the user.
123
124       getPrintData(This) -> wxPrintData:wxPrintData()
125
126              Types:
127
128                 This = wxPrintDialogData()
129
130              Returns a reference to the internal wxPrintData object.
131
132       getPrintToFile(This) -> boolean()
133
134              Types:
135
136                 This = wxPrintDialogData()
137
138              Returns true if the user has selected printing to a file.
139
140       getSelection(This) -> boolean()
141
142              Types:
143
144                 This = wxPrintDialogData()
145
146              Returns true if the user requested that the selection be printed
147              (where "selection" is a concept specific to the application).
148
149       getToPage(This) -> integer()
150
151              Types:
152
153                 This = wxPrintDialogData()
154
155              Returns the "print to" page number, as entered by the user.
156
157       isOk(This) -> boolean()
158
159              Types:
160
161                 This = wxPrintDialogData()
162
163              Returns  true  if the print data is valid for using in print di‐
164              alogs.
165
166              This can return false on Windows if the current printer  is  not
167              set, for example. On all other platforms, it returns true.
168
169       setCollate(This, Flag) -> ok
170
171              Types:
172
173                 This = wxPrintDialogData()
174                 Flag = boolean()
175
176              Sets the "Collate" checkbox to true or false.
177
178       setFromPage(This, Page) -> ok
179
180              Types:
181
182                 This = wxPrintDialogData()
183                 Page = integer()
184
185              Sets the from page number.
186
187       setMaxPage(This, Page) -> ok
188
189              Types:
190
191                 This = wxPrintDialogData()
192                 Page = integer()
193
194              Sets the maximum page number.
195
196       setMinPage(This, Page) -> ok
197
198              Types:
199
200                 This = wxPrintDialogData()
201                 Page = integer()
202
203              Sets the minimum page number.
204
205       setNoCopies(This, N) -> ok
206
207              Types:
208
209                 This = wxPrintDialogData()
210                 N = integer()
211
212              Sets  the  default number of copies the user has requested to be
213              printed out.
214
215       setPrintData(This, PrintData) -> ok
216
217              Types:
218
219                 This = wxPrintDialogData()
220                 PrintData = wxPrintData:wxPrintData()
221
222              Sets the internal wxPrintData.
223
224       setPrintToFile(This, Flag) -> ok
225
226              Types:
227
228                 This = wxPrintDialogData()
229                 Flag = boolean()
230
231              Sets the "Print to file" checkbox to true or false.
232
233       setSelection(This, Flag) -> ok
234
235              Types:
236
237                 This = wxPrintDialogData()
238                 Flag = boolean()
239
240              Selects the "Selection" radio button.
241
242              The effect of printing the selection depends on how the applica‐
243              tion implements this command, if at all.
244
245       setToPage(This, Page) -> ok
246
247              Types:
248
249                 This = wxPrintDialogData()
250                 Page = integer()
251
252              Sets the "print to" page number.
253
254
255
256wxWidgets team.                     wx 2.1                wxPrintDialogData(3)