wxNB_HITTEST_* flags renamed to wxBK_HITTEST_* to serve all book controls.

[wxWidgets.git] / docs / latex / wx / wxstring.tex

diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index 83e38962507bdff25614d374a600e55dbff31559..40305dd47203859ea21a23559b3d3dbd3f678a2e 100644 (file)
--- 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.
 
 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
 \wxheading{Derived from}
 
 None


@@ -119,7 +124,8 @@ length of the prefix then.
 \helpref{CmpNoCase}{wxstringcmpnocase}\\
 \helpref{IsSameAs}{wxstringissameas}\\
 \helpref{Matches}{wxstringmatches}\\
 \helpref{CmpNoCase}{wxstringcmpnocase}\\
 \helpref{IsSameAs}{wxstringissameas}\\
 \helpref{Matches}{wxstringmatches}\\

-\helpref{StartsWith}{wxstringstartswith}
+\helpref{StartsWith}{wxstringstartswith}\\
+\helpref{EndsWith}{wxstringendswith}

 
 \membersection{Substring extraction}\label{substringextractioninwxstring}
 
 
 \membersection{Substring extraction}\label{substringextractioninwxstring}
 


@@ -135,7 +141,9 @@ substring.
 \helpref{BeforeLast}{wxstringbeforelast}\\
 \helpref{AfterFirst}{wxstringafterfirst}\\
 \helpref{AfterLast}{wxstringafterlast}\\
 \helpref{BeforeLast}{wxstringbeforelast}\\
 \helpref{AfterFirst}{wxstringafterfirst}\\
 \helpref{AfterLast}{wxstringafterlast}\\

-\helpref{StartsWith}{wxstringstartswith}
+\helpref{StartsWith}{wxstringstartswith}\\
+\helpref{EndsWith}{wxstringendswith}
+

 
 \membersection{Case conversion}\label{caseconversioninwxstring}
 
 
 \membersection{Case conversion}\label{caseconversioninwxstring}
 


@@ -909,7 +917,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}}
 
 
 \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}
 
 
 \membersection{wxString::RemoveLast}\label{wxstringremovelast}
 


@@ -962,6 +970,16 @@ of the string (i.e. after the prefix) into {\it rest} string if it is not
 {\tt NULL}. Otherwise, the function returns {\tt false} and doesn't modify the 
 {\it rest}.
 
 {\tt NULL}. Otherwise, the function returns {\tt false} and doesn't modify the 
 {\it rest}.
 

+\membersection{wxString::EndsWith}\label{wxstringendswith}
+
+\constfunc{bool}{EndsWith}{\param{const wxChar }{*suffix}, \param{wxString }{*rest = NULL}}
+
+This function can be used to test if the string ends with the specified 
+{\it suffix}. If it does, the function will return {\tt true} and put the
+beginning of the string before the suffix into {\it rest} string if it is not 
+{\tt NULL}. Otherwise, the function returns {\tt false} and doesn't
+modify the {\it rest}.
+

 \membersection{wxString::Strip}\label{wxstringstrip}
 
 \begin{verbatim}
 \membersection{wxString::Strip}\label{wxstringstrip}
 
 \begin{verbatim}


@@ -1040,7 +1058,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
 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.
 
 See \helpref{wxString::ToLong}{wxstringtolong} for the more detailed
 description of the {\it base} parameter.


@@ -1054,7 +1075,8 @@ description of the {\it base} parameter.
 
 \func{wxString\&}{Trim}{\param{bool}{ fromRight = true}}
 
 
 \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}
 
 
 \membersection{wxString::Truncate}\label{wxstringtruncate}
 


@@ -1160,11 +1182,13 @@ Concatenation in place: the argument is appended to the string.
 
 \membersection{wxString::operator []}\label{wxstringoperatorbracket}
 
 
 \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.
 
 
 Element extraction.