X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c59549689ca9333b0dde255dc7d46e0539183e8..c50f92d08cc3633f8127931e7cf5d362ab8ac392:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index b26bd9d119..ca5b6d34c2 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -23,6 +23,7 @@ the corresponding topic. \helpref{IMPLEMENT\_CLASS}{implementclass}\\ \helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\ \helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\ +\helpref{ngettext}{ngettext}\\ \helpref{wxCONCAT}{wxconcat}\\ \helpref{WXDEBUG\_NEW}{debugnew}\\ \helpref{WXTRACELEVEL}{tracelevel}\\ @@ -1395,10 +1396,28 @@ deleted with the {\it delete} operator. This function is deprecated, use \helpref{wxString}{wxstring} class instead. +\membersection{ngettext}\label{ngettext} + +\func{const wxChar *}{ngettext}{\param{const char *}{str}, \param{const char *}{strPlural}, \param{size\_t }{n}} + +This macro expands into a call to plural form version of +\helpref{wxGetTranslation}{wxgettranslation} +function, so it marks the message for the extraction by {\tt xgettext} just as +\helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of +the string for the current locale during execution, either singular or plural +form depending on the value of \arg{n}. + +\wxheading{See also} + +\helpref{\_}{underscore} + + \membersection{::wxGetTranslation}\label{wxgettranslation} \func{const char *}{wxGetTranslation}{\param{const char * }{str}} +\func{const char *}{wxGetTranslation}{\param{const char * }{str}, \param{const char * }{strPlural}, \param{size\_t }{n}} + This function returns the translation of string {\it str} in the current \helpref{locale}{wxlocale}. If the string is not found in any of the loaded message catalogs (see \helpref{internationalization overview}{internationalization}), the @@ -1408,6 +1427,17 @@ is used very often, an alternative (and also common in Unix world) syntax is provided: the \helpref{\_()}{underscore} macro is defined to do the same thing as wxGetTranslation. +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{str} +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{strPlural} 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{str} is returned if `n == 1', +otherwise \arg{strPlural}. The \helpref{ngettext}{ngettext} macro is defined +to do the same thing. +See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling. \membersection{::wxIsEmpty}\label{wxisempty} @@ -1601,6 +1631,10 @@ the string for the current locale during execution. Don't confuse this macro with \helpref{\_T()}{underscoret}! +\wxheading{See also} + +\helpref{ngettext}{ngettext} + \membersection{\_T}\label{underscoret}