X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/84ed77ef28c568c729de218f821cf25bb5c7c2d7..b19d7524fc5787218b54cc28dc23bf319e413b4a:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index c235d3d3ef..545b103690 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -6,8 +6,6 @@ The functions and macros defined in wxWindows are described here: you can either look up a function using the alphabetical listing of them or find it in the corresponding topic. - - \section{Alphabetical functions and macros list} \helpref{CLASSINFO}{classinfo}\\ @@ -23,6 +21,8 @@ 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}\\ \helpref{WXTRACE}{trace}\\ @@ -221,8 +221,6 @@ the corresponding topic. \helpref{wxSysErrorCode}{wxsyserrorcode}\\ \helpref{wxSysErrorMsg}{wxsyserrormsg}\\ \helpref{wxT}{wxt}\\ -\helpref{wxToLower}{wxtolower}\\ -\helpref{wxToUpper}{wxtoupper}\\ \helpref{wxTraceLevel}{wxtracelevel}\\ \helpref{wxTrace}{wxtrace}\\ \helpref{wxTransferFileToStream}{wxtransferfiletostream}\\ @@ -581,7 +579,7 @@ single string.} array, any additional ones are the command parameters and the array must be terminated with a NULL pointer.} -\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC}, +\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC},\rtfsp {\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}} \docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}} @@ -635,7 +633,7 @@ enum wxSignal \end{verbatim} {\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning -under both Unix and Windows but all the other signals are equivalent to +under both Unix and Windows but all the other signals are equivalent to {\tt wxSIGTERM} under Windows. Returns 0 on success, -1 on failure. If {\it rc} parameter is not NULL, it will @@ -797,7 +795,7 @@ other threads start calling it, if this is not the case this approach can \func{}{wxENTER\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}} -This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if +This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. @@ -815,7 +813,7 @@ Returns {\tt true} if this thread is the main one. Always returns {\tt true} if \func{}{wxLEAVE\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}} -This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if +This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. @@ -898,8 +896,7 @@ slashes. \func{bool}{wxFileExists}{\param{const wxString\& }{filename}} -Returns true if the file exists. It also returns true if the file is -a directory. +Returns true if the file exists and is a plain file. \membersection{::wxFileModificationTime}\label{wxfilemodificationtime} @@ -972,7 +969,7 @@ directory doesn't exist). \wxheading{Portability} -This function is implemented for Win16 (only for drives less than 2Gb), Win32, +This function is implemented for Win32, Mac OS and generic Unix provided the system has {\tt statfs()} function. This function first appeared in wxWindows 2.3.2. @@ -1394,10 +1391,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 @@ -1407,6 +1422,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} @@ -1533,18 +1559,22 @@ static array of strings containing the weekday names and which have to be translated (note that it is a bad example, really, as \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week day names already). If you write + \begin{verbatim} static const wxChar * const weekdays[] = { _("Mon"), ..., _("Sun") }; ... // use weekdays[n] as usual \end{verbatim} + the code wouldn't compile because the function calls are forbidden in the array initializer. So instead you should do + \begin{verbatim} static const wxChar * const weekdays[] = { wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun") }; ... // use wxGetTranslation(weekdays[n]) \end{verbatim} + here. Note that although the code {\bf would} compile if you simply omit @@ -1554,28 +1584,6 @@ wxGetTranslation wouldn't find them. -\membersection{::wxToLower}\label{wxtolower} - -\func{char}{wxToLower}{\param{char }{ch}} - -Converts the character to lower case. This is implemented as a macro for efficiency. - -\wxheading{Include files} - - - - -\membersection{::wxToUpper}\label{wxtoupper} - -\func{char}{wxToUpper}{\param{char }{ch}} - -Converts the character to upper case. This is implemented as a macro for efficiency. - -\wxheading{Include files} - - - - \membersection{::wxVsnprintf}\label{wxvsnprintf} \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}} @@ -1600,6 +1608,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} @@ -2529,6 +2541,13 @@ The clipboard must have previously been opened for this call to succeed. \section{Miscellaneous functions}\label{miscellany} +\membersection{wxCONCAT}\label{wxconcat} + +\func{}{wxCONCAT}{\param{}{x}, \param{}{y}} + +This macro returns the concatenation of two tokens \arg{x} and \arg{y}. + + \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction} \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}} @@ -2653,7 +2672,7 @@ Initializes the DDE system. May be called multiple times without harm. This no longer needs to be called by the application: it will be called by wxWindows if necessary. -See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection}, +See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp \helpref{wxDDECleanUp}{wxddecleanup}. \wxheading{Include files} @@ -3560,7 +3579,9 @@ the value of the trace mask (possible during the run-time). For the second function (taking a string mask), the message is logged only if the mask has been previously enabled by the call to -\helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks +\helpref{AddTraceMask}{wxlogaddtracemask} or by setting +\helpref{{\tt WXTRACE} environment variable}{envvars}. +The predefined string trace masks used by wxWindows are: \begin{itemize}\itemsep=0pt @@ -3927,6 +3948,11 @@ use it on the same line in two different source files. In this case you may either change the line in which either of them appears on or use the \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro. +Also note that Microsoft Visual C++ has a bug which results in compiler errors +if you use this macro with ``Program Database For Edit And Continue'' +(\texttt{/ZI}) option, so you shouldn't use it (``Program Database'' +(\texttt{/Zi}) is ok though) for the code making use of this macro. + \wxheading{See also} \helpref{wxASSERT\_MSG}{wxassertmsg},\\