docs/latex/wx/locale.tex

   1 \section{\class{wxLocale}}\label{wxlocale}
   2
   3 wxLocale class encapsulates all language-dependent settings and is a
   4 generalization of the C locale concept.
   5
   6 In wxWindows this class manages message catalogs which contain the translations
   7 of the strings used to the current language.
   8
   9 \perlnote{In wxPerl you can't use the '\_' function name, so
  10 the {\tt Wx::Locale} module can export the {\tt gettext} and
  11 {\tt gettext\_noop} under any given name.
  12 \begin{verbatim}
  13   # this imports gettext ( equivalent to Wx::GetTranslation
  14   # and gettext_noop ( a noop )
  15   # into your module
  16   use Wx::Locale qw(:default);
  17
  18   # ....
  19
  20   # use the functions
  21   print gettext( ``Panic!'' );
  22
  23   button = Wx::Button->new( window, -1, gettext( ``Label'' ) );
  24 \end{verbatim}
  25 If you need to translate a lot of strings, then adding gettext( ) around
  26 each one is a long task ( that is why \_( ) was introduced ), so just choose
  27 a shorter name for gettext:
  28 \begin{verbatim}
  29   #
  30   use Wx::Locale 'gettext' => 't',
  31                  'gettext_noop' => 'gettext_noop';
  32
  33   # ...
  34
  35   # use the functions
  36   print t( ``Panic!!'' );
  37
  38   # ...
  39 \end{verbatim}
  40 }
  41
  42 \wxheading{Derived from}
  43
  44 No base class
  45
  46 \wxheading{See also}
  47
  48 \helpref{Internationalization overview}{internationalization},\\
  49 \helpref{Internat sample}{sampleinternat}
  50
  51 \wxheading{Include files}
  52
  53 <wx/intl.h>
  54
  55
  56 \latexignore{\rtfignore{\wxheading{Members}}}
  57
  58
  59 \membersection{Supported languages}\label{wxlanguage}
  60
  61 The following wxLanguage constants may be used to specify the language
  62 in \helpref{Init}{wxlocaleinit} and are returned by
  63 \helpref{GetSystemLanguage}{wxlocalegetsystemlanguage}:
  64
  65
  66
  67 %% --- --- --- generated code begins here --- --- ---
  68
  69 %% This enum is generated by misc/languages/genlang.py
  70 %% When making changes, please put them into misc/languages/langtabl.txt
  71 \begin{itemize}\itemsep=0pt
  72 \item wxLANGUAGE\_DEFAULT -- user's default language as obtained from the operating system
  73 \item wxLANGUAGE\_UNKNOWN -- returned by \helpref{GetSystemLanguage}{wxlocalegetsystemlanguage}
  74 if it fails to detect the default language
  75 \item wxLANGUAGE\_USER\_DEFINED -- user defined languages' integer identifiers should start from
  76 this
  77 \item wxLANGUAGE\_ABKHAZIAN
  78 \item wxLANGUAGE\_AFAR
  79 \item wxLANGUAGE\_AFRIKAANS
  80 \item wxLANGUAGE\_ALBANIAN
  81 \item wxLANGUAGE\_AMHARIC
  82 \item wxLANGUAGE\_ARABIC
  83 \item wxLANGUAGE\_ARABIC\_ALGERIA
  84 \item wxLANGUAGE\_ARABIC\_BAHRAIN
  85 \item wxLANGUAGE\_ARABIC\_EGYPT
  86 \item wxLANGUAGE\_ARABIC\_IRAQ
  87 \item wxLANGUAGE\_ARABIC\_JORDAN
  88 \item wxLANGUAGE\_ARABIC\_KUWAIT
  89 \item wxLANGUAGE\_ARABIC\_LEBANON
  90 \item wxLANGUAGE\_ARABIC\_LIBYA
  91 \item wxLANGUAGE\_ARABIC\_MOROCCO
  92 \item wxLANGUAGE\_ARABIC\_OMAN
  93 \item wxLANGUAGE\_ARABIC\_QATAR
  94 \item wxLANGUAGE\_ARABIC\_SAUDI\_ARABIA
  95 \item wxLANGUAGE\_ARABIC\_SUDAN
  96 \item wxLANGUAGE\_ARABIC\_SYRIA
  97 \item wxLANGUAGE\_ARABIC\_TUNISIA
  98 \item wxLANGUAGE\_ARABIC\_UAE
  99 \item wxLANGUAGE\_ARABIC\_YEMEN
 100 \item wxLANGUAGE\_ARMENIAN
 101 \item wxLANGUAGE\_ASSAMESE
 102 \item wxLANGUAGE\_AYMARA
 103 \item wxLANGUAGE\_AZERI
 104 \item wxLANGUAGE\_AZERI\_CYRILLIC
 105 \item wxLANGUAGE\_AZERI\_LATIN
 106 \item wxLANGUAGE\_BASHKIR
 107 \item wxLANGUAGE\_BASQUE
 108 \item wxLANGUAGE\_BELARUSIAN
 109 \item wxLANGUAGE\_BENGALI
 110 \item wxLANGUAGE\_BHUTANI
 111 \item wxLANGUAGE\_BIHARI
 112 \item wxLANGUAGE\_BISLAMA
 113 \item wxLANGUAGE\_BRETON
 114 \item wxLANGUAGE\_BULGARIAN
 115 \item wxLANGUAGE\_BURMESE
 116 \item wxLANGUAGE\_CAMBODIAN
 117 \item wxLANGUAGE\_CATALAN
 118 \item wxLANGUAGE\_CHINESE
 119 \item wxLANGUAGE\_CHINESE\_SIMPLIFIED
 120 \item wxLANGUAGE\_CHINESE\_TRADITIONAL
 121 \item wxLANGUAGE\_CHINESE\_HONGKONG
 122 \item wxLANGUAGE\_CHINESE\_MACAU
 123 \item wxLANGUAGE\_CHINESE\_SINGAPORE
 124 \item wxLANGUAGE\_CHINESE\_TAIWAN
 125 \item wxLANGUAGE\_CORSICAN
 126 \item wxLANGUAGE\_CROATIAN
 127 \item wxLANGUAGE\_CZECH
 128 \item wxLANGUAGE\_DANISH
 129 \item wxLANGUAGE\_DUTCH
 130 \item wxLANGUAGE\_DUTCH\_BELGIAN
 131 \item wxLANGUAGE\_ENGLISH
 132 \item wxLANGUAGE\_ENGLISH\_UK
 133 \item wxLANGUAGE\_ENGLISH\_US
 134 \item wxLANGUAGE\_ENGLISH\_AUSTRALIA
 135 \item wxLANGUAGE\_ENGLISH\_BELIZE
 136 \item wxLANGUAGE\_ENGLISH\_BOTSWANA
 137 \item wxLANGUAGE\_ENGLISH\_CANADA
 138 \item wxLANGUAGE\_ENGLISH\_CARIBBEAN
 139 \item wxLANGUAGE\_ENGLISH\_DENMARK
 140 \item wxLANGUAGE\_ENGLISH\_EIRE
 141 \item wxLANGUAGE\_ENGLISH\_JAMAICA
 142 \item wxLANGUAGE\_ENGLISH\_NEW\_ZEALAND
 143 \item wxLANGUAGE\_ENGLISH\_PHILIPPINES
 144 \item wxLANGUAGE\_ENGLISH\_SOUTH\_AFRICA
 145 \item wxLANGUAGE\_ENGLISH\_TRINIDAD
 146 \item wxLANGUAGE\_ENGLISH\_ZIMBABWE
 147 \item wxLANGUAGE\_ESPERANTO
 148 \item wxLANGUAGE\_ESTONIAN
 149 \item wxLANGUAGE\_FAEROESE
 150 \item wxLANGUAGE\_FARSI
 151 \item wxLANGUAGE\_FIJI
 152 \item wxLANGUAGE\_FINNISH
 153 \item wxLANGUAGE\_FRENCH
 154 \item wxLANGUAGE\_FRENCH\_BELGIAN
 155 \item wxLANGUAGE\_FRENCH\_CANADIAN
 156 \item wxLANGUAGE\_FRENCH\_LUXEMBOURG
 157 \item wxLANGUAGE\_FRENCH\_MONACO
 158 \item wxLANGUAGE\_FRENCH\_SWISS
 159 \item wxLANGUAGE\_FRISIAN
 160 \item wxLANGUAGE\_GALICIAN
 161 \item wxLANGUAGE\_GEORGIAN
 162 \item wxLANGUAGE\_GERMAN
 163 \item wxLANGUAGE\_GERMAN\_AUSTRIAN
 164 \item wxLANGUAGE\_GERMAN\_BELGIUM
 165 \item wxLANGUAGE\_GERMAN\_LIECHTENSTEIN
 166 \item wxLANGUAGE\_GERMAN\_LUXEMBOURG
 167 \item wxLANGUAGE\_GERMAN\_SWISS
 168 \item wxLANGUAGE\_GREEK
 169 \item wxLANGUAGE\_GREENLANDIC
 170 \item wxLANGUAGE\_GUARANI
 171 \item wxLANGUAGE\_GUJARATI
 172 \item wxLANGUAGE\_HAUSA
 173 \item wxLANGUAGE\_HEBREW
 174 \item wxLANGUAGE\_HINDI
 175 \item wxLANGUAGE\_HUNGARIAN
 176 \item wxLANGUAGE\_ICELANDIC
 177 \item wxLANGUAGE\_INDONESIAN
 178 \item wxLANGUAGE\_INTERLINGUA
 179 \item wxLANGUAGE\_INTERLINGUE
 180 \item wxLANGUAGE\_INUKTITUT
 181 \item wxLANGUAGE\_INUPIAK
 182 \item wxLANGUAGE\_IRISH
 183 \item wxLANGUAGE\_ITALIAN
 184 \item wxLANGUAGE\_ITALIAN\_SWISS
 185 \item wxLANGUAGE\_JAPANESE
 186 \item wxLANGUAGE\_JAVANESE
 187 \item wxLANGUAGE\_KANNADA
 188 \item wxLANGUAGE\_KASHMIRI
 189 \item wxLANGUAGE\_KASHMIRI\_INDIA
 190 \item wxLANGUAGE\_KAZAKH
 191 \item wxLANGUAGE\_KERNEWEK
 192 \item wxLANGUAGE\_KINYARWANDA
 193 \item wxLANGUAGE\_KIRGHIZ
 194 \item wxLANGUAGE\_KIRUNDI
 195 \item wxLANGUAGE\_KONKANI
 196 \item wxLANGUAGE\_KOREAN
 197 \item wxLANGUAGE\_KURDISH
 198 \item wxLANGUAGE\_LAOTHIAN
 199 \item wxLANGUAGE\_LATIN
 200 \item wxLANGUAGE\_LATVIAN
 201 \item wxLANGUAGE\_LINGALA
 202 \item wxLANGUAGE\_LITHUANIAN
 203 \item wxLANGUAGE\_MACEDONIAN
 204 \item wxLANGUAGE\_MALAGASY
 205 \item wxLANGUAGE\_MALAY
 206 \item wxLANGUAGE\_MALAYALAM
 207 \item wxLANGUAGE\_MALAY\_BRUNEI\_DARUSSALAM
 208 \item wxLANGUAGE\_MALAY\_MALAYSIA
 209 \item wxLANGUAGE\_MALTESE
 210 \item wxLANGUAGE\_MANIPURI
 211 \item wxLANGUAGE\_MAORI
 212 \item wxLANGUAGE\_MARATHI
 213 \item wxLANGUAGE\_MOLDAVIAN
 214 \item wxLANGUAGE\_MONGOLIAN
 215 \item wxLANGUAGE\_NAURU
 216 \item wxLANGUAGE\_NEPALI
 217 \item wxLANGUAGE\_NEPALI\_INDIA
 218 \item wxLANGUAGE\_NORWEGIAN\_BOKMAL
 219 \item wxLANGUAGE\_NORWEGIAN\_NYNORSK
 220 \item wxLANGUAGE\_OCCITAN
 221 \item wxLANGUAGE\_ORIYA
 222 \item wxLANGUAGE\_OROMO
 223 \item wxLANGUAGE\_PASHTO
 224 \item wxLANGUAGE\_POLISH
 225 \item wxLANGUAGE\_PORTUGUESE
 226 \item wxLANGUAGE\_PORTUGUESE\_BRAZILIAN
 227 \item wxLANGUAGE\_PUNJABI
 228 \item wxLANGUAGE\_QUECHUA
 229 \item wxLANGUAGE\_RHAETO\_ROMANCE
 230 \item wxLANGUAGE\_ROMANIAN
 231 \item wxLANGUAGE\_RUSSIAN
 232 \item wxLANGUAGE\_RUSSIAN\_UKRAINE
 233 \item wxLANGUAGE\_SAMOAN
 234 \item wxLANGUAGE\_SANGHO
 235 \item wxLANGUAGE\_SANSKRIT
 236 \item wxLANGUAGE\_SCOTS\_GAELIC
 237 \item wxLANGUAGE\_SERBIAN
 238 \item wxLANGUAGE\_SERBIAN\_CYRILLIC
 239 \item wxLANGUAGE\_SERBIAN\_LATIN
 240 \item wxLANGUAGE\_SERBO\_CROATIAN
 241 \item wxLANGUAGE\_SESOTHO
 242 \item wxLANGUAGE\_SETSWANA
 243 \item wxLANGUAGE\_SHONA
 244 \item wxLANGUAGE\_SINDHI
 245 \item wxLANGUAGE\_SINHALESE
 246 \item wxLANGUAGE\_SISWATI
 247 \item wxLANGUAGE\_SLOVAK
 248 \item wxLANGUAGE\_SLOVENIAN
 249 \item wxLANGUAGE\_SOMALI
 250 \item wxLANGUAGE\_SPANISH
 251 \item wxLANGUAGE\_SPANISH\_ARGENTINA
 252 \item wxLANGUAGE\_SPANISH\_BOLIVIA
 253 \item wxLANGUAGE\_SPANISH\_CHILE
 254 \item wxLANGUAGE\_SPANISH\_COLOMBIA
 255 \item wxLANGUAGE\_SPANISH\_COSTA\_RICA
 256 \item wxLANGUAGE\_SPANISH\_DOMINICAN\_REPUBLIC
 257 \item wxLANGUAGE\_SPANISH\_ECUADOR
 258 \item wxLANGUAGE\_SPANISH\_EL\_SALVADOR
 259 \item wxLANGUAGE\_SPANISH\_GUATEMALA
 260 \item wxLANGUAGE\_SPANISH\_HONDURAS
 261 \item wxLANGUAGE\_SPANISH\_MEXICAN
 262 \item wxLANGUAGE\_SPANISH\_MODERN
 263 \item wxLANGUAGE\_SPANISH\_NICARAGUA
 264 \item wxLANGUAGE\_SPANISH\_PANAMA
 265 \item wxLANGUAGE\_SPANISH\_PARAGUAY
 266 \item wxLANGUAGE\_SPANISH\_PERU
 267 \item wxLANGUAGE\_SPANISH\_PUERTO\_RICO
 268 \item wxLANGUAGE\_SPANISH\_URUGUAY
 269 \item wxLANGUAGE\_SPANISH\_US
 270 \item wxLANGUAGE\_SPANISH\_VENEZUELA
 271 \item wxLANGUAGE\_SUNDANESE
 272 \item wxLANGUAGE\_SWAHILI
 273 \item wxLANGUAGE\_SWEDISH
 274 \item wxLANGUAGE\_SWEDISH\_FINLAND
 275 \item wxLANGUAGE\_TAGALOG
 276 \item wxLANGUAGE\_TAJIK
 277 \item wxLANGUAGE\_TAMIL
 278 \item wxLANGUAGE\_TATAR
 279 \item wxLANGUAGE\_TELUGU
 280 \item wxLANGUAGE\_THAI
 281 \item wxLANGUAGE\_TIBETAN
 282 \item wxLANGUAGE\_TIGRINYA
 283 \item wxLANGUAGE\_TONGA
 284 \item wxLANGUAGE\_TSONGA
 285 \item wxLANGUAGE\_TURKISH
 286 \item wxLANGUAGE\_TURKMEN
 287 \item wxLANGUAGE\_TWI
 288 \item wxLANGUAGE\_UIGHUR
 289 \item wxLANGUAGE\_UKRAINIAN
 290 \item wxLANGUAGE\_URDU
 291 \item wxLANGUAGE\_URDU\_INDIA
 292 \item wxLANGUAGE\_URDU\_PAKISTAN
 293 \item wxLANGUAGE\_UZBEK
 294 \item wxLANGUAGE\_UZBEK\_CYRILLIC
 295 \item wxLANGUAGE\_UZBEK\_LATIN
 296 \item wxLANGUAGE\_VIETNAMESE
 297 \item wxLANGUAGE\_VOLAPUK
 298 \item wxLANGUAGE\_WELSH
 299 \item wxLANGUAGE\_WOLOF
 300 \item wxLANGUAGE\_XHOSA
 301 \item wxLANGUAGE\_YIDDISH
 302 \item wxLANGUAGE\_YORUBA
 303 \item wxLANGUAGE\_ZHUANG
 304 \item wxLANGUAGE\_ZULU
 305 \end{itemize}
 306
 307 %% --- --- --- generated code ends here --- --- ---
 308
 309
 310
 311
 312 \membersection{wxLocale::wxLocale}\label{wxlocaledefctor}
 313
 314 \func{}{wxLocale}{\void}
 315
 316 This is the default constructor and it does nothing to initialize the object:
 317 \helpref{Init()}{wxlocaleinit} must be used to do that.
 318
 319 \func{}{wxLocale}{\param{int }{language}, \param{int }{flags =
 320                           wxLOCALE\_LOAD\_DEFAULT | wxLOCALE\_CONV\_ENCODING}}
 321
 322 See \helpref{Init()}{wxlocaleinit} for parameters description.
 323
 324 \func{}{wxLocale}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = true}, \param{bool }{bConvertEncoding = false}}
 325
 326 See \helpref{Init()}{wxlocaleinit} for parameters description.
 327
 328 The call of this function has several global side effects which you should
 329 understand: first of all, the application locale is changed - note that this
 330 will affect many of standard C library functions such as printf() or strftime().
 331 Second, this wxLocale object becomes the new current global locale for the
 332 application and so all subsequent calls to wxGetTranslation() will try to
 333 translate the messages using the message catalogs for this locale.
 334
 335
 336 \membersection{wxLocale::\destruct{wxLocale}}\label{wxlocaledtor}
 337
 338 \func{}{\destruct{wxLocale}}{\void}
 339
 340 The destructor, like the constructor, also has global side effects: the previously
 341 set locale is restored and so the changes described in
 342 \helpref{Init}{wxlocaleinit} documentation are rolled back.
 343
 344 \membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog}
 345
 346 \func{bool}{AddCatalog}{\param{const char }{*szDomain}}
 347
 348 Add a catalog for use with the current locale: it is searched for in standard
 349 places (current directory first, then the system one), but you may also prepend
 350 additional directories to the search path with
 351 \helpref{AddCatalogLookupPathPrefix()}{wxlocaleaddcataloglookuppathprefix}.
 352
 353 All loaded catalogs will be used for message lookup by GetString() for the
 354 current locale.
 355
 356 Returns true if catalog was successfully loaded, false otherwise (which might
 357 mean that the catalog is not found or that it isn't in the correct format).
 358
 359 \membersection{wxLocale::AddCatalogLookupPathPrefix}\label{wxlocaleaddcataloglookuppathprefix}
 360
 361 \func{void}{AddCatalogLookupPathPrefix}{\param{const wxString\& }{prefix}}
 362
 363 Add a prefix to the catalog lookup path: the message catalog files will be
 364 looked up under prefix/<lang>/LC\_MESSAGES, prefix/LC\_MESSAGES and prefix
 365 (in this order).
 366
 367 This only applies to subsequent invocations of AddCatalog()!
 368
 369 \membersection{wxLocale::AddLanguage}\label{wxlocaleaddlanguage}
 370
 371 \func{static void}{AddLanguage}{\param{const wxLanguageInfo\& }{info}}
 372
 373 Adds custom, user-defined language to the database of known languages. This
 374 database is used in conjunction with the first form of
 375 \helpref{Init}{wxlocaleinit}.
 376
 377 wxLanguageInfo is defined as follows:
 378
 379 \begin{verbatim}
 380 struct WXDLLEXPORT wxLanguageInfo
 381 {
 382     int Language;                   // wxLanguage id
 383     wxString CanonicalName;         // Canonical name, e.g. fr_FR
 384 #ifdef __WIN32__
 385     wxUint32 WinLang, WinSublang;   // Win32 language identifiers
 386                                     // (LANG_xxxx, SUBLANG_xxxx)
 387 #endif
 388     wxString Description;           // human-readable name of the language
 389 };
 390 \end{verbatim}
 391
 392
 393 {\it Language} should be greater than wxLANGUAGE\_USER\_DEFINED.
 394
 395 \perlnote{In wxPerl Wx::LanguageInfo has only one method:\par
 396 Wx::LanguageInfo->new( language, canonicalName, WinLang, WinSubLang, Description )}
 397
 398 \membersection{wxLocale::FindLanguageInfo}{wxlocalefindlanguageinfo}
 399
 400 \constfunc{static wxLanguageInfo *}{FindLanguageInfo}{\param{const wxString\& }{locale}}
 401
 402 This function may be used to find the language description structure for the
 403 given locale, specified either as a two letter ISO language code (for example,
 404 "pt"), a language code followed by the country code ("pt\_BR") or a full, human
 405 readable, language description ("Portuguese-Brazil").
 406
 407 Returns the information for the given language or {\tt NULL} if this language
 408 is unknown. Note that even if the returned pointer is valid, the caller should
 409 {\it not} delete it.
 410
 411 \wxheading{See also}
 412
 413 \helpref{GetLanguageInfo}{wxlocalegetlanguageinfo}
 414
 415 \membersection{wxLocale::GetCanonicalName}\label{wxlocalegetcanonicalname}
 416
 417 \constfunc{wxString}{GetSysName}{\void}
 418
 419 Returns the canonical form of current locale name. Canonical form is the
 420 one that is used on UNIX systems: it is a two- or five-letter string in xx or
 421 xx\_YY format, where xx is ISO 639 code of language and YY is ISO 3166 code of
 422 the country. Examples are "en", "en\_GB", "en\_US" or "fr\_FR".
 423
 424 This form is internally used when looking up message catalogs.
 425
 426 Compare \helpref{GetSysName}{wxlocalegetsysname}.
 427
 428
 429
 430 \membersection{wxLocale::GetLanguage}\label{wxlocalegetlanguage}
 431
 432 \constfunc{int}{GetLanguage}{\void}
 433
 434 Returns \helpref{wxLanguage}{wxlanguage} constant of current language.
 435 Note that you can call this function only if you used the form of
 436 \helpref{Init}{wxlocaleinit} that takes wxLanguage argument.
 437
 438 \membersection{wxLocale::GetLanguageInfo}\label{wxlocalegetlanguageinfo}
 439
 440 \constfunc{static wxLanguageInfo *}{GetLanguageInfo}{\param{int }{lang}}
 441
 442 Returns a pointer to wxLanguageInfo structure containing information about the
 443 given language or {\tt NULL} if this language is unknown. Note that even if the
 444 returned pointer is valid, the caller should {\it not} delete it.
 445
 446 See \helpref{AddLanguage}{wxlocaleaddlanguage} for the wxLanguageInfo
 447 description.
 448
 449 \membersection{wxLocale::GetLanguageName}\label{wxlocalegetlanguagename}
 450
 451 \constfunc{static wxString}{GetLanguageName}{\param{int }{lang}}
 452
 453 Returns English name of the given language or empty string if this
 454 language is unknown.
 455
 456
 457 \membersection{wxLocale::GetLocale}\label{wxlocalegetlocale}
 458
 459 \constfunc{const char*}{GetLocale}{\void}
 460
 461 Returns the locale name as passed to the constructor or
 462 \helpref{Init()}{wxlocaleinit}. This is full, human-readable name,
 463 e.g. "English" or "French".
 464
 465
 466 \membersection{wxLocale::GetName}\label{wxlocalegetname}
 467
 468 \constfunc{const wxString\&}{GetName}{\void}
 469
 470 Returns the current short name for the locale (as given to the constructor or
 471 the Init() function).
 472
 473 \membersection{wxLocale::GetString}\label{wxlocalegetstring}
 474
 475 \constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szDomain = NULL}}
 476
 477 \constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szOrigString2}, \param{size\_t }{n}, \param{const char }{*szDomain = NULL}}
 478
 479 Retrieves the translation for a string in all loaded domains unless the szDomain
 480 parameter is specified (and then only this catalog/domain is searched).
 481
 482 Returns original string if translation is not available
 483 (in this case an error message is generated the first time
 484 a string is not found; use \helpref{wxLogNull}{wxlogoverview} to suppress it).
 485
 486 The second form is used when retrieving translation of string that has
 487 different singular and plural form in English or different plural forms in some
 488 other language. It takes two extra arguments: \arg{szOrigString}
 489 parameter must contain the singular form of the string to be converted.
 490 It is also used as the key for the search in the catalog.
 491 The \arg{szOrigString2} parameter is the plural form (in English).
 492 The parameter \arg{n} is used to determine the plural form.  If no
 493 message catalog is found \arg{szOrigString} is returned if `n == 1',
 494 otherwise \arg{szOrigString2}.
 495 See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling.
 496
 497 \wxheading{Remarks}
 498
 499 Domains are searched in the last to first order, i.e. catalogs
 500 added later override those added before.
 501
 502 \membersection{wxLocale::GetSysName}\label{wxlocalegetsysname}
 503
 504 \constfunc{wxString}{GetSysName}{\void}
 505
 506 Returns current platform-specific locale name as passed to setlocale().
 507
 508 Compare \helpref{GetCanonicalName}{wxlocalegetcanonicalname}.
 509
 510
 511 \membersection{wxLocale::GetSystemEncoding}\label{wxlocalegetsystemencoding}
 512
 513 \constfunc{static wxFontEncoding}{GetSystemEncoding}{\void}
 514
 515 Tries to detect the user's default font encoding.
 516 Returns \helpref{wxFontEncoding}{wxfont} value or
 517 {\bf wxFONTENCODING\_SYSTEM} if it couldn't be determined.
 518
 519 \membersection{wxLocale::GetSystemEncodingName}\label{wxlocalegetsystemencodingname}
 520
 521 \constfunc{static wxString}{GetSystemEncodingName}{\void}
 522
 523 Tries to detect the name of the user's default font encoding. This string isn't
 524 particularly useful for the application as its form is platform-dependent and
 525 so you should probably use
 526 \helpref{GetSystemEncoding}{wxlocalegetsystemencoding} instead.
 527
 528 Returns a user-readable string value or an empty string if it couldn't be
 529 determined.
 530
 531 \membersection{wxLocale::GetSystemLanguage}\label{wxlocalegetsystemlanguage}
 532
 533 \constfunc{static int}{GetSystemLanguage}{\void}
 534
 535 Tries to detect the user's default language setting.
 536 Returns \helpref{wxLanguage}{wxlanguage} value or
 537  {\bf wxLANGUAGE\_UNKNOWN} if the language-guessing algorithm failed.
 538
 539
 540 \membersection{wxLocale::Init}\label{wxlocaleinit}
 541
 542
 543 \func{bool}{Init}{\param{int }{language = wxLANGUAGE\_DEFAULT}, \param{int }{flags =
 544                           wxLOCALE\_LOAD\_DEFAULT | wxLOCALE\_CONV\_ENCODING}}
 545
 546 \func{bool}{Init}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = true}, \param{bool }{bConvertEncoding = false}}
 547
 548 The second form is deprecated, use the first one unless you know what you are
 549 doing.
 550
 551
 552 \wxheading{Parameters}
 553
 554 \docparam{language}{\helpref{wxLanguage}{wxlanguage} identifier of the locale.
 555 wxLANGUAGE\_DEFAULT has special meaning -- wxLocale will use system's default
 556 language (see \helpref{GetSystemLanguage}{wxlocalegetsystemlanguage}).}
 557
 558 \docparam{flags}{Combination of the following:
 559 \begin{twocollist}\itemsep=0pt
 560 \twocolitem{\windowstyle{wxLOCALE\_LOAD\_DEFAULT}}{Load the message catalog
 561 for the given locale containing the translations of standard wxWindows messages
 562 automatically.}
 563 \twocolitem{\windowstyle{wxLOCALE\_CONV\_ENCODING}}{Automatically convert message
 564 catalogs to platform's default encoding. Note that it will do only basic
 565 conversion between well-known pair like iso8859-1 and windows-1252 or
 566 iso8859-2 and windows-1250. See \helpref{Writing non-English applications}{nonenglishoverview} for detailed
 567 description of this behaviour. Note that this flag is meaningless in Unicode build.}
 568 \end{twocollist}
 569 }
 570
 571 \docparam{szName}{The name of the locale. Only used in diagnostic messages.}
 572
 573 \docparam{szShort}{The standard 2 letter locale abbreviation and is used as the
 574 directory prefix when looking for the message catalog files.}
 575
 576 \docparam{szLocale}{The parameter for the call to setlocale(). Note that it is
 577 platform-specific.}
 578
 579 \docparam{bLoadDefault}{May be set to false to prevent loading of the message catalog
 580 for the given locale containing the translations of standard wxWindows messages.
 581 This parameter would be rarely used in normal circumstances.}
 582
 583 \docparam{bConvertEncoding}{May be set to true to do automatic conversion of message
 584 catalogs to platform's native encoding. Note that it will do only basic
 585 conversion between well-known pair like iso8859-1 and windows-1252 or
 586 iso8859-2 and windows-1250.
 587 See \helpref{Writing non-English applications}{nonenglishoverview} for detailed
 588 description of this behaviour.}
 589
 590
 591 The call of this function has several global side effects which you should
 592 understand: first of all, the application locale is changed - note that this
 593 will affect many of standard C library functions such as printf() or strftime().
 594 Second, this wxLocale object becomes the new current global locale for the
 595 application and so all subsequent calls to wxGetTranslation() will try to
 596 translate the messages using the message catalogs for this locale.
 597
 598 Returns true on success or false if the given locale couldn't be set.
 599
 600 \membersection{wxLocale::IsLoaded}\label{wxlocaleisloaded}
 601
 602 \constfunc{bool}{IsLoaded}{\param{const char* }{domain}}
 603
 604 Check if the given catalog is loaded, and returns true if it is.
 605
 606 According to GNU gettext tradition, each catalog
 607 normally corresponds to 'domain' which is more or less the application name.
 608
 609 See also: \helpref{AddCatalog}{wxlocaleaddcatalog}
 610
 611 \membersection{wxLocale::IsOk}\label{wxlocaleisok}
 612
 613 \constfunc{bool}{IsOk}{\void}
 614
 615 Returns true if the locale could be set successfully.
 616