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

NAME

6       wxFont - See external documentation: wxFont.
7

DESCRIPTION

9       See external documentation: wxFont.
10

DATA TYPES

12         wxFont():
13
14
15           An  object  reference,  The  representation  is internal and can be
16           changed without notice. It can't be used for comparsion  stored  on
17           disc or distributed for use on other nodes.
18

EXPORTS

20       new() -> wxFont()
21
22              See external documentation.
23
24       new(Fontname) -> wxFont()
25
26              Types:
27
28                 Fontname = unicode:chardata()
29
30              See external documentation.
31
32       new(Size, Family, Style, Weight) -> wxFont()
33
34              Types:
35
36                 Size = integer()
37                 Family = wx:wx_enum()
38                 Style = wx:wx_enum()
39                 Weight = integer()
40
41              Equivalent to new(Size, Family, Style, Weight, []).
42
43       new(Size, Family, Style, Weight, Options::[Option]) -> wxFont()
44
45              Types:
46
47                 Size = integer()
48                 Family = wx:wx_enum()
49                 Style = wx:wx_enum()
50                 Weight = integer()
51                 Option = {underlined, boolean()} | {face, unicode:chardata()}
52                 | {encoding, wx:wx_enum()}
53
54              See external documentation.
55              Encoding = ?wxFONTENCODING_SYSTEM  |  ?wxFONTENCODING_DEFAULT  |
56              ?wxFONTENCODING_ISO8859_1    |    ?wxFONTENCODING_ISO8859_2    |
57              ?wxFONTENCODING_ISO8859_3    |    ?wxFONTENCODING_ISO8859_4    |
58              ?wxFONTENCODING_ISO8859_5    |    ?wxFONTENCODING_ISO8859_6    |
59              ?wxFONTENCODING_ISO8859_7    |    ?wxFONTENCODING_ISO8859_8    |
60              ?wxFONTENCODING_ISO8859_9    |    ?wxFONTENCODING_ISO8859_10   |
61              ?wxFONTENCODING_ISO8859_11   |   ?wxFONTENCODING_ISO8859_12    |
62              ?wxFONTENCODING_ISO8859_13    |   ?wxFONTENCODING_ISO8859_14   |
63              ?wxFONTENCODING_ISO8859_15   |   ?wxFONTENCODING_ISO8859_MAX   |
64              ?wxFONTENCODING_KOI8  |  ?wxFONTENCODING_KOI8_U  | ?wxFONTENCOD‐
65              ING_ALTERNATIVE  |  ?wxFONTENCODING_BULGARIAN  |   ?wxFONTENCOD‐
66              ING_CP437  |  ?wxFONTENCODING_CP850  |  ?wxFONTENCODING_CP852  |
67              ?wxFONTENCODING_CP855 |  ?wxFONTENCODING_CP866  |  ?wxFONTENCOD‐
68              ING_CP874  |  ?wxFONTENCODING_CP932  |  ?wxFONTENCODING_CP936  |
69              ?wxFONTENCODING_CP949 |  ?wxFONTENCODING_CP950  |  ?wxFONTENCOD‐
70              ING_CP1250  |  ?wxFONTENCODING_CP1251 | ?wxFONTENCODING_CP1252 |
71              ?wxFONTENCODING_CP1253 | ?wxFONTENCODING_CP1254 |  ?wxFONTENCOD‐
72              ING_CP1255  |  ?wxFONTENCODING_CP1256 | ?wxFONTENCODING_CP1257 |
73              ?wxFONTENCODING_CP12_MAX | ?wxFONTENCODING_UTF7 |  ?wxFONTENCOD‐
74              ING_UTF8  |  ?wxFONTENCODING_EUC_JP  | ?wxFONTENCODING_UTF16BE |
75              ?wxFONTENCODING_UTF16LE     |     ?wxFONTENCODING_UTF32BE      |
76              ?wxFONTENCODING_UTF32LE     |     ?wxFONTENCODING_MACROMAN     |
77              ?wxFONTENCODING_MACJAPANESE |  ?wxFONTENCODING_MACCHINESETRAD  |
78              ?wxFONTENCODING_MACKOREAN    |    ?wxFONTENCODING_MACARABIC    |
79              ?wxFONTENCODING_MACHEBREW    |    ?wxFONTENCODING_MACGREEK     |
80              ?wxFONTENCODING_MACCYRILLIC  |  ?wxFONTENCODING_MACDEVANAGARI  |
81              ?wxFONTENCODING_MACGURMUKHI  |   ?wxFONTENCODING_MACGUJARATI   |
82              ?wxFONTENCODING_MACORIYA    |    ?wxFONTENCODING_MACBENGALI    |
83              ?wxFONTENCODING_MACTAMIL    |    ?wxFONTENCODING_MACTELUGU     |
84              ?wxFONTENCODING_MACKANNADA   |   ?wxFONTENCODING_MACMALAJALAM  |
85              ?wxFONTENCODING_MACSINHALESE  |   ?wxFONTENCODING_MACBURMESE   |
86              ?wxFONTENCODING_MACKHMER     |     ?wxFONTENCODING_MACTHAI     |
87              ?wxFONTENCODING_MACLAOTIAN   |   ?wxFONTENCODING_MACGEORGIAN   |
88              ?wxFONTENCODING_MACARMENIAN  |  ?wxFONTENCODING_MACCHINESESIMP |
89              ?wxFONTENCODING_MACTIBETAN  |   ?wxFONTENCODING_MACMONGOLIAN   |
90              ?wxFONTENCODING_MACETHIOPIC  |  ?wxFONTENCODING_MACCENTRALEUR  |
91              ?wxFONTENCODING_MACVIATNAMESE |  ?wxFONTENCODING_MACARABICEXT  |
92              ?wxFONTENCODING_MACSYMBOL    |   ?wxFONTENCODING_MACDINGBATS   |
93              ?wxFONTENCODING_MACTURKISH   |   ?wxFONTENCODING_MACCROATIAN   |
94              ?wxFONTENCODING_MACICELANDIC   |  ?wxFONTENCODING_MACROMANIAN  |
95              ?wxFONTENCODING_MACCELTIC    |    ?wxFONTENCODING_MACGAELIC    |
96              ?wxFONTENCODING_MACKEYBOARD      |     ?wxFONTENCODING_MAX     |
97              ?wxFONTENCODING_MACMIN | ?wxFONTENCODING_MACMAX |  ?wxFONTENCOD‐
98              ING_UTF16  |  ?wxFONTENCODING_UTF32  | ?wxFONTENCODING_UNICODE |
99              ?wxFONTENCODING_GB2312 |  ?wxFONTENCODING_BIG5  |  ?wxFONTENCOD‐
100              ING_SHIFT_JIS
101              Family  =  ?wxFONTFAMILY_DEFAULT  |  ?wxFONTFAMILY_DECORATIVE  |
102              ?wxFONTFAMILY_ROMAN | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS
103              |  ?wxFONTFAMILY_MODERN  |  ?wxFONTFAMILY_TELETYPE | ?wxFONTFAM‐
104              ILY_MAX | ?wxFONTFAMILY_UNKNOWN
105              Style   =   ?wxFONTSTYLE_NORMAL    |    ?wxFONTSTYLE_ITALIC    |
106              ?wxFONTSTYLE_SLANT | ?wxFONTSTYLE_MAX
107
108       isFixedWidth(This) -> boolean()
109
110              Types:
111
112                 This = wxFont()
113
114              See external documentation.
115
116       getDefaultEncoding() -> wx:wx_enum()
117
118              See external documentation.
119              Res   =   ?wxFONTENCODING_SYSTEM   |  ?wxFONTENCODING_DEFAULT  |
120              ?wxFONTENCODING_ISO8859_1    |    ?wxFONTENCODING_ISO8859_2    |
121              ?wxFONTENCODING_ISO8859_3    |    ?wxFONTENCODING_ISO8859_4    |
122              ?wxFONTENCODING_ISO8859_5    |    ?wxFONTENCODING_ISO8859_6    |
123              ?wxFONTENCODING_ISO8859_7    |    ?wxFONTENCODING_ISO8859_8    |
124              ?wxFONTENCODING_ISO8859_9   |    ?wxFONTENCODING_ISO8859_10    |
125              ?wxFONTENCODING_ISO8859_11    |   ?wxFONTENCODING_ISO8859_12   |
126              ?wxFONTENCODING_ISO8859_13   |   ?wxFONTENCODING_ISO8859_14    |
127              ?wxFONTENCODING_ISO8859_15   |   ?wxFONTENCODING_ISO8859_MAX   |
128              ?wxFONTENCODING_KOI8 |  ?wxFONTENCODING_KOI8_U  |  ?wxFONTENCOD‐
129              ING_ALTERNATIVE   |  ?wxFONTENCODING_BULGARIAN  |  ?wxFONTENCOD‐
130              ING_CP437  |  ?wxFONTENCODING_CP850  |  ?wxFONTENCODING_CP852  |
131              ?wxFONTENCODING_CP855  |  ?wxFONTENCODING_CP866  | ?wxFONTENCOD‐
132              ING_CP874  |  ?wxFONTENCODING_CP932  |  ?wxFONTENCODING_CP936  |
133              ?wxFONTENCODING_CP949  |  ?wxFONTENCODING_CP950  | ?wxFONTENCOD‐
134              ING_CP1250 | ?wxFONTENCODING_CP1251 |  ?wxFONTENCODING_CP1252  |
135              ?wxFONTENCODING_CP1253  | ?wxFONTENCODING_CP1254 | ?wxFONTENCOD‐
136              ING_CP1255 | ?wxFONTENCODING_CP1256 |  ?wxFONTENCODING_CP1257  |
137              ?wxFONTENCODING_CP12_MAX  | ?wxFONTENCODING_UTF7 | ?wxFONTENCOD‐
138              ING_UTF8 | ?wxFONTENCODING_EUC_JP  |  ?wxFONTENCODING_UTF16BE  |
139              ?wxFONTENCODING_UTF16LE      |     ?wxFONTENCODING_UTF32BE     |
140              ?wxFONTENCODING_UTF32LE     |     ?wxFONTENCODING_MACROMAN     |
141              ?wxFONTENCODING_MACJAPANESE  |  ?wxFONTENCODING_MACCHINESETRAD |
142              ?wxFONTENCODING_MACKOREAN    |    ?wxFONTENCODING_MACARABIC    |
143              ?wxFONTENCODING_MACHEBREW     |    ?wxFONTENCODING_MACGREEK    |
144              ?wxFONTENCODING_MACCYRILLIC  |  ?wxFONTENCODING_MACDEVANAGARI  |
145              ?wxFONTENCODING_MACGURMUKHI   |   ?wxFONTENCODING_MACGUJARATI  |
146              ?wxFONTENCODING_MACORIYA    |    ?wxFONTENCODING_MACBENGALI    |
147              ?wxFONTENCODING_MACTAMIL     |    ?wxFONTENCODING_MACTELUGU    |
148              ?wxFONTENCODING_MACKANNADA  |   ?wxFONTENCODING_MACMALAJALAM   |
149              ?wxFONTENCODING_MACSINHALESE   |   ?wxFONTENCODING_MACBURMESE  |
150              ?wxFONTENCODING_MACKHMER     |     ?wxFONTENCODING_MACTHAI     |
151              ?wxFONTENCODING_MACLAOTIAN   |   ?wxFONTENCODING_MACGEORGIAN   |
152              ?wxFONTENCODING_MACARMENIAN |  ?wxFONTENCODING_MACCHINESESIMP  |
153              ?wxFONTENCODING_MACTIBETAN   |   ?wxFONTENCODING_MACMONGOLIAN  |
154              ?wxFONTENCODING_MACETHIOPIC  |  ?wxFONTENCODING_MACCENTRALEUR  |
155              ?wxFONTENCODING_MACVIATNAMESE  |  ?wxFONTENCODING_MACARABICEXT |
156              ?wxFONTENCODING_MACSYMBOL   |   ?wxFONTENCODING_MACDINGBATS    |
157              ?wxFONTENCODING_MACTURKISH   |   ?wxFONTENCODING_MACCROATIAN   |
158              ?wxFONTENCODING_MACICELANDIC  |  ?wxFONTENCODING_MACROMANIAN   |
159              ?wxFONTENCODING_MACCELTIC    |    ?wxFONTENCODING_MACGAELIC    |
160              ?wxFONTENCODING_MACKEYBOARD     |     ?wxFONTENCODING_MAX      |
161              ?wxFONTENCODING_MACMIN  | ?wxFONTENCODING_MACMAX | ?wxFONTENCOD‐
162              ING_UTF16 | ?wxFONTENCODING_UTF32  |  ?wxFONTENCODING_UNICODE  |
163              ?wxFONTENCODING_GB2312  |  ?wxFONTENCODING_BIG5  | ?wxFONTENCOD‐
164              ING_SHIFT_JIS
165
166       getFaceName(This) -> unicode:charlist()
167
168              Types:
169
170                 This = wxFont()
171
172              See external documentation.
173
174       getFamily(This) -> wx:wx_enum()
175
176              Types:
177
178                 This = wxFont()
179
180              See external documentation.
181              Res  =  ?wxFONTFAMILY_DEFAULT   |   ?wxFONTFAMILY_DECORATIVE   |
182              ?wxFONTFAMILY_ROMAN | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS
183              | ?wxFONTFAMILY_MODERN |  ?wxFONTFAMILY_TELETYPE  |  ?wxFONTFAM‐
184              ILY_MAX | ?wxFONTFAMILY_UNKNOWN
185
186       getNativeFontInfoDesc(This) -> unicode:charlist()
187
188              Types:
189
190                 This = wxFont()
191
192              See external documentation.
193
194       getNativeFontInfoUserDesc(This) -> unicode:charlist()
195
196              Types:
197
198                 This = wxFont()
199
200              See external documentation.
201
202       getPointSize(This) -> integer()
203
204              Types:
205
206                 This = wxFont()
207
208              See external documentation.
209
210       getStyle(This) -> wx:wx_enum()
211
212              Types:
213
214                 This = wxFont()
215
216              See external documentation.
217              Res    =    ?wxFONTSTYLE_NORMAL    |    ?wxFONTSTYLE_ITALIC    |
218              ?wxFONTSTYLE_SLANT | ?wxFONTSTYLE_MAX
219
220       getUnderlined(This) -> boolean()
221
222              Types:
223
224                 This = wxFont()
225
226              See external documentation.
227
228       getWeight(This) -> integer()
229
230              Types:
231
232                 This = wxFont()
233
234              See external documentation.
235
236       ok(This) -> boolean()
237
238              Types:
239
240                 This = wxFont()
241
242              See external documentation.
243
244       setDefaultEncoding(Encoding) -> ok
245
246              Types:
247
248                 Encoding = wx:wx_enum()
249
250              See external documentation.
251              Encoding = ?wxFONTENCODING_SYSTEM  |  ?wxFONTENCODING_DEFAULT  |
252              ?wxFONTENCODING_ISO8859_1    |    ?wxFONTENCODING_ISO8859_2    |
253              ?wxFONTENCODING_ISO8859_3    |    ?wxFONTENCODING_ISO8859_4    |
254              ?wxFONTENCODING_ISO8859_5    |    ?wxFONTENCODING_ISO8859_6    |
255              ?wxFONTENCODING_ISO8859_7    |    ?wxFONTENCODING_ISO8859_8    |
256              ?wxFONTENCODING_ISO8859_9    |    ?wxFONTENCODING_ISO8859_10   |
257              ?wxFONTENCODING_ISO8859_11   |   ?wxFONTENCODING_ISO8859_12    |
258              ?wxFONTENCODING_ISO8859_13    |   ?wxFONTENCODING_ISO8859_14   |
259              ?wxFONTENCODING_ISO8859_15   |   ?wxFONTENCODING_ISO8859_MAX   |
260              ?wxFONTENCODING_KOI8  |  ?wxFONTENCODING_KOI8_U  | ?wxFONTENCOD‐
261              ING_ALTERNATIVE  |  ?wxFONTENCODING_BULGARIAN  |   ?wxFONTENCOD‐
262              ING_CP437  |  ?wxFONTENCODING_CP850  |  ?wxFONTENCODING_CP852  |
263              ?wxFONTENCODING_CP855 |  ?wxFONTENCODING_CP866  |  ?wxFONTENCOD‐
264              ING_CP874  |  ?wxFONTENCODING_CP932  |  ?wxFONTENCODING_CP936  |
265              ?wxFONTENCODING_CP949 |  ?wxFONTENCODING_CP950  |  ?wxFONTENCOD‐
266              ING_CP1250  |  ?wxFONTENCODING_CP1251 | ?wxFONTENCODING_CP1252 |
267              ?wxFONTENCODING_CP1253 | ?wxFONTENCODING_CP1254 |  ?wxFONTENCOD‐
268              ING_CP1255  |  ?wxFONTENCODING_CP1256 | ?wxFONTENCODING_CP1257 |
269              ?wxFONTENCODING_CP12_MAX | ?wxFONTENCODING_UTF7 |  ?wxFONTENCOD‐
270              ING_UTF8  |  ?wxFONTENCODING_EUC_JP  | ?wxFONTENCODING_UTF16BE |
271              ?wxFONTENCODING_UTF16LE     |     ?wxFONTENCODING_UTF32BE      |
272              ?wxFONTENCODING_UTF32LE     |     ?wxFONTENCODING_MACROMAN     |
273              ?wxFONTENCODING_MACJAPANESE |  ?wxFONTENCODING_MACCHINESETRAD  |
274              ?wxFONTENCODING_MACKOREAN    |    ?wxFONTENCODING_MACARABIC    |
275              ?wxFONTENCODING_MACHEBREW    |    ?wxFONTENCODING_MACGREEK     |
276              ?wxFONTENCODING_MACCYRILLIC  |  ?wxFONTENCODING_MACDEVANAGARI  |
277              ?wxFONTENCODING_MACGURMUKHI  |   ?wxFONTENCODING_MACGUJARATI   |
278              ?wxFONTENCODING_MACORIYA    |    ?wxFONTENCODING_MACBENGALI    |
279              ?wxFONTENCODING_MACTAMIL    |    ?wxFONTENCODING_MACTELUGU     |
280              ?wxFONTENCODING_MACKANNADA   |   ?wxFONTENCODING_MACMALAJALAM  |
281              ?wxFONTENCODING_MACSINHALESE  |   ?wxFONTENCODING_MACBURMESE   |
282              ?wxFONTENCODING_MACKHMER     |     ?wxFONTENCODING_MACTHAI     |
283              ?wxFONTENCODING_MACLAOTIAN   |   ?wxFONTENCODING_MACGEORGIAN   |
284              ?wxFONTENCODING_MACARMENIAN  |  ?wxFONTENCODING_MACCHINESESIMP |
285              ?wxFONTENCODING_MACTIBETAN  |   ?wxFONTENCODING_MACMONGOLIAN   |
286              ?wxFONTENCODING_MACETHIOPIC  |  ?wxFONTENCODING_MACCENTRALEUR  |
287              ?wxFONTENCODING_MACVIATNAMESE |  ?wxFONTENCODING_MACARABICEXT  |
288              ?wxFONTENCODING_MACSYMBOL    |   ?wxFONTENCODING_MACDINGBATS   |
289              ?wxFONTENCODING_MACTURKISH   |   ?wxFONTENCODING_MACCROATIAN   |
290              ?wxFONTENCODING_MACICELANDIC   |  ?wxFONTENCODING_MACROMANIAN  |
291              ?wxFONTENCODING_MACCELTIC    |    ?wxFONTENCODING_MACGAELIC    |
292              ?wxFONTENCODING_MACKEYBOARD      |     ?wxFONTENCODING_MAX     |
293              ?wxFONTENCODING_MACMIN | ?wxFONTENCODING_MACMAX |  ?wxFONTENCOD‐
294              ING_UTF16  |  ?wxFONTENCODING_UTF32  | ?wxFONTENCODING_UNICODE |
295              ?wxFONTENCODING_GB2312 |  ?wxFONTENCODING_BIG5  |  ?wxFONTENCOD‐
296              ING_SHIFT_JIS
297
298       setFaceName(This, FaceName) -> boolean()
299
300              Types:
301
302                 This = wxFont()
303                 FaceName = unicode:chardata()
304
305              See external documentation.
306
307       setFamily(This, Family) -> ok
308
309              Types:
310
311                 This = wxFont()
312                 Family = wx:wx_enum()
313
314              See external documentation.
315              Family  =  ?wxFONTFAMILY_DEFAULT  |  ?wxFONTFAMILY_DECORATIVE  |
316              ?wxFONTFAMILY_ROMAN | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS
317              |  ?wxFONTFAMILY_MODERN  |  ?wxFONTFAMILY_TELETYPE | ?wxFONTFAM‐
318              ILY_MAX | ?wxFONTFAMILY_UNKNOWN
319
320       setPointSize(This, PointSize) -> ok
321
322              Types:
323
324                 This = wxFont()
325                 PointSize = integer()
326
327              See external documentation.
328
329       setStyle(This, Style) -> ok
330
331              Types:
332
333                 This = wxFont()
334                 Style = wx:wx_enum()
335
336              See external documentation.
337              Style   =   ?wxFONTSTYLE_NORMAL    |    ?wxFONTSTYLE_ITALIC    |
338              ?wxFONTSTYLE_SLANT | ?wxFONTSTYLE_MAX
339
340       setUnderlined(This, Underlined) -> ok
341
342              Types:
343
344                 This = wxFont()
345                 Underlined = boolean()
346
347              See external documentation.
348
349       setWeight(This, Weight) -> ok
350
351              Types:
352
353                 This = wxFont()
354                 Weight = integer()
355
356              See external documentation.
357
358       destroy(This::wxFont()) -> ok
359
360              Destroys this object, do not use object again
361

AUTHORS

363       <>
364
365
366
367                                   wx 1.8.9                          wxFont(3)