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

NAME

6       wxPrintData - Functions for wxPrintData class
7

DESCRIPTION

9       This  class  holds  a  variety  of  information related to printers and
10       printer device contexts. This class is used  to  create  a  wxPrinterDC
11       (not implemented in wx) and a wxPostScriptDC. It is also used as a data
12       member of wxPrintDialogData and wxPageSetupDialogData, as part  of  the
13       mechanism  for  transferring data between the print dialogs and the ap‐
14       plication.
15
16       See: Overview printing,  wxPrintDialog,  wxPageSetupDialog,  wxPrintDi‐
17       alogData,  wxPageSetupDialogData, Overview cmndlg, wxPrinterDC (not im‐
18       plemented in wx), wxPostScriptDC
19
20       wxWidgets docs: wxPrintData
21

DATA TYPES

23       wxPrintData() = wx:wx_object()
24

EXPORTS

26       new() -> wxPrintData()
27
28              Default constructor.
29
30       new(Data) -> wxPrintData()
31
32              Types:
33
34                 Data = wxPrintData()
35
36              Copy constructor.
37
38       destroy(This :: wxPrintData()) -> ok
39
40              Destructor.
41
42       getCollate(This) -> boolean()
43
44              Types:
45
46                 This = wxPrintData()
47
48              Returns true if collation is on.
49
50       getBin(This) -> wx:wx_enum()
51
52              Types:
53
54                 This = wxPrintData()
55
56              Returns the current bin (papersource).
57
58              By default, the system is left to select the bin (wxPRINTBIN_DE‐
59              FAULT is returned).
60
61              See setBin/2 for the full list of bin values.
62
63       getColour(This) -> boolean()
64
65              Types:
66
67                 This = wxPrintData()
68
69              Returns true if colour printing is on.
70
71       getDuplex(This) -> wx:wx_enum()
72
73              Types:
74
75                 This = wxPrintData()
76
77              Returns the duplex mode.
78
79              One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL, wxDUPLEX_VERTICAL.
80
81       getNoCopies(This) -> integer()
82
83              Types:
84
85                 This = wxPrintData()
86
87              Returns the number of copies requested by the user.
88
89       getOrientation(This) -> wx:wx_enum()
90
91              Types:
92
93                 This = wxPrintData()
94
95              Gets the orientation.
96
97              This can be wxLANDSCAPE or wxPORTRAIT.
98
99       getPaperId(This) -> wx:wx_enum()
100
101              Types:
102
103                 This = wxPrintData()
104
105              Returns the paper size id.
106
107              See: setPaperId/2
108
109       getPrinterName(This) -> unicode:charlist()
110
111              Types:
112
113                 This = wxPrintData()
114
115              Returns the printer name.
116
117              If  the  printer name is the empty string, it indicates that the
118              default printer should be used.
119
120       getQuality(This) -> integer()
121
122              Types:
123
124                 This = wxPrintData()
125
126              Returns the current print quality.
127
128              This can be a positive integer, denoting the number of dots  per
129              inch, or one of the following identifiers:
130
131              On input you should pass one of these identifiers, but on return
132              you may get back a positive integer indicating the current reso‐
133              lution setting.
134
135       isOk(This) -> boolean()
136
137              Types:
138
139                 This = wxPrintData()
140
141              Returns  true  if the print data is valid for using in print di‐
142              alogs.
143
144              This can return false on Windows if the current printer  is  not
145              set, for example. On all other platforms, it returns true.
146
147       setBin(This, Flag) -> ok
148
149              Types:
150
151                 This = wxPrintData()
152                 Flag = wx:wx_enum()
153
154              Sets the current bin.
155
156       setCollate(This, Flag) -> ok
157
158              Types:
159
160                 This = wxPrintData()
161                 Flag = boolean()
162
163              Sets collation to on or off.
164
165       setColour(This, Flag) -> ok
166
167              Types:
168
169                 This = wxPrintData()
170                 Flag = boolean()
171
172              Sets colour printing on or off.
173
174       setDuplex(This, Mode) -> ok
175
176              Types:
177
178                 This = wxPrintData()
179                 Mode = wx:wx_enum()
180
181              Returns the duplex mode.
182
183              One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL, wxDUPLEX_VERTICAL.
184
185       setNoCopies(This, N) -> ok
186
187              Types:
188
189                 This = wxPrintData()
190                 N = integer()
191
192              Sets the default number of copies to be printed out.
193
194       setOrientation(This, Orientation) -> ok
195
196              Types:
197
198                 This = wxPrintData()
199                 Orientation = wx:wx_enum()
200
201              Sets the orientation.
202
203              This can be wxLANDSCAPE or wxPORTRAIT.
204
205       setPaperId(This, PaperId) -> ok
206
207              Types:
208
209                 This = wxPrintData()
210                 PaperId = wx:wx_enum()
211
212              Sets the paper id.
213
214              This  indicates  the type of paper to be used. For a mapping be‐
215              tween paper id, paper size and string  name,  see  wxPrintPaper‐
216              Database in "paper.h" (not yet documented).
217
218              See: SetPaperSize() (not implemented in wx)
219
220       setPrinterName(This, PrinterName) -> ok
221
222              Types:
223
224                 This = wxPrintData()
225                 PrinterName = unicode:chardata()
226
227              Sets the printer name.
228
229              This  can  be  the  empty  string  to  indicate that the default
230              printer should be used.
231
232       setQuality(This, Quality) -> ok
233
234              Types:
235
236                 This = wxPrintData()
237                 Quality = integer()
238
239              Sets the desired print quality.
240
241              This can be a positive integer, denoting the number of dots  per
242              inch, or one of the following identifiers:
243
244              On input you should pass one of these identifiers, but on return
245              you may get back a positive integer indicating the current reso‐
246              lution setting.
247
248
249
250wxWidgets team.                    wx 2.2.1                     wxPrintData(3)