1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: SWIG interface file for wxLocale and related classes
9 // Copyright: (c) 2002 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
16 //---------------------------------------------------------------------------
22 //---------------------------------------------------------------------------
27 // user's default/preffered language as got from OS:
29 // unknown language, if wxLocale::GetSystemLanguage fails:
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,
59 wxLANGUAGE_AZERI_CYRILLIC,
60 wxLANGUAGE_AZERI_LATIN,
63 wxLANGUAGE_BELARUSIAN,
74 wxLANGUAGE_CHINESE_SIMPLIFIED,
75 wxLANGUAGE_CHINESE_TRADITIONAL,
76 wxLANGUAGE_CHINESE_HONGKONG,
77 wxLANGUAGE_CHINESE_MACAU,
78 wxLANGUAGE_CHINESE_SINGAPORE,
79 wxLANGUAGE_CHINESE_TAIWAN,
85 wxLANGUAGE_DUTCH_BELGIAN,
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,
109 wxLANGUAGE_FRENCH_BELGIAN,
110 wxLANGUAGE_FRENCH_CANADIAN,
111 wxLANGUAGE_FRENCH_LUXEMBOURG,
112 wxLANGUAGE_FRENCH_MONACO,
113 wxLANGUAGE_FRENCH_SWISS,
118 wxLANGUAGE_GERMAN_AUSTRIAN,
119 wxLANGUAGE_GERMAN_BELGIUM,
120 wxLANGUAGE_GERMAN_LIECHTENSTEIN,
121 wxLANGUAGE_GERMAN_LUXEMBOURG,
122 wxLANGUAGE_GERMAN_SWISS,
124 wxLANGUAGE_GREENLANDIC,
130 wxLANGUAGE_HUNGARIAN,
131 wxLANGUAGE_ICELANDIC,
132 wxLANGUAGE_INDONESIAN,
133 wxLANGUAGE_INTERLINGUA,
134 wxLANGUAGE_INTERLINGUE,
135 wxLANGUAGE_INUKTITUT,
139 wxLANGUAGE_ITALIAN_SWISS,
144 wxLANGUAGE_KASHMIRI_INDIA,
147 wxLANGUAGE_KINYARWANDA,
157 wxLANGUAGE_LITHUANIAN,
158 wxLANGUAGE_MACEDONIAN,
161 wxLANGUAGE_MALAYALAM,
162 wxLANGUAGE_MALAY_BRUNEI_DARUSSALAM,
163 wxLANGUAGE_MALAY_MALAYSIA,
168 wxLANGUAGE_MOLDAVIAN,
169 wxLANGUAGE_MONGOLIAN,
172 wxLANGUAGE_NEPALI_INDIA,
173 wxLANGUAGE_NORWEGIAN_BOKMAL,
174 wxLANGUAGE_NORWEGIAN_NYNORSK,
180 wxLANGUAGE_PORTUGUESE,
181 wxLANGUAGE_PORTUGUESE_BRAZILIAN,
184 wxLANGUAGE_RHAETO_ROMANCE,
187 wxLANGUAGE_RUSSIAN_UKRAINE,
191 wxLANGUAGE_SCOTS_GAELIC,
193 wxLANGUAGE_SERBIAN_CYRILLIC,
194 wxLANGUAGE_SERBIAN_LATIN,
195 wxLANGUAGE_SERBO_CROATIAN,
200 wxLANGUAGE_SINHALESE,
203 wxLANGUAGE_SLOVENIAN,
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,
229 wxLANGUAGE_SWEDISH_FINLAND,
244 wxLANGUAGE_UKRAINIAN,
246 wxLANGUAGE_URDU_INDIA,
247 wxLANGUAGE_URDU_PAKISTAN,
249 wxLANGUAGE_UZBEK_CYRILLIC,
250 wxLANGUAGE_UZBEK_LATIN,
251 wxLANGUAGE_VIETNAMESE,
261 // for custom, user-defined languages:
262 wxLANGUAGE_USER_DEFINED
266 //---------------------------------------------------------------------------
269 // wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc.
270 // translation information
271 struct wxLanguageInfo
273 int Language; // wxLanguage id
274 wxString CanonicalName; // Canonical name, e.g. fr_FR
275 wxString Description; // human-readable name of the language
278 // wxLocaleCategory: the category of locale settings
279 enum wxLocaleCategory
287 // wxLocaleInfo: the items understood by wxLocale::GetInfo()
290 wxLOCALE_THOUSANDS_SEP,
291 wxLOCALE_DECIMAL_POINT
295 // wxLocale: encapsulates all language dependent settings, including current
296 // message catalogs, date, time and currency formats (TODO) &c
297 enum wxLocaleInitFlags
299 wxLOCALE_LOAD_DEFAULT = 0x0001, // load wxwin.mo?
300 wxLOCALE_CONV_ENCODING = 0x0002 // convert encoding on the fly?
304 //---------------------------------------------------------------------------
312 wxLocale(int language = -1,
313 int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING) {
316 loc = new wxLocale();
318 loc = new wxLocale(language, flags);
319 // Python before 2.4 needs to have LC_NUMERIC set to "C" in order
320 // for the floating point conversions and such to work right.
321 %#if PY_VERSION_HEX < 0x02040000
322 setlocale(LC_NUMERIC, "C");
328 // restores old locale
332 bool Init1(const wxString& name,
333 const wxString& shortName = wxPyEmptyString,
334 const wxString& locale = wxPyEmptyString,
335 bool bLoadDefault = true,
336 bool bConvertEncoding = false) {
337 bool rc = self->Init(name, shortName, locale, bLoadDefault, bConvertEncoding);
338 // Python before 2.4 needs to have LC_NUMERIC set to "C" in order
339 // for the floating point conversions and such to work right.
340 %#if PY_VERSION_HEX < 0x02040000
341 setlocale(LC_NUMERIC, "C");
346 bool Init2(int language = wxLANGUAGE_DEFAULT,
347 int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING) {
348 bool rc = self->Init(language, flags);
349 // Python before 2.4 needs to have LC_NUMERIC set to "C" in order
350 // for the floating point conversions and such to work right.
351 %#if PY_VERSION_HEX < 0x02040000
352 setlocale(LC_NUMERIC, "C");
361 def Init(self, *_args, **_kwargs):
362 if type(_args[0]) in [type(''), type(u'')]:
363 val = self.Init1(*_args, **_kwargs)
365 val = self.Init2(*_args, **_kwargs)
369 // Try to get user's (or OS's) prefered language setting.
370 // Return wxLANGUAGE_UNKNOWN if language-guessing algorithm failed
371 static int GetSystemLanguage();
373 // get the encoding used by default for text on this system, returns
374 // wxFONTENCODING_SYSTEM if it couldn't be determined
375 static wxFontEncoding GetSystemEncoding();
377 // get the string describing the system encoding, return empty string if
378 // couldn't be determined
379 static wxString GetSystemEncodingName();
382 // THIS ONE IS COMMENTED OUT IN src/common/intl.cpp
383 // get the values of the given locale-dependent datum: the current locale
384 // is used, the US default value is returned if everything else fails
385 // static wxString GetInfo(wxLocaleInfo index, wxLocaleCategory cat);
387 // return True if the locale was set successfully
389 %pythoncode { def __nonzero__(self): return self.IsOk() };
391 // returns locale name
392 wxString GetLocale() const;
394 // return current locale wxLanguage value
395 int GetLanguage() const;
397 // return locale name to be passed to setlocale()
398 wxString GetSysName() const;
400 // return 'canonical' name, i.e. in the form of xx[_YY], where xx is
401 // language code according to ISO 639 and YY is country name
402 // as specified by ISO 3166.
403 wxString GetCanonicalName() const;
405 // add a prefix to the catalog lookup path: the message catalog files will be
406 // looked up under prefix/<lang>/LC_MESSAGES, prefix/LC_MESSAGES and prefix
409 // This only applies to subsequent invocations of AddCatalog()!
410 static void AddCatalogLookupPathPrefix(const wxString& prefix);
412 // add a catalog: it's searched for in standard places (current directory
413 // first, system one after), but the you may prepend additional directories to
414 // the search path with AddCatalogLookupPathPrefix().
416 // The loaded catalog will be used for message lookup by GetString().
418 // Returns 'True' if it was successfully loaded
419 bool AddCatalog(const wxString& domain);
421 // check if the given locale is provided by OS and C run time
422 static bool IsAvailable(int lang);
424 // check if the given catalog is loaded
425 bool IsLoaded(const wxString& domain) const;
427 // Retrieve the language info struct for the given language
429 // Returns NULL if no info found, pointer must *not* be deleted by caller
430 static const wxLanguageInfo *GetLanguageInfo(int lang);
432 // Returns language name in English or empty string if the language
433 // is not in database
434 static wxString GetLanguageName(int lang);
436 // Find the language for the given locale string which may be either a
437 // canonical ISO 2 letter language code ("xx"), a language code followed by
438 // the country code ("xx_XX") or a Windows full language name ("Xxxxx...")
440 // Returns NULL if no info found, pointer must *not* be deleted by caller
441 static const wxLanguageInfo *FindLanguageInfo(const wxString& locale);
443 // Add custom language to the list of known languages.
444 // Notes: 1) wxLanguageInfo contains platform-specific data
445 // 2) must be called before Init to have effect
446 static void AddLanguage(const wxLanguageInfo& info);
448 // retrieve the translation for a string in all loaded domains unless
449 // the szDomain parameter is specified (and then only this domain is
452 // return original string if translation is not available
453 // (in this case an error message is generated the first time
454 // a string is not found; use wxLogNull to suppress it)
456 // domains are searched in the last to first order, i.e. catalogs
457 // added later override those added before.
458 wxString GetString(const wxString& origString,
459 const wxString& domain = wxPyEmptyString) const;
461 // Returns the current short name for the locale
462 const wxString& GetName() const;
465 %property(CanonicalName, GetCanonicalName, doc="See `GetCanonicalName`");
466 %property(Language, GetLanguage, doc="See `GetLanguage`");
467 %property(Locale, GetLocale, doc="See `GetLocale`");
468 %property(Name, GetName, doc="See `GetName`");
469 %property(String, GetString, doc="See `GetString`");
470 %property(SysName, GetSysName, doc="See `GetSysName`");
473 //---------------------------------------------------------------------------
476 class wxPyLocale : public wxLocale
481 wxPyLocale(const wxString& name, // name (for messages)
482 const wxString& shortName = wxPyEmptyString, // dir prefix (for msg files)
483 const wxString& locale = wxPyEmptyString, // locale (for setlocale)
484 bool bLoadDefault = true, // preload wxstd.mo?
485 bool bConvertEncoding = false); // convert Win<->Unix if necessary?
487 wxPyLocale(int language, // wxLanguage id or custom language
488 int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
492 virtual const wxString& GetString(const wxString& origString,
493 const wxString& domain = wxPyEmptyString) const;
494 virtual const wxString& GetString(const wxString& origString,
495 const wxString& origString2,
497 const wxString& domain = wxPyEmptyString) const;
499 virtual const wxString& GetSingularString(const wxString& origString,
500 const wxString& domain = wxPyEmptyString) const;
501 virtual const wxString& GetPluralString(const wxString& origString,
502 const wxString& origString2,
504 const wxString& domain = wxPyEmptyString) const;
509 DECLARE_NO_COPY_CLASS(wxPyLocale)
512 wxPyLocale::wxPyLocale() : wxLocale()
516 wxPyLocale::wxPyLocale(const wxString& name, // name (for messages)
517 const wxString& shortName, // dir prefix (for msg files)
518 const wxString& locale, // locale (for setlocale)
519 bool bLoadDefault, // preload wxstd.mo?
520 bool bConvertEncoding) // convert Win<->Unix if necessary?
521 : wxLocale(name, shortName, locale, bLoadDefault, bConvertEncoding)
525 wxPyLocale::wxPyLocale(int language, // wxLanguage id or custom language
526 int flags) : wxLocale(language, flags)
530 wxPyLocale::~wxPyLocale()
534 const wxString& wxPyLocale::GetString(const wxString& origString,
535 const wxString& domain) const
537 return GetSingularString(origString, domain);
540 const wxString& wxPyLocale::GetString(const wxString& origString,
541 const wxString& origString2,
543 const wxString& domain) const
545 return GetPluralString(origString, origString2, n, domain);
548 const wxString& wxPyLocale::GetSingularString(const wxString& origString,
549 const wxString& domain) const
552 wxString str( _T("error in translation"));
553 wxPyBlock_t blocked = wxPyBeginBlockThreads();
554 if ((found=wxPyCBH_findCallback(m_myInst, "GetSingularString"))) {
555 PyObject* param1 = wx2PyString(origString);
556 PyObject* param2 = wx2PyString(domain);
557 PyObject* ret = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OO)", param1, param2));
561 str = Py2wxString(ret);
565 wxPyEndBlockThreads(blocked);
566 return (found ? str : wxLocale::GetString(origString, domain));
569 const wxString& wxPyLocale::GetPluralString(const wxString& origString,
570 const wxString& origString2, size_t n,
571 const wxString& domain) const
574 wxString str( _T("error in translation"));
575 wxPyBlock_t blocked = wxPyBeginBlockThreads();
576 if ((found=wxPyCBH_findCallback(m_myInst, "GetPluralString"))) {
577 PyObject* param1 = wx2PyString(origString);
578 PyObject* param2 = wx2PyString(origString2);
579 PyObject* param4 = wx2PyString(domain);
580 PyObject* ret = wxPyCBH_callCallbackObj(m_myInst,
581 Py_BuildValue("(OOiO)",
588 str = Py2wxString(ret);
592 wxPyEndBlockThreads(blocked);
593 return (found ? str : wxLocale::GetString(origString, origString2, n, domain) );
598 class wxPyLocale : public wxLocale
601 %pythonAppend wxPyLocale setCallbackInfo(PyLocale)
606 wxPyLocale(int language = -1,
607 int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING) {
610 loc = new wxPyLocale();
612 loc = new wxPyLocale(language, flags);
613 // Python before 2.4 needs to have LC_NUMERIC set to "C" in order
614 // for the floating point conversions and such to work right.
615 %#if PY_VERSION_HEX < 0x02040000
616 setlocale(LC_NUMERIC, "C");
623 void _setCallbackInfo(PyObject* self, PyObject* _class);
625 virtual const wxString& GetSingularString(const wxString& origString,
626 const wxString& domain = wxPyEmptyString) const;
627 virtual const wxString& GetPluralString(const wxString& origString,
628 const wxString& origString2, size_t n,
629 const wxString& domain = wxPyEmptyString) const;
632 //---------------------------------------------------------------------------
634 // get the current locale object (note that it may be NULL!)
635 wxLocale* wxGetLocale();
637 // get the translation of the string in the current locale
638 %nokwargs wxGetTranslation;
639 wxString wxGetTranslation(const wxString& str);
640 wxString wxGetTranslation(const wxString& str, const wxString& domain);
641 wxString wxGetTranslation(const wxString& str, const wxString& strPlural, size_t n);
642 wxString wxGetTranslation(const wxString& str, const wxString& strPlural, size_t n, const wxString& domain);
644 //---------------------------------------------------------------------------
648 // wxEncodingConverter
649 // This class is capable of converting strings between any two
650 // 8bit encodings/charsets. It can also convert from/to Unicode
653 %typemap(out) wxFontEncodingArray {
654 $result = PyList_New(0);
655 for (size_t i=0; i < $1.GetCount(); i++) {
656 PyObject* number = PyInt_FromLong($1.Item(i));
657 PyList_Append($result, number);
672 wxPLATFORM_CURRENT = -1,
681 class wxEncodingConverter : public wxObject
685 wxEncodingConverter();
686 ~wxEncodingConverter();
689 // Initialize convertion. Both output or input encoding may
690 // be wxFONTENCODING_UNICODE, but only if wxUSE_WCHAR_T is set to 1.
692 // All subsequent calls to Convert() will interpret it's argument
693 // as a string in input_enc encoding and will output string in
694 // output_enc encoding.
696 // You must call this method before calling Convert. You may call
697 // it more than once in order to switch to another conversion
699 // Method affects behaviour of Convert() in case input character
700 // cannot be converted because it does not exist in output encoding:
701 // wxCONVERT_STRICT --
702 // follow behaviour of GNU Recode - just copy unconvertable
703 // characters to output and don't change them (it's integer
704 // value will stay the same)
705 // wxCONVERT_SUBSTITUTE --
706 // try some (lossy) substitutions - e.g. replace
707 // unconvertable latin capitals with acute by ordinary
708 // capitals, replace en-dash or em-dash by '-' etc.
709 // both modes gurantee that output string will have same length
712 // Returns False if given conversion is impossible, True otherwise
713 // (conversion may be impossible either if you try to convert
714 // to Unicode with non-Unicode build of wxWindows or if input
715 // or output encoding is not supported.)
716 bool Init(wxFontEncoding input_enc, wxFontEncoding output_enc, int method = wxCONVERT_STRICT);
719 // TODO: Need to do something about unicode mode...
721 // Convert input string according to settings passed to Init.
722 // Note that you must call Init before using Convert!
723 wxString Convert(const wxString& input);
725 // void Convert(const char* input, char* output);
728 // void Convert(const char* input, wchar_t* output);
729 // void Convert(const wchar_t* input, char* output);
730 // void Convert(const wchar_t* input, wchar_t* output);
731 // void Convert(wchar_t* str) { Convert(str, str); }
736 // Return equivalent(s) for given font that are used
737 // under given platform. wxPLATFORM_CURRENT means the plaform
738 // this binary was compiled for
741 // current platform enc returned value
742 // -----------------------------------------------------
743 // unix CP1250 {ISO8859_2}
745 // windows ISO8859_2 {CP1250}
747 // Equivalence is defined in terms of convertibility:
748 // 2 encodings are equivalent if you can convert text between
749 // then without loosing information (it may - and will - happen
750 // that you loose special chars like quotation marks or em-dashes
751 // but you shouldn't loose any diacritics and language-specific
752 // characters when converting between equivalent encodings).
754 // Convert() method is not limited to converting between
755 // equivalent encodings, it can convert between arbitrary
758 // Remember that this function does _NOT_ check for presence of
759 // fonts in system. It only tells you what are most suitable
760 // encodings. (It usually returns only one encoding)
762 // Note that argument enc itself may be present in returned array!
763 // (so that you can -- as a side effect -- detect whether the
764 // encoding is native for this platform or not)
765 static wxFontEncodingArray GetPlatformEquivalents(wxFontEncoding enc,
766 int platform = wxPLATFORM_CURRENT);
768 // Similar to GetPlatformEquivalent, but this one will return ALL
769 // equivalent encodings, regardless the platform, including itself.
770 static wxFontEncodingArray GetAllEquivalents(wxFontEncoding enc);
772 // Return True if [any text in] one multibyte encoding can be
773 // converted to another one losslessly.
775 // Do not call this with wxFONTENCODING_UNICODE, it doesn't make
776 // sense (always works in one sense and always depends on the text
777 // to convert in the other)
778 static bool CanConvert(wxFontEncoding encIn, wxFontEncoding encOut);
780 %pythoncode { def __nonzero__(self): return self.IsOk() }
786 //---------------------------------------------------------------------------
788 %pythoncode "_intl_ex.py"
790 //---------------------------------------------------------------------------