X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/483b0434bfa1b10d2522ac0affe8758e629c21ee..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/mbconv.tex diff --git a/docs/latex/wx/mbconv.tex b/docs/latex/wx/mbconv.tex index cf9e3553bf..22d7e99345 100644 --- a/docs/latex/wx/mbconv.tex +++ b/docs/latex/wx/mbconv.tex @@ -30,8 +30,19 @@ There are several predefined instances of this class: \twocolitem{\textbf{wxConvLibc}}{Uses the standard ANSI C \texttt{mbstowcs()} and \texttt{wcstombs()} functions to perform the conversions; thus depends on the current locale.} +\twocolitem{\textbf{wxConvLocal}}{Another conversion corresponding to the +current locale but this one uses the best available conversion.} +\twocolitem{\textbf{wxConvUI}}{The conversion used for hte standard UI elements +such as menu items and buttons. This is a pointer which is initially set to +\texttt{wxConvLocal} as the program uses the current locale by default but can +be set to some specific conversion if the program needs to use a specific +encoding for its UI.} +\twocolitem{\textbf{wxConvISO8859\_1}}{Conversion to and from ISO-8859-1 (Latin I) +encoding.} +\twocolitem{\textbf{wxConvUTF8}}{Conversion to and from UTF-8 encoding.} \twocolitem{\textbf{wxConvFile}}{The appropriate conversion for the file names, depends on the system.} +% \twocolitem{\textbf{wxConvCurrent}}{Not really clear what is it for...} \end{twocollist} @@ -207,30 +218,10 @@ return type (without const). \membersection{wxMBConv::FromWChar}\label{wxmbconvfromwchar} -\constfunc{virtual size\_t}{FromWChar}{\param{wchar\_t *}{dst}, \param{size\_t }{dstLen}, \param{const char *}{src}, \param{size\_t }{srcLen = $-1$}} - -The most general function for converting a multibyte string to a wide string. -The main case is when \arg{dst} is not \NULL and \arg{srcLen} is not $-1$: then -the function converts exactly \arg{srcLen} bytes starting at \arg{src} into -wide string which it output to \arg{dst}. If the length of the resulting wide -string is greater than \arg{dstLen}, an error is returned. Note that if -\arg{srcLen} bytes don't include \NUL characters, the resulting wide string is -not \NUL-terminated neither. - -If \arg{srcLen} is $-1$, the function supposes that the string is properly -(i.e. as necessary for the encoding handled by this conversion) \NUL-terminated -and converts the entire string, including any trailing \NUL bytes. In this case -the wide string is also \NUL-terminated. - -Finally, if \arg{dst} is \NULL, the function returns the length of the needed -buffer. - -\wxheading{Return value} - -The number of characters written to \arg{dst} (or the number of characters -which would have been written to it if it were non-\NULL) on success or -\texttt{wxCONV\_FAILED} on error. +\constfunc{virtual size\_t}{FromWChar}{\param{char\_t *}{dst}, \param{size\_t }{dstLen}, \param{const wchar\_t *}{src}, \param{size\_t }{srcLen = wxNO\_LEN}} +This function has the same semantics as \helpref{ToWChar}{wxmbconvtowchar} +except that it converts a wide string to multibyte one. \membersection{wxMBConv::GetMaxMBNulLen}\label{wxmbconvgetmaxmbnullen} @@ -251,14 +242,35 @@ trailing \NUL characters for any encoding. This function returns $1$ for most of the multibyte encodings in which the string is terminated by a single \NUL, $2$ for UTF-16 and $4$ for UTF-32 for which the string is terminated with $2$ and $4$ \NUL characters respectively. -The other cases are not currently supported and $-1$ is returned for them. +The other cases are not currently supported and \texttt{wxCONV\_FAILED} +(defined as $-1$) is returned for them. \membersection{wxMBConv::ToWChar}\label{wxmbconvtowchar} -\constfunc{virtual size\_t}{ToWChar}{\param{char\_t *}{dst}, \param{size\_t }{dstLen}, \param{const wchar\_t *}{src}, \param{size\_t }{srcLen = $-1$}} +\constfunc{virtual size\_t}{ToWChar}{\param{wchar\_t *}{dst}, \param{size\_t }{dstLen}, \param{const char *}{src}, \param{size\_t }{srcLen = wxNO\_LEN}} -This function has the same semantics as \helpref{FromWChar}{wxmbconvfromwchar} -except that it converts a wide string to multibyte one. +The most general function for converting a multibyte string to a wide string. +The main case is when \arg{dst} is not \NULL and \arg{srcLen} is not +\texttt{wxNO\_LEN} (which is defined as \texttt{(size\_t)$-1$}): then +the function converts exactly \arg{srcLen} bytes starting at \arg{src} into +wide string which it output to \arg{dst}. If the length of the resulting wide +string is greater than \arg{dstLen}, an error is returned. Note that if +\arg{srcLen} bytes don't include \NUL characters, the resulting wide string is +not \NUL-terminated neither. + +If \arg{srcLen} is \texttt{wxNO\_LEN}, the function supposes that the string is +properly (i.e. as necessary for the encoding handled by this conversion) +\NUL-terminated and converts the entire string, including any trailing \NUL +bytes. In this case the wide string is also \NUL-terminated. + +Finally, if \arg{dst} is \NULL, the function returns the length of the needed +buffer. + +\wxheading{Return value} + +The number of characters written to \arg{dst} (or the number of characters +which would have been written to it if it were non-\NULL) on success or +\texttt{wxCONV\_FAILED} on error.