X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9a75ba66de8f9dd3ebac0f41ec2e27be6d95aa73..e4861c72be058dd9d7e12cb77127d0be523414c8:/docs/latex/wx/wxstring.tex diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 12638a0d79..e6f1334c4f 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 @@ -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} @@ -905,7 +914,7 @@ Same as Truncate. Removes the portion from {\it pos} to the end of the string. \func{wxString\&}{Remove}{\param{size\_t}{ pos}, \param{size\_t}{ len}} -Removes the {\it len} characters from the string, starting at {\it pos}. +Removes {\it len} characters from the string, starting at {\it pos}. \membersection{wxString::RemoveLast}\label{wxstringremovelast} @@ -1036,7 +1045,10 @@ familiar with C) results. 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. +represent a valid number in the given base. Please notice that this function +behaves in the same way as the standard \texttt{strtoul()} and so it simply +converts negative numbers to unsigned representation instead of rejecting them +(e.g. $-1$ is returned as \texttt{ULONG\_MAX}). See \helpref{wxString::ToLong}{wxstringtolong} for the more detailed description of the {\it base} parameter. @@ -1050,7 +1062,8 @@ description of the {\it base} parameter. \func{wxString\&}{Trim}{\param{bool}{ fromRight = true}} -Removes spaces from the left or from the right (default). +Removes white-space (space, tabs, form feed, newline and carriage return) from +the left or from the right end of the string (right is default). \membersection{wxString::Truncate}\label{wxstringtruncate} @@ -1156,11 +1169,13 @@ Concatenation in place: the argument is appended to the string. \membersection{wxString::operator []}\label{wxstringoperatorbracket} -\func{char\&}{operator []}{\param{size\_t}{ i}} +\func{wxChar\&}{operator []}{\param{size\_t}{ i}} + +\constfunc{wxChar}{operator []}{\param{size\_t}{ i}} -\func{char}{operator []}{\param{size\_t}{ i}} +\func{wxChar\&}{operator []}{\param{int}{ i}} -\func{char}{operator []}{\param{int}{ i}} +\constfunc{wxChar}{operator []}{\param{int}{ i}} Element extraction. @@ -1253,7 +1268,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 +1333,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