]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/_intl.i
Added docstrings
[wxWidgets.git] / wxPython / src / _intl.i
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: _intl.i
3 // Purpose: SWIG interface file for wxLocale and related classes
4 //
5 // Author: Robin Dunn
6 //
7 // Created: 1-Apr-2002
8 // RCS-ID: $Id$
9 // Copyright: (c) 2002 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
12
13 // Not a %module
14
15
16 //---------------------------------------------------------------------------
17
18 %{
19 %}
20
21 //---------------------------------------------------------------------------
22 %newgroup
23
24
25 enum wxLanguage
26 {
27 // user's default/preffered language as got from OS:
28 wxLANGUAGE_DEFAULT,
29 // unknown language, if wxLocale::GetSystemLanguage fails:
30 wxLANGUAGE_UNKNOWN,
31
32 wxLANGUAGE_ABKHAZIAN,
33 wxLANGUAGE_AFAR,
34 wxLANGUAGE_AFRIKAANS,
35 wxLANGUAGE_ALBANIAN,
36 wxLANGUAGE_AMHARIC,
37 wxLANGUAGE_ARABIC,
38 wxLANGUAGE_ARABIC_ALGERIA,
39 wxLANGUAGE_ARABIC_BAHRAIN,
40 wxLANGUAGE_ARABIC_EGYPT,
41 wxLANGUAGE_ARABIC_IRAQ,
42 wxLANGUAGE_ARABIC_JORDAN,
43 wxLANGUAGE_ARABIC_KUWAIT,
44 wxLANGUAGE_ARABIC_LEBANON,
45 wxLANGUAGE_ARABIC_LIBYA,
46 wxLANGUAGE_ARABIC_MOROCCO,
47 wxLANGUAGE_ARABIC_OMAN,
48 wxLANGUAGE_ARABIC_QATAR,
49 wxLANGUAGE_ARABIC_SAUDI_ARABIA,
50 wxLANGUAGE_ARABIC_SUDAN,
51 wxLANGUAGE_ARABIC_SYRIA,
52 wxLANGUAGE_ARABIC_TUNISIA,
53 wxLANGUAGE_ARABIC_UAE,
54 wxLANGUAGE_ARABIC_YEMEN,
55 wxLANGUAGE_ARMENIAN,
56 wxLANGUAGE_ASSAMESE,
57 wxLANGUAGE_AYMARA,
58 wxLANGUAGE_AZERI,
59 wxLANGUAGE_AZERI_CYRILLIC,
60 wxLANGUAGE_AZERI_LATIN,
61 wxLANGUAGE_BASHKIR,
62 wxLANGUAGE_BASQUE,
63 wxLANGUAGE_BELARUSIAN,
64 wxLANGUAGE_BENGALI,
65 wxLANGUAGE_BHUTANI,
66 wxLANGUAGE_BIHARI,
67 wxLANGUAGE_BISLAMA,
68 wxLANGUAGE_BRETON,
69 wxLANGUAGE_BULGARIAN,
70 wxLANGUAGE_BURMESE,
71 wxLANGUAGE_CAMBODIAN,
72 wxLANGUAGE_CATALAN,
73 wxLANGUAGE_CHINESE,
74 wxLANGUAGE_CHINESE_SIMPLIFIED,
75 wxLANGUAGE_CHINESE_TRADITIONAL,
76 wxLANGUAGE_CHINESE_HONGKONG,
77 wxLANGUAGE_CHINESE_MACAU,
78 wxLANGUAGE_CHINESE_SINGAPORE,
79 wxLANGUAGE_CHINESE_TAIWAN,
80 wxLANGUAGE_CORSICAN,
81 wxLANGUAGE_CROATIAN,
82 wxLANGUAGE_CZECH,
83 wxLANGUAGE_DANISH,
84 wxLANGUAGE_DUTCH,
85 wxLANGUAGE_DUTCH_BELGIAN,
86 wxLANGUAGE_ENGLISH,
87 wxLANGUAGE_ENGLISH_UK,
88 wxLANGUAGE_ENGLISH_US,
89 wxLANGUAGE_ENGLISH_AUSTRALIA,
90 wxLANGUAGE_ENGLISH_BELIZE,
91 wxLANGUAGE_ENGLISH_BOTSWANA,
92 wxLANGUAGE_ENGLISH_CANADA,
93 wxLANGUAGE_ENGLISH_CARIBBEAN,
94 wxLANGUAGE_ENGLISH_DENMARK,
95 wxLANGUAGE_ENGLISH_EIRE,
96 wxLANGUAGE_ENGLISH_JAMAICA,
97 wxLANGUAGE_ENGLISH_NEW_ZEALAND,
98 wxLANGUAGE_ENGLISH_PHILIPPINES,
99 wxLANGUAGE_ENGLISH_SOUTH_AFRICA,
100 wxLANGUAGE_ENGLISH_TRINIDAD,
101 wxLANGUAGE_ENGLISH_ZIMBABWE,
102 wxLANGUAGE_ESPERANTO,
103 wxLANGUAGE_ESTONIAN,
104 wxLANGUAGE_FAEROESE,
105 wxLANGUAGE_FARSI,
106 wxLANGUAGE_FIJI,
107 wxLANGUAGE_FINNISH,
108 wxLANGUAGE_FRENCH,
109 wxLANGUAGE_FRENCH_BELGIAN,
110 wxLANGUAGE_FRENCH_CANADIAN,
111 wxLANGUAGE_FRENCH_LUXEMBOURG,
112 wxLANGUAGE_FRENCH_MONACO,
113 wxLANGUAGE_FRENCH_SWISS,
114 wxLANGUAGE_FRISIAN,
115 wxLANGUAGE_GALICIAN,
116 wxLANGUAGE_GEORGIAN,
117 wxLANGUAGE_GERMAN,
118 wxLANGUAGE_GERMAN_AUSTRIAN,
119 wxLANGUAGE_GERMAN_BELGIUM,
120 wxLANGUAGE_GERMAN_LIECHTENSTEIN,
121 wxLANGUAGE_GERMAN_LUXEMBOURG,
122 wxLANGUAGE_GERMAN_SWISS,
123 wxLANGUAGE_GREEK,
124 wxLANGUAGE_GREENLANDIC,
125 wxLANGUAGE_GUARANI,
126 wxLANGUAGE_GUJARATI,
127 wxLANGUAGE_HAUSA,
128 wxLANGUAGE_HEBREW,
129 wxLANGUAGE_HINDI,
130 wxLANGUAGE_HUNGARIAN,
131 wxLANGUAGE_ICELANDIC,
132 wxLANGUAGE_INDONESIAN,
133 wxLANGUAGE_INTERLINGUA,
134 wxLANGUAGE_INTERLINGUE,
135 wxLANGUAGE_INUKTITUT,
136 wxLANGUAGE_INUPIAK,
137 wxLANGUAGE_IRISH,
138 wxLANGUAGE_ITALIAN,
139 wxLANGUAGE_ITALIAN_SWISS,
140 wxLANGUAGE_JAPANESE,
141 wxLANGUAGE_JAVANESE,
142 wxLANGUAGE_KANNADA,
143 wxLANGUAGE_KASHMIRI,
144 wxLANGUAGE_KASHMIRI_INDIA,
145 wxLANGUAGE_KAZAKH,
146 wxLANGUAGE_KERNEWEK,
147 wxLANGUAGE_KINYARWANDA,
148 wxLANGUAGE_KIRGHIZ,
149 wxLANGUAGE_KIRUNDI,
150 wxLANGUAGE_KONKANI,
151 wxLANGUAGE_KOREAN,
152 wxLANGUAGE_KURDISH,
153 wxLANGUAGE_LAOTHIAN,
154 wxLANGUAGE_LATIN,
155 wxLANGUAGE_LATVIAN,
156 wxLANGUAGE_LINGALA,
157 wxLANGUAGE_LITHUANIAN,
158 wxLANGUAGE_MACEDONIAN,
159 wxLANGUAGE_MALAGASY,
160 wxLANGUAGE_MALAY,
161 wxLANGUAGE_MALAYALAM,
162 wxLANGUAGE_MALAY_BRUNEI_DARUSSALAM,
163 wxLANGUAGE_MALAY_MALAYSIA,
164 wxLANGUAGE_MALTESE,
165 wxLANGUAGE_MANIPURI,
166 wxLANGUAGE_MAORI,
167 wxLANGUAGE_MARATHI,
168 wxLANGUAGE_MOLDAVIAN,
169 wxLANGUAGE_MONGOLIAN,
170 wxLANGUAGE_NAURU,
171 wxLANGUAGE_NEPALI,
172 wxLANGUAGE_NEPALI_INDIA,
173 wxLANGUAGE_NORWEGIAN_BOKMAL,
174 wxLANGUAGE_NORWEGIAN_NYNORSK,
175 wxLANGUAGE_OCCITAN,
176 wxLANGUAGE_ORIYA,
177 wxLANGUAGE_OROMO,
178 wxLANGUAGE_PASHTO,
179 wxLANGUAGE_POLISH,
180 wxLANGUAGE_PORTUGUESE,
181 wxLANGUAGE_PORTUGUESE_BRAZILIAN,
182 wxLANGUAGE_PUNJABI,
183 wxLANGUAGE_QUECHUA,
184 wxLANGUAGE_RHAETO_ROMANCE,
185 wxLANGUAGE_ROMANIAN,
186 wxLANGUAGE_RUSSIAN,
187 wxLANGUAGE_RUSSIAN_UKRAINE,
188 wxLANGUAGE_SAMOAN,
189 wxLANGUAGE_SANGHO,
190 wxLANGUAGE_SANSKRIT,
191 wxLANGUAGE_SCOTS_GAELIC,
192 wxLANGUAGE_SERBIAN,
193 wxLANGUAGE_SERBIAN_CYRILLIC,
194 wxLANGUAGE_SERBIAN_LATIN,
195 wxLANGUAGE_SERBO_CROATIAN,
196 wxLANGUAGE_SESOTHO,
197 wxLANGUAGE_SETSWANA,
198 wxLANGUAGE_SHONA,
199 wxLANGUAGE_SINDHI,
200 wxLANGUAGE_SINHALESE,
201 wxLANGUAGE_SISWATI,
202 wxLANGUAGE_SLOVAK,
203 wxLANGUAGE_SLOVENIAN,
204 wxLANGUAGE_SOMALI,
205 wxLANGUAGE_SPANISH,
206 wxLANGUAGE_SPANISH_ARGENTINA,
207 wxLANGUAGE_SPANISH_BOLIVIA,
208 wxLANGUAGE_SPANISH_CHILE,
209 wxLANGUAGE_SPANISH_COLOMBIA,
210 wxLANGUAGE_SPANISH_COSTA_RICA,
211 wxLANGUAGE_SPANISH_DOMINICAN_REPUBLIC,
212 wxLANGUAGE_SPANISH_ECUADOR,
213 wxLANGUAGE_SPANISH_EL_SALVADOR,
214 wxLANGUAGE_SPANISH_GUATEMALA,
215 wxLANGUAGE_SPANISH_HONDURAS,
216 wxLANGUAGE_SPANISH_MEXICAN,
217 wxLANGUAGE_SPANISH_MODERN,
218 wxLANGUAGE_SPANISH_NICARAGUA,
219 wxLANGUAGE_SPANISH_PANAMA,
220 wxLANGUAGE_SPANISH_PARAGUAY,
221 wxLANGUAGE_SPANISH_PERU,
222 wxLANGUAGE_SPANISH_PUERTO_RICO,
223 wxLANGUAGE_SPANISH_URUGUAY,
224 wxLANGUAGE_SPANISH_US,
225 wxLANGUAGE_SPANISH_VENEZUELA,
226 wxLANGUAGE_SUNDANESE,
227 wxLANGUAGE_SWAHILI,
228 wxLANGUAGE_SWEDISH,
229 wxLANGUAGE_SWEDISH_FINLAND,
230 wxLANGUAGE_TAGALOG,
231 wxLANGUAGE_TAJIK,
232 wxLANGUAGE_TAMIL,
233 wxLANGUAGE_TATAR,
234 wxLANGUAGE_TELUGU,
235 wxLANGUAGE_THAI,
236 wxLANGUAGE_TIBETAN,
237 wxLANGUAGE_TIGRINYA,
238 wxLANGUAGE_TONGA,
239 wxLANGUAGE_TSONGA,
240 wxLANGUAGE_TURKISH,
241 wxLANGUAGE_TURKMEN,
242 wxLANGUAGE_TWI,
243 wxLANGUAGE_UIGHUR,
244 wxLANGUAGE_UKRAINIAN,
245 wxLANGUAGE_URDU,
246 wxLANGUAGE_URDU_INDIA,
247 wxLANGUAGE_URDU_PAKISTAN,
248 wxLANGUAGE_UZBEK,
249 wxLANGUAGE_UZBEK_CYRILLIC,
250 wxLANGUAGE_UZBEK_LATIN,
251 wxLANGUAGE_VIETNAMESE,
252 wxLANGUAGE_VOLAPUK,
253 wxLANGUAGE_WELSH,
254 wxLANGUAGE_WOLOF,
255 wxLANGUAGE_XHOSA,
256 wxLANGUAGE_YIDDISH,
257 wxLANGUAGE_YORUBA,
258 wxLANGUAGE_ZHUANG,
259 wxLANGUAGE_ZULU,
260
261 // for custom, user-defined languages:
262 wxLANGUAGE_USER_DEFINED
263 };
264
265
266 //---------------------------------------------------------------------------
267
268
269 // wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc.
270 // translation information
271 struct wxLanguageInfo
272 {
273 int Language; // wxLanguage id
274 wxString CanonicalName; // Canonical name, e.g. fr_FR
275 wxString Description; // human-readable name of the language
276 };
277
278 // wxLocaleCategory: the category of locale settings
279 enum wxLocaleCategory
280 {
281 wxLOCALE_CAT_NUMBER,
282 wxLOCALE_CAT_DATE,
283 wxLOCALE_CAT_MONEY,
284 wxLOCALE_CAT_MAX
285 };
286
287 // wxLocaleInfo: the items understood by wxLocale::GetInfo()
288 enum wxLocaleInfo
289 {
290 wxLOCALE_THOUSANDS_SEP,
291 wxLOCALE_DECIMAL_POINT
292
293 };
294
295 // wxLocale: encapsulates all language dependent settings, including current
296 // message catalogs, date, time and currency formats (TODO) &c
297 enum wxLocaleInitFlags
298 {
299 wxLOCALE_LOAD_DEFAULT = 0x0001, // load wxwin.mo?
300 wxLOCALE_CONV_ENCODING = 0x0002 // convert encoding on the fly?
301 };
302
303
304 //---------------------------------------------------------------------------
305
306 class wxLocale
307 {
308 public:
309 // ctor & dtor
310 // -----------
311 wxLocale(int language = wxLANGUAGE_DEFAULT,
312 int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
313
314 // restores old locale
315 ~wxLocale();
316
317 %name(Init1)bool Init(const wxString& szName,
318 const wxString& szShort = wxPyEmptyString,
319 const wxString& szLocale = wxPyEmptyString,
320 bool bLoadDefault = True,
321 bool bConvertEncoding = False);
322
323 %name(Init2) bool Init(int language = wxLANGUAGE_DEFAULT,
324 int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
325
326 %pythoncode {
327 def Init(self, *_args, **_kwargs):
328 if type(_args[0]) in [type(''), type(u'')]:
329 val = self.Init1(*_args, **_kwargs)
330 else:
331 val = self.Init2(*_args, **_kwargs)
332 return val
333 }
334
335 // Try to get user's (or OS's) prefered language setting.
336 // Return wxLANGUAGE_UNKNOWN if language-guessing algorithm failed
337 static int GetSystemLanguage();
338
339 // get the encoding used by default for text on this system, returns
340 // wxFONTENCODING_SYSTEM if it couldn't be determined
341 static wxFontEncoding GetSystemEncoding();
342
343 // get the string describing the system encoding, return empty string if
344 // couldn't be determined
345 static wxString GetSystemEncodingName();
346
347
348 // THIS ONE IS COMMENTED OUT IN src/common/intl.cpp
349 // get the values of the given locale-dependent datum: the current locale
350 // is used, the US default value is returned if everything else fails
351 // static wxString GetInfo(wxLocaleInfo index, wxLocaleCategory cat);
352
353 // return True if the locale was set successfully
354 bool IsOk() const;
355 %pythoncode { def __nonzero__(self): return self.IsOk() };
356
357 // returns locale name
358 wxString GetLocale() const;
359
360 // return current locale wxLanguage value
361 int GetLanguage() const;
362
363 // return locale name to be passed to setlocale()
364 wxString GetSysName() const;
365
366 // return 'canonical' name, i.e. in the form of xx[_YY], where xx is
367 // language code according to ISO 639 and YY is country name
368 // as specified by ISO 3166.
369 wxString GetCanonicalName() const;
370
371 // add a prefix to the catalog lookup path: the message catalog files will be
372 // looked up under prefix/<lang>/LC_MESSAGES, prefix/LC_MESSAGES and prefix
373 // (in this order).
374 //
375 // This only applies to subsequent invocations of AddCatalog()!
376 static void AddCatalogLookupPathPrefix(const wxString& prefix);
377
378 // add a catalog: it's searched for in standard places (current directory
379 // first, system one after), but the you may prepend additional directories to
380 // the search path with AddCatalogLookupPathPrefix().
381 //
382 // The loaded catalog will be used for message lookup by GetString().
383 //
384 // Returns 'True' if it was successfully loaded
385 bool AddCatalog(const wxString& szDomain);
386
387 // check if the given catalog is loaded
388 bool IsLoaded(const wxString& szDomain) const;
389
390 // Retrieve the language info struct for the given language
391 //
392 // Returns NULL if no info found, pointer must *not* be deleted by caller
393 static const wxLanguageInfo *GetLanguageInfo(int lang);
394
395 // Returns language name in English or empty string if the language
396 // is not in database
397 static wxString GetLanguageName(int lang);
398
399 // Find the language for the given locale string which may be either a
400 // canonical ISO 2 letter language code ("xx"), a language code followed by
401 // the country code ("xx_XX") or a Windows full language name ("Xxxxx...")
402 //
403 // Returns NULL if no info found, pointer must *not* be deleted by caller
404 static const wxLanguageInfo *FindLanguageInfo(const wxString& locale);
405
406 // Add custom language to the list of known languages.
407 // Notes: 1) wxLanguageInfo contains platform-specific data
408 // 2) must be called before Init to have effect
409 static void AddLanguage(const wxLanguageInfo& info);
410
411 // retrieve the translation for a string in all loaded domains unless
412 // the szDomain parameter is specified (and then only this domain is
413 // searched)
414 //
415 // return original string if translation is not available
416 // (in this case an error message is generated the first time
417 // a string is not found; use wxLogNull to suppress it)
418 //
419 // domains are searched in the last to first order, i.e. catalogs
420 // added later override those added before.
421 wxString GetString(const wxString& szOrigString,
422 const wxString& szDomain = wxPyEmptyString) const;
423
424 // Returns the current short name for the locale
425 const wxString& GetName() const;
426
427 };
428
429
430
431 // get the current locale object (note that it may be NULL!)
432 wxLocale* wxGetLocale();
433
434 // get the translation of the string in the current locale
435 %nokwargs wxGetTranslation;
436 wxString wxGetTranslation(const wxString& str);
437 wxString wxGetTranslation(const wxString& str, const wxString& strPlural, size_t n);
438
439 //---------------------------------------------------------------------------
440 %newgroup
441
442
443 // wxEncodingConverter
444 // This class is capable of converting strings between any two
445 // 8bit encodings/charsets. It can also convert from/to Unicode
446
447
448 %typemap(out) wxFontEncodingArray {
449 $result = PyList_New(0);
450 for (size_t i=0; i < $1.GetCount(); i++) {
451 PyObject* number = PyInt_FromLong($1.Item(i));
452 PyList_Append($result, number);
453 Py_DECREF(number);
454 }
455 }
456
457
458 enum
459 {
460 wxCONVERT_STRICT,
461 wxCONVERT_SUBSTITUTE
462 };
463
464
465 enum
466 {
467 wxPLATFORM_CURRENT = -1,
468
469 wxPLATFORM_UNIX = 0,
470 wxPLATFORM_WINDOWS,
471 wxPLATFORM_OS2,
472 wxPLATFORM_MAC
473 };
474
475
476 class wxEncodingConverter : public wxObject
477 {
478 public:
479
480 wxEncodingConverter();
481 ~wxEncodingConverter();
482
483
484 // Initialize convertion. Both output or input encoding may
485 // be wxFONTENCODING_UNICODE, but only if wxUSE_WCHAR_T is set to 1.
486 //
487 // All subsequent calls to Convert() will interpret it's argument
488 // as a string in input_enc encoding and will output string in
489 // output_enc encoding.
490 //
491 // You must call this method before calling Convert. You may call
492 // it more than once in order to switch to another conversion
493 //
494 // Method affects behaviour of Convert() in case input character
495 // cannot be converted because it does not exist in output encoding:
496 // wxCONVERT_STRICT --
497 // follow behaviour of GNU Recode - just copy unconvertable
498 // characters to output and don't change them (it's integer
499 // value will stay the same)
500 // wxCONVERT_SUBSTITUTE --
501 // try some (lossy) substitutions - e.g. replace
502 // unconvertable latin capitals with acute by ordinary
503 // capitals, replace en-dash or em-dash by '-' etc.
504 // both modes gurantee that output string will have same length
505 // as input string
506 //
507 // Returns False if given conversion is impossible, True otherwise
508 // (conversion may be impossible either if you try to convert
509 // to Unicode with non-Unicode build of wxWindows or if input
510 // or output encoding is not supported.)
511 bool Init(wxFontEncoding input_enc, wxFontEncoding output_enc, int method = wxCONVERT_STRICT);
512
513
514 // TODO: Need to do something about unicode mode...
515
516 // Convert input string according to settings passed to Init.
517 // Note that you must call Init before using Convert!
518 wxString Convert(const wxString& input);
519
520 // void Convert(const char* input, char* output);
521
522 // #if wxUSE_WCHAR_T
523 // void Convert(const char* input, wchar_t* output);
524 // void Convert(const wchar_t* input, char* output);
525 // void Convert(const wchar_t* input, wchar_t* output);
526 // void Convert(wchar_t* str) { Convert(str, str); }
527 // #endif
528
529
530
531 // Return equivalent(s) for given font that are used
532 // under given platform. wxPLATFORM_CURRENT means the plaform
533 // this binary was compiled for
534 //
535 // Examples:
536 // current platform enc returned value
537 // -----------------------------------------------------
538 // unix CP1250 {ISO8859_2}
539 // unix ISO8859_2 {}
540 // windows ISO8859_2 {CP1250}
541 //
542 // Equivalence is defined in terms of convertibility:
543 // 2 encodings are equivalent if you can convert text between
544 // then without loosing information (it may - and will - happen
545 // that you loose special chars like quotation marks or em-dashes
546 // but you shouldn't loose any diacritics and language-specific
547 // characters when converting between equivalent encodings).
548 //
549 // Convert() method is not limited to converting between
550 // equivalent encodings, it can convert between arbitrary
551 // two encodings!
552 //
553 // Remember that this function does _NOT_ check for presence of
554 // fonts in system. It only tells you what are most suitable
555 // encodings. (It usually returns only one encoding)
556 //
557 // Note that argument enc itself may be present in returned array!
558 // (so that you can -- as a side effect -- detect whether the
559 // encoding is native for this platform or not)
560 static wxFontEncodingArray GetPlatformEquivalents(wxFontEncoding enc,
561 int platform = wxPLATFORM_CURRENT);
562
563 // Similar to GetPlatformEquivalent, but this one will return ALL
564 // equivalent encodings, regardless the platform, including itself.
565 static wxFontEncodingArray GetAllEquivalents(wxFontEncoding enc);
566
567 // Return True if [any text in] one multibyte encoding can be
568 // converted to another one losslessly.
569 //
570 // Do not call this with wxFONTENCODING_UNICODE, it doesn't make
571 // sense (always works in one sense and always depends on the text
572 // to convert in the other)
573 static bool CanConvert(wxFontEncoding encIn, wxFontEncoding encOut);
574
575 %pythoncode { def __nonzero__(self): return self.IsOk() }
576 };
577
578
579
580
581 //---------------------------------------------------------------------------
582
583 %pythoncode "_intl_ex.py"
584
585 //---------------------------------------------------------------------------