Corrected event.h for wxKeyEvent/wxMouseEvent, and corresponding docs

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

diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index 3b06d4fecf2e90de4e170fa85afddda26fd57c37..467d206db5b360414af0562ac9b0bc28a5932e1f 100644 (file)
--- a/docs/latex/wx/wxstring.tex
+++ b/docs/latex/wx/wxstring.tex
@@ -16,6 +16,12 @@ None
 
 <wx/string.h>
 
 
 <wx/string.h>
 

+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxEmptyString}
+

 \wxheading{See also}
 
 \overview{Overview}{wxstringoverview}
 \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
 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}\\
 use it.
 
 \helpref{GetChar}{wxstringgetchar}\\


@@ -188,7 +194,7 @@ functions instead of them (or, even better, std::string compatible variants).
 \helpref{IsNumber}{wxstringisnumber}\\
 \helpref{IsWord}{wxstringisword}
 
 \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.
 
 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.
 
 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}}
 \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}
 #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.
 \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}
 
 
 \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}
 
 
 \membersection{wxString::Find}\label{wxstringfind}