X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c3d02b684327b1f1faeec42de2db53a4a2279620..c07103f267adc57a49d2fffa12acdd06b3ff7a57:/docs/latex/wx/wxstring.tex diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index d532d9a5e8..6b0e6227a1 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -16,6 +16,11 @@ method ({\tt length()} in this case, always the lowercase version) should be used as it will ensure smoother transition to {\tt std::string} when wxWidgets starts using it instead of wxString. +Also please note that in this manual \texttt{char} is sometimes used instead of +\texttt{wxChar} because it hasn't been fully updated yet. Please substitute as +necessary and refer to the sources in case of a doubt. + + \wxheading{Derived from} None @@ -540,7 +545,7 @@ Returns the empty string if {\it ch} is not found. \membersection{wxString::c\_str}\label{wxstringcstr} -\constfunc{const char *}{c\_str}{\void} +\constfunc{const wxChar *}{c\_str}{\void} Returns a pointer to the string data ({\tt const char*} in ANSI build, {\tt const wchar\_t*} in Unicode build). @@ -560,6 +565,8 @@ See also: \helpref{Empty}{wxstringempty} \membersection{wxString::Cmp}\label{wxstringcmp} +\constfunc{int}{Cmp}{\param{const wxString\&}{ s}} + \constfunc{int}{Cmp}{\param{const char*}{ psz}} Case-sensitive comparison. @@ -572,6 +579,8 @@ See also \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissa \membersection{wxString::CmpNoCase}\label{wxstringcmpnocase} +\constfunc{int}{CmpNoCase}{\param{const wxString\&}{ s}} + \constfunc{int}{CmpNoCase}{\param{const char*}{ psz}} Case-insensitive comparison. @@ -638,7 +647,7 @@ Same as \helpref{Find}{wxstringfind}. Returns string representation suitable for passing to OS' functions for file handling. In ANSI build, this is same as \helpref{c\_str}{wxstringcstr}. In Unicode build, returned value can be either wide character string -or C string in charset matching the {\tt wxConvFile} object, depending on +or C string in charset matching the {\tt wxConvFileName} object, depending on the OS. \wxheading{See also} @@ -659,7 +668,7 @@ This static function returns the string containing the result of calling \membersection{wxString::FormatV}\label{wxstringformatv} -\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{va\_list }{argptr}} +\func{static wxString}{FormatV}{\param{const wxChar }{*format}, \param{va\_list }{argptr}} This static function returns the string containing the result of calling \helpref{PrintfV}{wxstringprintfv} with the passed parameters on it. @@ -694,7 +703,7 @@ Returns the character at position {\it n} (read-only). \membersection{wxString::GetData}\label{wxstringgetdata} -\constfunc{const char*}{GetData}{\void} +\constfunc{const wxChar*}{GetData}{\void} wxWidgets compatibility conversion. Returns a constant pointer to the data in the string. @@ -1033,7 +1042,7 @@ familiar with C) results. \constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $10$}} -Attempts to convert the string to a unsigned integer in base {\it base}. +Attempts to convert the string to an unsigned integer in base {\it base}. Returns {\tt true} on success in which case the number is stored in the location pointed to by {\it val} or {\tt false} if the string does not represent a valid number in the given base. @@ -1253,7 +1262,7 @@ buffer (which must be writable, of course) you might call it like this: \end{verbatim} Note that the exact usage of this depends on whether on not wxUSE\_STL is enabled. If -wxUSE\_STL is enabled, wxStringBuffer creates a seperate empty character buffer, and +wxUSE\_STL is enabled, wxStringBuffer creates a separate empty character buffer, and if wxUSE\_STL is disabled, it uses GetWriteBuf() from wxString, keeping the same buffer wxString uses intact. In other words, relying on wxStringBuffer containing the old wxString data is probably not a good idea if you want to build your program in both @@ -1318,7 +1327,7 @@ of the string, you might call it like this: \end{verbatim} Note that the exact usage of this depends on whether on not wxUSE\_STL is enabled. If -wxUSE\_STL is enabled, wxStringBuffer creates a seperate empty character buffer, and +wxUSE\_STL is enabled, wxStringBuffer creates a separate empty character buffer, and if wxUSE\_STL is disabled, it uses GetWriteBuf() from wxString, keeping the same buffer wxString uses intact. In other words, relying on wxStringBuffer containing the old wxString data is probably not a good idea if you want to build your program in both @@ -1338,7 +1347,7 @@ None \membersection{wxStringBufferLength::wxStringBufferLength}\label{wxstringbufferlengthctor} -\func{}{wxStringBuffer}{\param{const wxString\& }{str}, \param{size\_t }{len}} +\func{}{wxStringBufferLength}{\param{const wxString\& }{str}, \param{size\_t }{len}} Constructs a writable string buffer object associated with the given string and containing enough space for at least {\it len} characters. Basically, this