Minor tweek for WXPM

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

diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index a70122b4eabb5f35db8cfa8ef8c4b6ab16cef933..5aa5d9d4a57b68680a96fcd50260d976d20eb165 100644 (file)
--- a/docs/latex/wx/wxstring.tex
+++ b/docs/latex/wx/wxstring.tex
@@ -1,10 +1,10 @@
 \section{\class{wxString}}\label{wxstring}
 
-wxString is a class representing a character string. Please see wxString 
-\helpref{overview}{wxstringoverview} for more information about it. As explained
-there, wxStrign implements about 90\% of methods of std::string class (iterators
-are not supported and so all methods which use them are not supported neither),
-but they are not documented here - please see any source of STL documentation.
+wxString is a class representing a character string. Please see the 
+\helpref{wxString overview}{wxstringoverview} for more information about it. As explained
+there, wxString implements about 90\% of methods of the std::string class (iterators
+are not supported, nor all methods which use them).
+These standard functions are not documented in this manual so please see the STL documentation.
 The behaviour of all these functions is identical to the behaviour described
 there.
 
@@ -16,6 +16,12 @@ None
 
 <wx/string.h>
 
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxEmptyString}
+
 \wxheading{See also}
 
 \overview{Overview}{wxstringoverview}
@@ -56,7 +62,7 @@ release builds.
 This section also contains both implicit and explicit conversions to C style
 strings. Although implicit conversion is quite convenient, it is advised to use
 explicit \helpref{c\_str()}{wxstringcstr} method for the sake of clarity. Also
-see \helpref{overiview}{wxstringadvices} for the cases where it is necessary to
+see \helpref{overview}{wxstringadvices} for the cases where it is necessary to
 use it.
 
 \helpref{GetChar}{wxstringgetchar}\\
@@ -126,7 +132,7 @@ lower case and leave the original string unchanged.
 
 \membersection{Searching and replacing}
 
-These functions replace the standard {\it strchr()} and {\it strstr()}
+These functions replace the standard {\it strchr()} and {\it strstr()} 
 functions.
 
 \helpref{Find}{wxstringfind}\\
@@ -139,7 +145,7 @@ insertion operators exist (for basic types only).
 
 \helpref{Printf}{wxstringprintf}\\
 \helpref{PrintfV}{wxstringprintfv}\\
-\helpref{operator \cinsert}{wxstringoperatorout)
+\helpref{operator \cinsert}{wxstringoperatorout}
 
 \membersection{Memory management}
 
@@ -188,7 +194,7 @@ functions instead of them (or, even better, std::string compatible variants).
 \helpref{IsNumber}{wxstringisnumber}\\
 \helpref{IsWord}{wxstringisword}
 
-\membersection{std::string compatibility functions}
+\membersection{std::string compatibility functions}\label{wxstringat}
 
 The supported functions are only listed here, please see any STL reference for
 their documentation.
@@ -457,6 +463,20 @@ Returns the whole string if {\it ch} is not found.
 Gets all characters before the last occurence of {\it ch}.
 Returns the empty string if {\it ch} is not found.
 
+\membersection{wxString::c\_str}\label{wxstringcstr}
+
+\constfunc{const char *}{c\_str}{\void}
+
+Returns a pointer to the string data.
+
+\membersection{wxString::Clear}\label{wxstringclear}
+
+\func{void}{Clear}{\void}
+
+Empties the string and frees memory occupied by it.
+
+See also: \helpref{Empty}{wxstringempty}
+
 \membersection{wxString::Cmp}\label{wxstringcmp}
 
 \constfunc{int}{Cmp}{\param{const char*}{ psz}}
@@ -487,7 +507,7 @@ See also \helpref{Cmp}{wxstringcmp}, \helpref{IsSameAs}{wxstringissameas}.
 #define NO_POS ((int)(-1)) // undefined position
 enum caseCompare {exact, ignoreCase};
 \end{verbatim}
-  
+
 \constfunc{int}{CompareTo}{\param{const char*}{ psz}, \param{caseCompare}{ cmp = exact}}
 
 Case-sensitive comparison. Returns 0 if equal, 1 if greater or -1 if less.
@@ -502,7 +522,9 @@ Returns 1 if target appears anyhere in wxString; else 0.
 
 \func{void}{Empty}{\void}
 
-Reinitializes the string and frees the data.
+Makes the string empty, but doesn't free memory occupied by the string.
+
+See also: \helpref{Clear()}{wxstringclear}.
 
 \membersection{wxString::Find}\label{wxstringfind}
 
@@ -620,7 +642,18 @@ caseSensitive is TRUE by default (case matters).
 
 Returns TRUE if strings are equal, FALSE otherwise.
 
-See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}.
+See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas2}
+
+\membersection{wxString::IsSameAs}\label{wxstringissameas2}
+
+\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = TRUE}}
+
+Test whether the string is equal to the single character {\it c}. The test is
+case-sensitive if {\it caseSensitive} is TRUE (default) or not if it is FALSE.
+
+Returns TRUE if the string is equal to the character, FALSE otherwise.
+
+See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas}
 
 \membersection{wxString::IsWord}\label{wxstringisword}
 
@@ -763,11 +796,6 @@ Returns the number of replacements made.
 
 Returns the last {\it count} characters.
 
-\constfunc{wxString}{Right}{\param{char}{ ch}}
-
-Returns all characters after the last occurence of {\it ch}.
-Returns the whole string if {\it ch} is not found.
-
 \membersection{wxString::SetChar}\label{wxstringsetchar}
 
 \func{void}{SetChar}{\param{size\_t}{ n}, \param{char}{ch}}
@@ -962,4 +990,3 @@ Implicit conversion to a C string.
 
 These comparisons are case-sensitive.
 
-