docs/latex/wx/locale.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % f:\libs\wxwindows\docs\latex\wx/locale.tex at 15/Feb/99 23:37:46
   4 %
   5
   6
   7 \section{\class{wxLocale}}\label{wxlocale}
   8
   9 wxLocale class encapsulates all language dependent settings and is a
  10 generalization of the C locale concept (see also setlocale(3)).
  11
  12 In wxWindows this class manages message catalogs which contain the translations
  13 of the strings used to the current language.
  14
  15 \wxheading{Derived from}
  16
  17 No base class
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21 \membersection{wxLocale::wxLocale}\label{wxlocaledefctor}
  22
  23 \func{}{wxLocale}{\void}
  24
  25 This is the default constructor and it does nothing to initialize the object:
  26 \helpref{Init()}{wxlocaleinit} must be used to do it.
  27
  28 \membersection{wxLocale::wxLocale}\label{wxlocalewxlocale}
  29
  30 \func{}{wxLocale}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}}
  31
  32 The parameters have the following meaning:
  33 \begin{itemize}\itemsep=0pt
  34 \item szName is the name of the locale and is only used in diagnostic messages
  35 \item szShort is the standard 2 letter locale abbreviation and is used as the
  36 directory prefix when looking for the message catalog files
  37 \item szLocale is the parameter for the call to setlocale()
  38 \item bLoadDefault may be set to FALSE to prevent loading of the message catalog
  39 for the given locale containing the translations of standard wxWindows messages.
  40 This parameter would be rarely used in normal circumstances.
  41 \end{itemize}
  42
  43 The call of this function has several global side effects which you should
  44 understand: first of all, the application locale is changed - note that this
  45 will affect many of standard C library functions such as printf() or strftime().
  46 Second, this wxLocale object becomes the new current global locale for the
  47 application and so all subsequent calls to wxGetTranslation() will try to
  48 translate the messages using the message catalogs for this locale.
  49
  50 \membersection{wxLocale::\destruct{wxLocale}}\label{wxlocaledtor}
  51
  52 \func{}{\destruct{wxLocale}}{\void}
  53
  54 Destructor, like the constructor, also has global side effects: the previously
  55 set locale is restored and so the changes described in
  56 \helpref{Init}{wxlocaleinit} documentation are rolled back.
  57
  58 \membersection{wxLocale::GetLocale}\label{wxlocalegetlocale}
  59
  60 \constfunc{const char*}{GetLocale}{\void}
  61
  62 Returns the locale name as passed to the constructor or
  63 \helpref{Init()}{wxlocaleinit}.
  64
  65
  66 \membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog}
  67
  68 \func{bool}{AddCatalog}{\param{const char }{*szDomain}}
  69
  70 Add a catalog for use with the current locale: it's searched for in standard
  71 places (current directory first, system one after), but you may also prepend
  72 additional directories to the search path with
  73 \helpref{AddCatalogLookupPathPrefix().}{wxlocaleaddcataloglookuppathprefix}.
  74
  75 All loaded catalogs will be used for message lookup by GetString() for the
  76 current locale.
  77
  78 Returns TRUE if catalog was successfully loaded, FALSE otherwise (which might
  79 mean that the catalog is not found or that it isn't in the correct format).
  80
  81 \membersection{wxLocale::AddCatalogLookupPathPrefix}\label{wxlocaleaddcataloglookuppathprefix}
  82
  83 \func{void}{AddCatalogLookupPathPrefix}{\param{const wxString\& }{prefix}}
  84
  85 Add a prefix to the catalog lookup path: the message catalog files will be
  86 looked up under prefix/<lang>/LC\_MESSAGES, prefix/LC\_MESSAGES and prefix
  87 (in this order).
  88
  89 This only applies to subsequent invocations of AddCatalog()!
  90
  91 \membersection{wxLocale::Init}\label{wxlocaleinit}
  92
  93 \func{bool}{Init}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}}
  94
  95 The parameters have the following meaning:
  96 \begin{itemize}\itemsep=0pt
  97 \item szName is the name of the locale and is only used in diagnostic messages
  98 \item szShort is the standard 2 letter locale abbreviation and is used as the
  99 directory prefix when looking for the message catalog files
 100 \item szLocale is the parameter for the call to setlocale()
 101 \item bLoadDefault may be set to FALSE to prevent loading of the message catalog
 102 for the given locale containing the translations of standard wxWindows messages.
 103 This parameter would be rarely used in normal circumstances.
 104 \end{itemize}
 105
 106 The call of this function has several global side effects which you should
 107 understand: first of all, the application locale is changed - note that this
 108 will affect many of standard C library functions such as printf() or strftime().
 109 Second, this wxLocale object becomes the new current global locale for the
 110 application and so all subsequent calls to wxGetTranslation() will try to
 111 translate the messages using the message catalogs for this locale.
 112
 113 Returns TRUE on success or FALSE if the given locale couldn't be set.
 114
 115 \membersection{wxLocale::IsLoaded}\label{wxlocaleisloaded}
 116
 117 \constfunc{bool}{IsLoaded}{\param{const char }{*szDomain}}
 118
 119 Check if the given catalog (according to GNU gettext tradition each catalog
 120 normally corresponds to 'domain' which is more or less the application name)
 121 is loaded, returns TRUE if it is.
 122
 123 See also: \helpref{AddCatalog}{wxlocaleaddcatalog}
 124
 125 \membersection{wxLocale::GetName}\label{wxlocalegetname}
 126
 127 \constfunc{const wxString\&}{GetName}{\void}
 128
 129 Returns the current short name for the locale (as given to the constructor or
 130 the Init() function).
 131
 132 \membersection{wxLocale::GetString}\label{wxlocalegetstring}
 133
 134 \constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szDomain = NULL}}
 135
 136 Retrieve the translation for a string in all loaded domains unless the szDomain
 137 parameter is specified (and then only this catalog/domain is searched).
 138
 139 Returns original string if translation is not available
 140 (in this case an error message is generated the first time
 141 a string is not found; use \helpref{wxLogNull}{wxlogoverview} to suppress it).
 142
 143 Remark: domains are searched in the last to first order, i.e. catalogs
 144 added later override those added before.