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

NAME

6       wxLocale - See external documentation: wxLocale.
7

DESCRIPTION

9       See external documentation: wxLocale.
10

DATA TYPES

12         wxLocale():
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() -> wxLocale()
21
22              See external documentation.
23
24       new(Language) -> wxLocale()
25
26              Types:
27
28                 Language = integer()
29
30              Equivalent to new(Language, []).
31
32       new(Language, Options::[Option]) -> wxLocale()
33
34              Types:
35
36                 Language = integer()
37                 Option = {flags, integer()}
38
39              See external documentation.
40
41       init(This) -> boolean()
42
43              Types:
44
45                 This = wxLocale()
46
47              Equivalent to init(This, []).
48
49       init(This, Options::[Option]) -> boolean()
50
51              Types:
52
53                 This = wxLocale()
54                 Option = {language, integer()} | {flags, integer()}
55
56              See external documentation.
57
58       addCatalog(This, SzDomain) -> boolean()
59
60              Types:
61
62                 This = wxLocale()
63                 SzDomain = unicode:chardata()
64
65              See external documentation.
66
67       addCatalog(This, SzDomain, MsgIdLanguage, MsgIdCharset) -> boolean()
68
69              Types:
70
71                 This = wxLocale()
72                 SzDomain = unicode:chardata()
73                 MsgIdLanguage = wx:wx_enum()
74                 MsgIdCharset = unicode:chardata()
75
76              See external documentation.
77              MsgIdLanguage  =  ?wxLANGUAGE_DEFAULT  |  ?wxLANGUAGE_UNKNOWN  |
78              ?wxLANGUAGE_ABKHAZIAN | ?wxLANGUAGE_AFAR | ?wxLANGUAGE_AFRIKAANS
79              |  ?wxLANGUAGE_ALBANIAN | ?wxLANGUAGE_AMHARIC | ?wxLANGUAGE_ARA‐
80              BIC | ?wxLANGUAGE_ARABIC_ALGERIA | ?wxLANGUAGE_ARABIC_BAHRAIN  |
81              ?wxLANGUAGE_ARABIC_EGYPT  |  ?wxLANGUAGE_ARABIC_IRAQ  |  ?wxLAN‐
82              GUAGE_ARABIC_JORDAN  |   ?wxLANGUAGE_ARABIC_KUWAIT   |   ?wxLAN‐
83              GUAGE_ARABIC_LEBANON   |   ?wxLANGUAGE_ARABIC_LIBYA   |  ?wxLAN‐
84              GUAGE_ARABIC_MOROCCO   |   ?wxLANGUAGE_ARABIC_OMAN   |   ?wxLAN‐
85              GUAGE_ARABIC_QATAR  |  ?wxLANGUAGE_ARABIC_SAUDI_ARABIA | ?wxLAN‐
86              GUAGE_ARABIC_SUDAN | ?wxLANGUAGE_ARABIC_SYRIA | ?wxLANGUAGE_ARA‐
87              BIC_TUNISIA  | ?wxLANGUAGE_ARABIC_UAE | ?wxLANGUAGE_ARABIC_YEMEN
88              |  ?wxLANGUAGE_ARMENIAN   |   ?wxLANGUAGE_ASSAMESE   |   ?wxLAN‐
89              GUAGE_AYMARA  | ?wxLANGUAGE_AZERI | ?wxLANGUAGE_AZERI_CYRILLIC |
90              ?wxLANGUAGE_AZERI_LATIN   |   ?wxLANGUAGE_BASHKIR   |    ?wxLAN‐
91              GUAGE_BASQUE  |  ?wxLANGUAGE_BELARUSIAN  | ?wxLANGUAGE_BENGALI |
92              ?wxLANGUAGE_BHUTANI | ?wxLANGUAGE_BIHARI | ?wxLANGUAGE_BISLAMA |
93              ?wxLANGUAGE_BRETON | ?wxLANGUAGE_BULGARIAN | ?wxLANGUAGE_BURMESE
94              | ?wxLANGUAGE_CAMBODIAN | ?wxLANGUAGE_CATALAN | ?wxLANGUAGE_CHI‐
95              NESE | ?wxLANGUAGE_CHINESE_SIMPLIFIED | ?wxLANGUAGE_CHINESE_TRA‐
96              DITIONAL  |  ?wxLANGUAGE_CHINESE_HONGKONG   |   ?wxLANGUAGE_CHI‐
97              NESE_MACAU  |  ?wxLANGUAGE_CHINESE_SINGAPORE  | ?wxLANGUAGE_CHI‐
98              NESE_TAIWAN  |  ?wxLANGUAGE_CORSICAN  |  ?wxLANGUAGE_CROATIAN  |
99              ?wxLANGUAGE_CZECH  |  ?wxLANGUAGE_DANISH  |  ?wxLANGUAGE_DUTCH |
100              ?wxLANGUAGE_DUTCH_BELGIAN  |   ?wxLANGUAGE_ENGLISH   |   ?wxLAN‐
101              GUAGE_ENGLISH_UK  |  ?wxLANGUAGE_ENGLISH_US  |  ?wxLANGUAGE_ENG‐
102              LISH_AUSTRALIA | ?wxLANGUAGE_ENGLISH_BELIZE  |  ?wxLANGUAGE_ENG‐
103              LISH_BOTSWANA  |  ?wxLANGUAGE_ENGLISH_CANADA  | ?wxLANGUAGE_ENG‐
104              LISH_CARIBBEAN | ?wxLANGUAGE_ENGLISH_DENMARK |  ?wxLANGUAGE_ENG‐
105              LISH_EIRE   |   ?wxLANGUAGE_ENGLISH_JAMAICA  |  ?wxLANGUAGE_ENG‐
106              LISH_NEW_ZEALAND  |  ?wxLANGUAGE_ENGLISH_PHILIPPINES  |  ?wxLAN‐
107              GUAGE_ENGLISH_SOUTH_AFRICA   |   ?wxLANGUAGE_ENGLISH_TRINIDAD  |
108              ?wxLANGUAGE_ENGLISH_ZIMBABWE | ?wxLANGUAGE_ESPERANTO  |  ?wxLAN‐
109              GUAGE_ESTONIAN  |  ?wxLANGUAGE_FAEROESE  |  ?wxLANGUAGE_FARSI  |
110              ?wxLANGUAGE_FIJI | ?wxLANGUAGE_FINNISH  |  ?wxLANGUAGE_FRENCH  |
111              ?wxLANGUAGE_FRENCH_BELGIAN   |   ?wxLANGUAGE_FRENCH_CANADIAN   |
112              ?wxLANGUAGE_FRENCH_LUXEMBOURG  |   ?wxLANGUAGE_FRENCH_MONACO   |
113              ?wxLANGUAGE_FRENCH_SWISS   |   ?wxLANGUAGE_FRISIAN   |   ?wxLAN‐
114              GUAGE_GALICIAN |  ?wxLANGUAGE_GEORGIAN  |  ?wxLANGUAGE_GERMAN  |
115              ?wxLANGUAGE_GERMAN_AUSTRIAN   |   ?wxLANGUAGE_GERMAN_BELGIUM   |
116              ?wxLANGUAGE_GERMAN_LIECHTENSTEIN | ?wxLANGUAGE_GERMAN_LUXEMBOURG
117              |   ?wxLANGUAGE_GERMAN_SWISS   |   ?wxLANGUAGE_GREEK  |  ?wxLAN‐
118              GUAGE_GREENLANDIC | ?wxLANGUAGE_GUARANI | ?wxLANGUAGE_GUJARATI |
119              ?wxLANGUAGE_HAUSA  |  ?wxLANGUAGE_HEBREW  |  ?wxLANGUAGE_HINDI |
120              ?wxLANGUAGE_HUNGARIAN   |   ?wxLANGUAGE_ICELANDIC   |    ?wxLAN‐
121              GUAGE_INDONESIAN  | ?wxLANGUAGE_INTERLINGUA | ?wxLANGUAGE_INTER‐
122              LINGUE | ?wxLANGUAGE_INUKTITUT | ?wxLANGUAGE_INUPIAK  |  ?wxLAN‐
123              GUAGE_IRISH  | ?wxLANGUAGE_ITALIAN | ?wxLANGUAGE_ITALIAN_SWISS |
124              ?wxLANGUAGE_JAPANESE | ?wxLANGUAGE_JAVANESE  |  ?wxLANGUAGE_KAN‐
125              NADA   |  ?wxLANGUAGE_KASHMIRI  |  ?wxLANGUAGE_KASHMIRI_INDIA  |
126              ?wxLANGUAGE_KAZAKH  |  ?wxLANGUAGE_KERNEWEK  |  ?wxLANGUAGE_KIN‐
127              YARWANDA  |  ?wxLANGUAGE_KIRGHIZ | ?wxLANGUAGE_KIRUNDI | ?wxLAN‐
128              GUAGE_KONKANI  |  ?wxLANGUAGE_KOREAN  |  ?wxLANGUAGE_KURDISH   |
129              ?wxLANGUAGE_LAOTHIAN | ?wxLANGUAGE_LATIN | ?wxLANGUAGE_LATVIAN |
130              ?wxLANGUAGE_LINGALA | ?wxLANGUAGE_LITHUANIAN | ?wxLANGUAGE_MACE‐
131              DONIAN  |  ?wxLANGUAGE_MALAGASY  |  ?wxLANGUAGE_MALAY  | ?wxLAN‐
132              GUAGE_MALAYALAM | ?wxLANGUAGE_MALAY_BRUNEI_DARUSSALAM |  ?wxLAN‐
133              GUAGE_MALAY_MALAYSIA    |    ?wxLANGUAGE_MALTESE    |    ?wxLAN‐
134              GUAGE_MANIPURI  |  ?wxLANGUAGE_MAORI  |  ?wxLANGUAGE_MARATHI   |
135              ?wxLANGUAGE_MOLDAVIAN    |   ?wxLANGUAGE_MONGOLIAN   |   ?wxLAN‐
136              GUAGE_NAURU | ?wxLANGUAGE_NEPALI  |  ?wxLANGUAGE_NEPALI_INDIA  |
137              ?wxLANGUAGE_NORWEGIAN_BOKMAL  |  ?wxLANGUAGE_NORWEGIAN_NYNORSK |
138              ?wxLANGUAGE_OCCITAN | ?wxLANGUAGE_ORIYA  |  ?wxLANGUAGE_OROMO  |
139              ?wxLANGUAGE_PASHTO | ?wxLANGUAGE_POLISH | ?wxLANGUAGE_PORTUGUESE
140              |  ?wxLANGUAGE_PORTUGUESE_BRAZILIAN  |   ?wxLANGUAGE_PUNJABI   |
141              ?wxLANGUAGE_QUECHUA   |   ?wxLANGUAGE_RHAETO_ROMANCE  |  ?wxLAN‐
142              GUAGE_ROMANIAN   |   ?wxLANGUAGE_RUSSIAN   |    ?wxLANGUAGE_RUS‐
143              SIAN_UKRAINE | ?wxLANGUAGE_SAMOAN | ?wxLANGUAGE_SANGHO | ?wxLAN‐
144              GUAGE_SANSKRIT | ?wxLANGUAGE_SCOTS_GAELIC |  ?wxLANGUAGE_SERBIAN
145              |  ?wxLANGUAGE_SERBIAN_CYRILLIC  |  ?wxLANGUAGE_SERBIAN_LATIN  |
146              ?wxLANGUAGE_SERBO_CROATIAN  |  ?wxLANGUAGE_SESOTHO   |   ?wxLAN‐
147              GUAGE_SETSWANA   |   ?wxLANGUAGE_SHONA  |  ?wxLANGUAGE_SINDHI  |
148              ?wxLANGUAGE_SINHALESE | ?wxLANGUAGE_SISWATI | ?wxLANGUAGE_SLOVAK
149              | ?wxLANGUAGE_SLOVENIAN | ?wxLANGUAGE_SOMALI | ?wxLANGUAGE_SPAN‐
150              ISH   |   ?wxLANGUAGE_SPANISH_ARGENTINA   |    ?wxLANGUAGE_SPAN‐
151              ISH_BOLIVIA   |  ?wxLANGUAGE_SPANISH_CHILE  |  ?wxLANGUAGE_SPAN‐
152              ISH_COLOMBIA   |   ?wxLANGUAGE_SPANISH_COSTA_RICA   |    ?wxLAN‐
153              GUAGE_SPANISH_DOMINICAN_REPUBLIC | ?wxLANGUAGE_SPANISH_ECUADOR |
154              ?wxLANGUAGE_SPANISH_EL_SALVADOR |  ?wxLANGUAGE_SPANISH_GUATEMALA
155              |  ?wxLANGUAGE_SPANISH_HONDURAS  | ?wxLANGUAGE_SPANISH_MEXICAN |
156              ?wxLANGUAGE_SPANISH_MODERN  |  ?wxLANGUAGE_SPANISH_NICARAGUA   |
157              ?wxLANGUAGE_SPANISH_PANAMA   |   ?wxLANGUAGE_SPANISH_PARAGUAY  |
158              ?wxLANGUAGE_SPANISH_PERU  |  ?wxLANGUAGE_SPANISH_PUERTO_RICO   |
159              ?wxLANGUAGE_SPANISH_URUGUAY  |  ?wxLANGUAGE_SPANISH_US | ?wxLAN‐
160              GUAGE_SPANISH_VENEZUELA  |   ?wxLANGUAGE_SUNDANESE   |   ?wxLAN‐
161              GUAGE_SWAHILI  |  ?wxLANGUAGE_SWEDISH | ?wxLANGUAGE_SWEDISH_FIN‐
162              LAND  |  ?wxLANGUAGE_TAGALOG  |  ?wxLANGUAGE_TAJIK   |   ?wxLAN‐
163              GUAGE_TAMIL  |  ?wxLANGUAGE_TATAR | ?wxLANGUAGE_TELUGU | ?wxLAN‐
164              GUAGE_THAI  |  ?wxLANGUAGE_TIBETAN  |   ?wxLANGUAGE_TIGRINYA   |
165              ?wxLANGUAGE_TONGA  |  ?wxLANGUAGE_TSONGA | ?wxLANGUAGE_TURKISH |
166              ?wxLANGUAGE_TURKMEN |  ?wxLANGUAGE_TWI  |  ?wxLANGUAGE_UIGHUR  |
167              ?wxLANGUAGE_UKRAINIAN     |     ?wxLANGUAGE_URDU    |    ?wxLAN‐
168              GUAGE_URDU_INDIA | ?wxLANGUAGE_URDU_PAKISTAN | ?wxLANGUAGE_UZBEK
169              | ?wxLANGUAGE_UZBEK_CYRILLIC | ?wxLANGUAGE_UZBEK_LATIN | ?wxLAN‐
170              GUAGE_VIETNAMESE |  ?wxLANGUAGE_VOLAPUK  |  ?wxLANGUAGE_WELSH  |
171              ?wxLANGUAGE_WOLOF  |  ?wxLANGUAGE_XHOSA  | ?wxLANGUAGE_YIDDISH |
172              ?wxLANGUAGE_YORUBA |  ?wxLANGUAGE_ZHUANG  |  ?wxLANGUAGE_ZULU  |
173              ?wxLANGUAGE_USER_DEFINED   |   ?wxLANGUAGE_VALENCIAN  |  ?wxLAN‐
174              GUAGE_SAMI
175
176       addCatalogLookupPathPrefix(Prefix) -> ok
177
178              Types:
179
180                 Prefix = unicode:chardata()
181
182              See external documentation.
183
184       getCanonicalName(This) -> unicode:charlist()
185
186              Types:
187
188                 This = wxLocale()
189
190              See external documentation.
191
192       getLanguage(This) -> integer()
193
194              Types:
195
196                 This = wxLocale()
197
198              See external documentation.
199
200       getLanguageName(Lang) -> unicode:charlist()
201
202              Types:
203
204                 Lang = integer()
205
206              See external documentation.
207
208       getLocale(This) -> unicode:charlist()
209
210              Types:
211
212                 This = wxLocale()
213
214              See external documentation.
215
216       getName(This) -> unicode:charlist()
217
218              Types:
219
220                 This = wxLocale()
221
222              See external documentation.
223
224       getString(This, SzOrigString) -> unicode:charlist()
225
226              Types:
227
228                 This = wxLocale()
229                 SzOrigString = unicode:chardata()
230
231              Equivalent to getString(This, SzOrigString, []).
232
233       getString(This, SzOrigString, Options::[Option]) -> unicode:charlist()
234
235              Types:
236
237                 This = wxLocale()
238                 SzOrigString = unicode:chardata()
239                 Option = {szDomain, unicode:chardata()}
240
241              See external documentation.
242
243       getString(This, SzOrigString, SzOrigString2, N) -> unicode:charlist()
244
245              Types:
246
247                 This = wxLocale()
248                 SzOrigString = unicode:chardata()
249                 SzOrigString2 = unicode:chardata()
250                 N = integer()
251
252              Equivalent to getString(This,  SzOrigString,  SzOrigString2,  N,
253              []).
254
255       getString(This,  SzOrigString,  SzOrigString2, N, Options::[Option]) ->
256       unicode:charlist()
257
258              Types:
259
260                 This = wxLocale()
261                 SzOrigString = unicode:chardata()
262                 SzOrigString2 = unicode:chardata()
263                 N = integer()
264                 Option = {szDomain, unicode:chardata()}
265
266              See external documentation.
267
268       getHeaderValue(This, SzHeader) -> unicode:charlist()
269
270              Types:
271
272                 This = wxLocale()
273                 SzHeader = unicode:chardata()
274
275              Equivalent to getHeaderValue(This, SzHeader, []).
276
277       getHeaderValue(This, SzHeader, Options::[Option]) -> unicode:charlist()
278
279              Types:
280
281                 This = wxLocale()
282                 SzHeader = unicode:chardata()
283                 Option = {szDomain, unicode:chardata()}
284
285              See external documentation.
286
287       getSysName(This) -> unicode:charlist()
288
289              Types:
290
291                 This = wxLocale()
292
293              See external documentation.
294
295       getSystemEncoding() -> wx:wx_enum()
296
297              See external documentation.
298              Res  =  ?wxFONTENCODING_SYSTEM   |   ?wxFONTENCODING_DEFAULT   |
299              ?wxFONTENCODING_ISO8859_1    |    ?wxFONTENCODING_ISO8859_2    |
300              ?wxFONTENCODING_ISO8859_3    |    ?wxFONTENCODING_ISO8859_4    |
301              ?wxFONTENCODING_ISO8859_5    |    ?wxFONTENCODING_ISO8859_6    |
302              ?wxFONTENCODING_ISO8859_7    |    ?wxFONTENCODING_ISO8859_8    |
303              ?wxFONTENCODING_ISO8859_9    |    ?wxFONTENCODING_ISO8859_10   |
304              ?wxFONTENCODING_ISO8859_11   |   ?wxFONTENCODING_ISO8859_12    |
305              ?wxFONTENCODING_ISO8859_13    |   ?wxFONTENCODING_ISO8859_14   |
306              ?wxFONTENCODING_ISO8859_15   |   ?wxFONTENCODING_ISO8859_MAX   |
307              ?wxFONTENCODING_KOI8  |  ?wxFONTENCODING_KOI8_U  | ?wxFONTENCOD‐
308              ING_ALTERNATIVE  |  ?wxFONTENCODING_BULGARIAN  |   ?wxFONTENCOD‐
309              ING_CP437  |  ?wxFONTENCODING_CP850  |  ?wxFONTENCODING_CP852  |
310              ?wxFONTENCODING_CP855 |  ?wxFONTENCODING_CP866  |  ?wxFONTENCOD‐
311              ING_CP874  |  ?wxFONTENCODING_CP932  |  ?wxFONTENCODING_CP936  |
312              ?wxFONTENCODING_CP949 |  ?wxFONTENCODING_CP950  |  ?wxFONTENCOD‐
313              ING_CP1250  |  ?wxFONTENCODING_CP1251 | ?wxFONTENCODING_CP1252 |
314              ?wxFONTENCODING_CP1253 | ?wxFONTENCODING_CP1254 |  ?wxFONTENCOD‐
315              ING_CP1255  |  ?wxFONTENCODING_CP1256 | ?wxFONTENCODING_CP1257 |
316              ?wxFONTENCODING_CP12_MAX | ?wxFONTENCODING_UTF7 |  ?wxFONTENCOD‐
317              ING_UTF8  |  ?wxFONTENCODING_EUC_JP  | ?wxFONTENCODING_UTF16BE |
318              ?wxFONTENCODING_UTF16LE     |     ?wxFONTENCODING_UTF32BE      |
319              ?wxFONTENCODING_UTF32LE     |     ?wxFONTENCODING_MACROMAN     |
320              ?wxFONTENCODING_MACJAPANESE |  ?wxFONTENCODING_MACCHINESETRAD  |
321              ?wxFONTENCODING_MACKOREAN    |    ?wxFONTENCODING_MACARABIC    |
322              ?wxFONTENCODING_MACHEBREW    |    ?wxFONTENCODING_MACGREEK     |
323              ?wxFONTENCODING_MACCYRILLIC  |  ?wxFONTENCODING_MACDEVANAGARI  |
324              ?wxFONTENCODING_MACGURMUKHI  |   ?wxFONTENCODING_MACGUJARATI   |
325              ?wxFONTENCODING_MACORIYA    |    ?wxFONTENCODING_MACBENGALI    |
326              ?wxFONTENCODING_MACTAMIL    |    ?wxFONTENCODING_MACTELUGU     |
327              ?wxFONTENCODING_MACKANNADA   |   ?wxFONTENCODING_MACMALAJALAM  |
328              ?wxFONTENCODING_MACSINHALESE  |   ?wxFONTENCODING_MACBURMESE   |
329              ?wxFONTENCODING_MACKHMER     |     ?wxFONTENCODING_MACTHAI     |
330              ?wxFONTENCODING_MACLAOTIAN   |   ?wxFONTENCODING_MACGEORGIAN   |
331              ?wxFONTENCODING_MACARMENIAN  |  ?wxFONTENCODING_MACCHINESESIMP |
332              ?wxFONTENCODING_MACTIBETAN  |   ?wxFONTENCODING_MACMONGOLIAN   |
333              ?wxFONTENCODING_MACETHIOPIC  |  ?wxFONTENCODING_MACCENTRALEUR  |
334              ?wxFONTENCODING_MACVIATNAMESE |  ?wxFONTENCODING_MACARABICEXT  |
335              ?wxFONTENCODING_MACSYMBOL    |   ?wxFONTENCODING_MACDINGBATS   |
336              ?wxFONTENCODING_MACTURKISH   |   ?wxFONTENCODING_MACCROATIAN   |
337              ?wxFONTENCODING_MACICELANDIC   |  ?wxFONTENCODING_MACROMANIAN  |
338              ?wxFONTENCODING_MACCELTIC    |    ?wxFONTENCODING_MACGAELIC    |
339              ?wxFONTENCODING_MACKEYBOARD      |     ?wxFONTENCODING_MAX     |
340              ?wxFONTENCODING_MACMIN | ?wxFONTENCODING_MACMAX |  ?wxFONTENCOD‐
341              ING_UTF16  |  ?wxFONTENCODING_UTF32  | ?wxFONTENCODING_UNICODE |
342              ?wxFONTENCODING_GB2312 |  ?wxFONTENCODING_BIG5  |  ?wxFONTENCOD‐
343              ING_SHIFT_JIS
344
345       getSystemEncodingName() -> unicode:charlist()
346
347              See external documentation.
348
349       getSystemLanguage() -> integer()
350
351              See external documentation.
352
353       isLoaded(This, SzDomain) -> boolean()
354
355              Types:
356
357                 This = wxLocale()
358                 SzDomain = unicode:chardata()
359
360              See external documentation.
361
362       isOk(This) -> boolean()
363
364              Types:
365
366                 This = wxLocale()
367
368              See external documentation.
369
370       destroy(This::wxLocale()) -> ok
371
372              Destroys this object, do not use object again
373

AUTHORS

375       <>
376
377
378
379                                    wx 1.9                         wxLocale(3)