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