X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fd34e3a57091ea00f576647343a506a4a56ea827..d45d30c8682f858321600e2958167d7ef54ebeb5:/docs/latex/wx/wxstring.tex?ds=sidebyside diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index c4ea3afeca..5aa5d9d4a5 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -16,6 +16,12 @@ None +\wxheading{Predefined objects} + +Objects: + +{\bf wxEmptyString} + \wxheading{See also} \overview{Overview}{wxstringoverview} @@ -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}}