X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4a6e4a46a356e9abf0760e2d481bbec321cc3adf..a729c3447523809786607aa3c62b17059b2c7842:/docs/latex/wx/locale.tex diff --git a/docs/latex/wx/locale.tex b/docs/latex/wx/locale.tex index ed44298e9e..e550878563 100644 --- a/docs/latex/wx/locale.tex +++ b/docs/latex/wx/locale.tex @@ -474,6 +474,8 @@ the Init() function). \constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szDomain = NULL}} +\constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szOrigString2}, \param{size\_t }{n}, \param{const char }{*szDomain = NULL}} + Retrieves the translation for a string in all loaded domains unless the szDomain parameter is specified (and then only this catalog/domain is searched). @@ -481,6 +483,17 @@ Returns original string if translation is not available (in this case an error message is generated the first time a string is not found; use \helpref{wxLogNull}{wxlogoverview} to suppress it). +The second form is used when retrieving translation of string that has +different singular and plural form in English or different plural forms in some +other language. It takes two extra arguments: \arg{szOrigString} +parameter must contain the singular form of the string to be converted. +It is also used as the key for the search in the catalog. +The \arg{szOrigString2} parameter is the plural form (in English). +The parameter \arg{n} is used to determine the plural form. If no +message catalog is found \arg{szOrigString} is returned if `n == 1', +otherwise \arg{szOrigString2}. +See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling. + \wxheading{Remarks} Domains are searched in the last to first order, i.e. catalogs