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

NAME

6       wxPageSetupDialogData - Functions for wxPageSetupDialogData class
7

DESCRIPTION

9       This class holds a variety of information related to wxPageSetupDialog.
10
11       It  contains  a  wxPrintData member which is used to hold basic printer
12       configuration data (as opposed to the user-interface configuration set‐
13       tings stored by wxPageSetupDialogData).
14
15       See: Overview printing, wxPageSetupDialog
16
17       wxWidgets docs: wxPageSetupDialogData
18

DATA TYPES

20       wxPageSetupDialogData() = wx:wx_object()
21

EXPORTS

23       new() -> wxPageSetupDialogData()
24
25              Default constructor.
26
27       new(PrintData) -> wxPageSetupDialogData()
28
29              Types:
30
31                 PrintData =
32                     wxPrintData:wxPrintData() |
33                     wxPageSetupDialogData:wxPageSetupDialogData()
34
35              Construct an object from a print data object.
36
37       destroy(This :: wxPageSetupDialogData()) -> ok
38
39              Destructor.
40
41       enableHelp(This, Flag) -> ok
42
43              Types:
44
45                 This = wxPageSetupDialogData()
46                 Flag = boolean()
47
48              Enables or disables the "Help" button (Windows only).
49
50       enableMargins(This, Flag) -> ok
51
52              Types:
53
54                 This = wxPageSetupDialogData()
55                 Flag = boolean()
56
57              Enables or disables the margin controls (Windows only).
58
59       enableOrientation(This, Flag) -> ok
60
61              Types:
62
63                 This = wxPageSetupDialogData()
64                 Flag = boolean()
65
66              Enables or disables the orientation control (Windows only).
67
68       enablePaper(This, Flag) -> ok
69
70              Types:
71
72                 This = wxPageSetupDialogData()
73                 Flag = boolean()
74
75              Enables or disables the paper size control (Windows only).
76
77       enablePrinter(This, Flag) -> ok
78
79              Types:
80
81                 This = wxPageSetupDialogData()
82                 Flag = boolean()
83
84              Enables  or  disables  the  "Printer"  button,  which  invokes a
85              printer setup dialog.
86
87       getDefaultMinMargins(This) -> boolean()
88
89              Types:
90
91                 This = wxPageSetupDialogData()
92
93              Returns true if the page setup dialog will take its minimum mar‐
94              gin  values from the currently selected printer properties (Win‐
95              dows only).
96
97       getEnableMargins(This) -> boolean()
98
99              Types:
100
101                 This = wxPageSetupDialogData()
102
103              Returns true if the margin controls are enabled (Windows only).
104
105       getEnableOrientation(This) -> boolean()
106
107              Types:
108
109                 This = wxPageSetupDialogData()
110
111              Returns true if the  orientation  control  is  enabled  (Windows
112              only).
113
114       getEnablePaper(This) -> boolean()
115
116              Types:
117
118                 This = wxPageSetupDialogData()
119
120              Returns  true  if  the  paper  size  control is enabled (Windows
121              only).
122
123       getEnablePrinter(This) -> boolean()
124
125              Types:
126
127                 This = wxPageSetupDialogData()
128
129              Returns true if the printer setup button is enabled.
130
131       getEnableHelp(This) -> boolean()
132
133              Types:
134
135                 This = wxPageSetupDialogData()
136
137              Returns true if the printer setup button is enabled.
138
139       getDefaultInfo(This) -> boolean()
140
141              Types:
142
143                 This = wxPageSetupDialogData()
144
145              Returns true if the dialog will simply  return  default  printer
146              information  (such  as  orientation) instead of showing a dialog
147              (Windows only).
148
149       getMarginTopLeft(This) -> {X :: integer(), Y :: integer()}
150
151              Types:
152
153                 This = wxPageSetupDialogData()
154
155              Returns the left (x) and top (y) margins in millimetres.
156
157       getMarginBottomRight(This) -> {X :: integer(), Y :: integer()}
158
159              Types:
160
161                 This = wxPageSetupDialogData()
162
163              Returns the right (x) and bottom (y) margins in millimetres.
164
165       getMinMarginTopLeft(This) -> {X :: integer(), Y :: integer()}
166
167              Types:
168
169                 This = wxPageSetupDialogData()
170
171              Returns the left (x) and top (y) minimum margins  the  user  can
172              enter (Windows only).
173
174              Units are in millimetres.
175
176       getMinMarginBottomRight(This) -> {X :: integer(), Y :: integer()}
177
178              Types:
179
180                 This = wxPageSetupDialogData()
181
182              Returns  the  right  (x) and bottom (y) minimum margins the user
183              can enter (Windows only).
184
185              Units are in millimetres.
186
187       getPaperId(This) -> wx:wx_enum()
188
189              Types:
190
191                 This = wxPageSetupDialogData()
192
193              Returns the paper id (stored in  the  internal  wxPrintData  ob‐
194              ject).
195
196              See: wxPrintData:setPaperId/2
197
198       getPaperSize(This) -> {W :: integer(), H :: integer()}
199
200              Types:
201
202                 This = wxPageSetupDialogData()
203
204              Returns the paper size in millimetres.
205
206       getPrintData(This) -> wxPrintData:wxPrintData()
207
208              Types:
209
210                 This = wxPageSetupDialogData()
211
212       isOk(This) -> boolean()
213
214              Types:
215
216                 This = wxPageSetupDialogData()
217
218              Returns  true  if the print data associated with the dialog data
219              is valid.
220
221              This can return false on Windows if the current printer  is  not
222              set, for example. On all other platforms, it returns true.
223
224       setDefaultInfo(This, Flag) -> ok
225
226              Types:
227
228                 This = wxPageSetupDialogData()
229                 Flag = boolean()
230
231              Pass  true  if the dialog will simply return default printer in‐
232              formation (such as orientation)  instead  of  showing  a  dialog
233              (Windows only).
234
235       setDefaultMinMargins(This, Flag) -> ok
236
237              Types:
238
239                 This = wxPageSetupDialogData()
240                 Flag = boolean()
241
242              Pass  true if the page setup dialog will take its minimum margin
243              values from the currently selected printer  properties  (Windows
244              only).
245
246              Units are in millimetres.
247
248       setMarginTopLeft(This, Pt) -> ok
249
250              Types:
251
252                 This = wxPageSetupDialogData()
253                 Pt = {X :: integer(), Y :: integer()}
254
255              Sets the left (x) and top (y) margins in millimetres.
256
257       setMarginBottomRight(This, Pt) -> ok
258
259              Types:
260
261                 This = wxPageSetupDialogData()
262                 Pt = {X :: integer(), Y :: integer()}
263
264              Sets the right (x) and bottom (y) margins in millimetres.
265
266       setMinMarginTopLeft(This, Pt) -> ok
267
268              Types:
269
270                 This = wxPageSetupDialogData()
271                 Pt = {X :: integer(), Y :: integer()}
272
273              Sets the left (x) and top (y) minimum margins the user can enter
274              (Windows only).
275
276              Units are in millimetres.
277
278       setMinMarginBottomRight(This, Pt) -> ok
279
280              Types:
281
282                 This = wxPageSetupDialogData()
283                 Pt = {X :: integer(), Y :: integer()}
284
285              Sets the right (x) and bottom (y) minimum margins the  user  can
286              enter (Windows only).
287
288              Units are in millimetres.
289
290       setPaperId(This, Id) -> ok
291
292              Types:
293
294                 This = wxPageSetupDialogData()
295                 Id = wx:wx_enum()
296
297              Sets the paper size id.
298
299              Calling  this  function  overrides the explicit paper dimensions
300              passed in setPaperSize/2.
301
302              See: wxPrintData:setPaperId/2
303
304       setPaperSize(This, Size) -> ok
305
306              Types:
307
308                 This = wxPageSetupDialogData()
309                 Size = {W :: integer(), H :: integer()}
310
311              Sets the paper size in millimetres.
312
313              If a corresponding paper id is found, it will be set in the  in‐
314              ternal  wxPrintData  object,  otherwise the paper size overrides
315              the paper id.
316
317       setPrintData(This, PrintData) -> ok
318
319              Types:
320
321                 This = wxPageSetupDialogData()
322                 PrintData = wxPrintData:wxPrintData()
323
324              Sets the print data associated with this object.
325
326
327
328wxWidgets team.                    wx 2.3.1           wxPageSetupDialogData(3)