\section{\class{wxString}}\label{wxstring}
+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.
+
\wxheading{Derived from}
None
+\wxheading{Include files}
+
+<wx/string.h>
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxEmptyString}
+
\wxheading{See also}
\overview{Overview}{wxstringoverview}
-\latexignore{\rtfignore{\wxheading{Members}}}
+\latexignore{\rtfignore{\wxheading{Function groups}}}
+
+\membersection{Constructors and assignment operators}
+
+A string may be constructed either from a C string, (some number of copies of)
+a single character or a wide (UNICODE) string. For all constructors (except the
+default which creates an empty string) there is also a corresponding assignment
+operator.
+
+\helpref{wxString}{wxstringconstruct}\\
+\helpref{operator $=$}{wxstringoperatorassign}\\
+\helpref{\destruct{wxString}}{wxstringdestruct}
+
+\membersection{String length}
+
+These functions return the string length and check whether the string is empty
+or empty it.
+
+\helpref{Len}{wxstringlen}\\
+\helpref{IsEmpty}{wxstringisempty}\\
+\helpref{operator!}{wxstringoperatornot}\\
+\helpref{Empty}{wxstringempty}\\
+\helpref{Clear}{wxstringclear}
+
+\membersection{Character access}
+
+Many functions in this section take a character index in the string. As with C
+strings and/or arrays, the indices start from $0$, so the first character of a
+string is string[$0$]. Attempt to access a character beyond the end of the
+string (which may be even $0$ if the string is empty) will provoke an assert
+failure in \helpref{debug build}{debuggingoverview}, but no checks are done in
+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{overview}{wxstringadvices} for the cases where it is necessary to
+use it.
+
+\helpref{GetChar}{wxstringgetchar}\\
+\helpref{GetWritableChar}{wxstringgetwritablechar}\\
+\helpref{SetChar}{wxstringsetchar}\\
+\helpref{Last}{wxstringlast}\\
+\helpref{operator []}{wxstringoperatorbracket}\\
+\helpref{c\_str}{wxstringcstr}\\
+\helpref{operator const char*}{wxstringoperatorconstcharpt}
+
+\membersection{Concatenation}
+
+Anything may be concatenated (appended to) with a string. However, you can't
+append something to a C string (including literal constants), so to do this it
+should be converted to a wxString first.
+
+\helpref{operator \cinsert}{wxstringoperatorout}\\
+\helpref{operator $+=$}{wxstringplusequal}\\
+\helpref{operator $+$}{wxstringoperatorplus}\\
+\helpref{Append}{wxstringappend}\\
+\helpref{Prepend}{wxstringprepend}
+
+\membersection{Comparison}
+
+The default comparison function \helpref{Cmp}{wxstringcmp} is case-sensitive and
+so is the default version of \helpref{IsSameAs}{wxstringissameas}. For case
+insensitive comparisons you should use \helpref{CmpNoCase}{wxstringcmpnocase} or
+give a second parameter to IsSameAs. This last function is may be more
+convenient if only equality of the strings matters because it returns a boolean
+true value if the strings are the same and not 0 (which is usually FALSE in C)
+as {\tt Cmp()} does.
+
+\helpref{Matches}{wxstringmatches} is a poor man's regular expression matcher:
+it only understands '*' and '?' metacharacters in the sense of DOS command line
+interpreter.
+
+\helpref{StartsWith}{wxstringstartswith} is helpful when parsing a line of
+text which should start with some predefined prefix and is more efficient than
+doing direct string comparison as you would also have to precalculate the
+length of the prefix then.
+
+\helpref{Cmp}{wxstringcmp}\\
+\helpref{CmpNoCase}{wxstringcmpnocase}\\
+\helpref{IsSameAs}{wxstringissameas}\\
+\helpref{Matches}{wxstringmatches}\\
+\helpref{StartsWith}{wxstringstartswith}
+
+\membersection{Substring extraction}
+
+These functions allow to extract substring from this string. All of them don't
+modify the original string and return a new string containing the extracted
+substring.
+
+\helpref{Mid}{wxstringmid}\\
+\helpref{operator()}{wxstringoperatorparenth}\\
+\helpref{Left}{wxstringleft}\\
+\helpref{Right}{wxstringright}\\
+\helpref{BeforeFirst}{wxstringbeforefirst}\\
+\helpref{BeforeLast}{wxstringbeforelast}\\
+\helpref{AfterFirst}{wxstringafterfirst}\\
+\helpref{AfterLast}{wxstringafterlast}\\
+\helpref{StartsWith}{wxstringstartswith}
+
+\membersection{Case conversion}
+
+The MakeXXX() variants modify the string in place, while the other functions
+return a new string which contains the original text converted to the upper or
+lower case and leave the original string unchanged.
+
+\helpref{MakeUpper}{wxstringmakeupper}\\
+\helpref{Upper}{wxstringupper}\\
+\helpref{MakeLower}{wxstringmakelower}\\
+\helpref{Lower}{wxstringlower}
+
+\membersection{Searching and replacing}
+
+These functions replace the standard {\it strchr()} and {\it strstr()}
+functions.
+
+\helpref{Find}{wxstringfind}\\
+\helpref{Replace}{wxstringreplace}
+
+\membersection{Conversion to numbers}
+
+The string provides functions for conversion to signed and unsigned integer and
+floating point numbers. All three functions take a pointer to the variable to
+put the numeric value in and return TRUE if the {\bf entire} string could be
+converted to a number.
+
+\helpref{ToLong}{wxstringtolong}\\
+\helpref{ToULong}{wxstringtoulong}\\
+\helpref{ToDouble}{wxstringtodouble}
+
+\membersection{Writing values into the string}
+
+Both formatted versions (\helpref{Printf}{wxstringprintf}) and stream-like
+insertion operators exist (for basic types only). Additionally, the
+\helpref{Format}{wxstringformat} function allows to use simply append
+formatted value to a string:
+
+\begin{verbatim}
+ // the following 2 snippets are equivalent
+
+ wxString s = "...";
+ s += wxString::Format("%d", n);
+
+ wxString s;
+ s.Printf("...%d", n);
+\end{verbatim}
+
+\helpref{Format}{wxstringformat}\\
+\helpref{FormatV}{wxstringformatv}\\
+\helpref{Printf}{wxstringprintf}\\
+\helpref{PrintfV}{wxstringprintfv}\\
+\helpref{operator \cinsert}{wxstringoperatorout}
+
+\membersection{Memory management}
+
+These are "advanced" functions and they will be needed quite rarely.
+\helpref{Alloc}{wxstringalloc} and \helpref{Shrink}{wxstringshrink} are only
+interesting for optimization purposes.
+\helpref{GetWriteBuf}{wxstringgetwritebuf} may be very useful when working with
+some external API which requires the caller to provide a writable buffer, but
+extreme care should be taken when using it: before performing any other
+operation on the string \helpref{UngetWriteBuf}{wxstringungetwritebuf} {\bf
+must} be called!
+
+\helpref{Alloc}{wxstringalloc}\\
+\helpref{Shrink}{wxstringshrink}\\
+\helpref{GetWriteBuf}{wxstringgetwritebuf}\\
+\helpref{UngetWriteBuf}{wxstringungetwritebuf}
+
+\membersection{Miscellaneous}
+
+Other string functions.
+
+\helpref{Trim}{wxstringtrim}\\
+\helpref{Pad}{wxstringpad}\\
+\helpref{Truncate}{wxstringtruncate}
+
+\membersection{wxWindows 1.xx compatibility functions}
+
+These functions are deprecated, please consider using new wxWindows 2.0
+functions instead of them (or, even better, std::string compatible variants).
+
+\helpref{SubString}{wxstringsubstring}\\
+\helpref{sprintf}{wxstringsprintf}\\
+\helpref{CompareTo}{wxstringcompareto}\\
+\helpref{Length}{wxstringlength}\\
+\helpref{Freq}{wxstringfreq}\\
+\helpref{LowerCase}{wxstringlowercase}\\
+\helpref{UpperCase}{wxstringuppercase}\\
+\helpref{Strip}{wxstringstrip}\\
+\helpref{Index}{wxstringindex}\\
+\helpref{Remove}{wxstringremove}\\
+\helpref{First}{wxstringfirst}\\
+\helpref{Last}{wxstringlast}\\
+\helpref{Contains}{wxstringcontains}\\
+\helpref{IsNull}{wxstringisnull}\\
+\helpref{IsAscii}{wxstringisascii}\\
+\helpref{IsNumber}{wxstringisnumber}\\
+\helpref{IsWord}{wxstringisword}
+
+\membersection{std::string compatibility functions}\label{wxstringat}
+
+The supported functions are only listed here, please see any STL reference for
+their documentation.
+
+\begin{verbatim}
+ // take nLen chars starting at nPos
+ wxString(const wxString& str, size_t nPos, size_t nLen);
+ // take all characters from pStart to pEnd (poor man's iterators)
+ wxString(const void *pStart, const void *pEnd);
+
+ // lib.string.capacity
+ // return the length of the string
+ size_t size() const;
+ // return the length of the string
+ size_t length() const;
+ // return the maximum size of the string
+ size_t max_size() const;
+ // resize the string, filling the space with c if c != 0
+ void resize(size_t nSize, char ch = '\0');
+ // delete the contents of the string
+ void clear();
+ // returns true if the string is empty
+ bool empty() const;
+
+ // lib.string.access
+ // return the character at position n
+ char at(size_t n) const;
+ // returns the writable character at position n
+ char& at(size_t n);
+
+ // lib.string.modifiers
+ // append a string
+ wxString& append(const wxString& str);
+ // append elements str[pos], ..., str[pos+n]
+ wxString& append(const wxString& str, size_t pos, size_t n);
+ // append first n (or all if n == npos) characters of sz
+ wxString& append(const char *sz, size_t n = npos);
+
+ // append n copies of ch
+ wxString& append(size_t n, char ch);
+
+ // same as `this_string = str'
+ wxString& assign(const wxString& str);
+ // same as ` = str[pos..pos + n]
+ wxString& assign(const wxString& str, size_t pos, size_t n);
+ // same as `= first n (or all if n == npos) characters of sz'
+ wxString& assign(const char *sz, size_t n = npos);
+ // same as `= n copies of ch'
+ wxString& assign(size_t n, char ch);
+
+ // insert another string
+ wxString& insert(size_t nPos, const wxString& str);
+ // insert n chars of str starting at nStart (in str)
+ wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n);
+
+ // insert first n (or all if n == npos) characters of sz
+ wxString& insert(size_t nPos, const char *sz, size_t n = npos);
+ // insert n copies of ch
+ wxString& insert(size_t nPos, size_t n, char ch);
+
+ // delete characters from nStart to nStart + nLen
+ wxString& erase(size_t nStart = 0, size_t nLen = npos);
+
+ // replaces the substring of length nLen starting at nStart
+ wxString& replace(size_t nStart, size_t nLen, const char* sz);
+ // replaces the substring with nCount copies of ch
+ wxString& replace(size_t nStart, size_t nLen, size_t nCount, char ch);
+ // replaces a substring with another substring
+ wxString& replace(size_t nStart, size_t nLen,
+ const wxString& str, size_t nStart2, size_t nLen2);
+ // replaces the substring with first nCount chars of sz
+ wxString& replace(size_t nStart, size_t nLen,
+ const char* sz, size_t nCount);
+
+ // swap two strings
+ void swap(wxString& str);
+
+ // All find() functions take the nStart argument which specifies the
+ // position to start the search on, the default value is 0. All functions
+ // return npos if there were no match.
+
+ // find a substring
+ size_t find(const wxString& str, size_t nStart = 0) const;
+
+ // find first n characters of sz
+ size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const;
+
+ // find the first occurrence of character ch after nStart
+ size_t find(char ch, size_t nStart = 0) const;
+
+ // rfind() family is exactly like find() but works right to left
+
+ // as find, but from the end
+ size_t rfind(const wxString& str, size_t nStart = npos) const;
+
+ // as find, but from the end
+ size_t rfind(const char* sz, size_t nStart = npos,
+ size_t n = npos) const;
+ // as find, but from the end
+ size_t rfind(char ch, size_t nStart = npos) const;
+
+ // find first/last occurrence of any character in the set
+
+ //
+ size_t find_first_of(const wxString& str, size_t nStart = 0) const;
+ //
+ size_t find_first_of(const char* sz, size_t nStart = 0) const;
+ // same as find(char, size_t)
+ size_t find_first_of(char c, size_t nStart = 0) const;
+ //
+ size_t find_last_of (const wxString& str, size_t nStart = npos) const;
+ //
+ size_t find_last_of (const char* s, size_t nStart = npos) const;
+ // same as rfind(char, size_t)
+ size_t find_last_of (char c, size_t nStart = npos) const;
+
+ // find first/last occurrence of any character not in the set
+
+ //
+ size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;
+ //
+ size_t find_first_not_of(const char* s, size_t nStart = 0) const;
+ //
+ size_t find_first_not_of(char ch, size_t nStart = 0) const;
+ //
+ size_t find_last_not_of(const wxString& str, size_t nStart=npos) const;
+ //
+ size_t find_last_not_of(const char* s, size_t nStart = npos) const;
+ //
+ size_t find_last_not_of(char ch, size_t nStart = npos) const;
+
+ // All compare functions return a negative, zero or positive value
+ // if the [sub]string is less, equal or greater than the compare() argument.
+
+ // just like strcmp()
+ int compare(const wxString& str) const;
+ // comparison with a substring
+ int compare(size_t nStart, size_t nLen, const wxString& str) const;
+ // comparison of 2 substrings
+ int compare(size_t nStart, size_t nLen,
+ const wxString& str, size_t nStart2, size_t nLen2) const;
+ // just like strcmp()
+ int compare(const char* sz) const;
+ // substring comparison with first nCount characters of sz
+ int compare(size_t nStart, size_t nLen,
+ const char* sz, size_t nCount = npos) const;
+
+ // substring extraction
+ wxString substr(size_t nStart = 0, size_t nLen = npos) const;
+\end{verbatim}
+
+%%%%% MEMBERS HERE %%%%%
+\helponly{\insertatlevel{2}{
+
+\wxheading{Members}
+
+}}
\membersection{wxString::wxString}\label{wxstringconstruct}
Constructs a string of {\it n} copies of character {\it ch}.
-\func{}{wxString}{\param{const char*}{ psz}, \param{size\_t}{ nLength = STRING\_MAXLEN}}
+\func{}{wxString}{\param{const char*}{ psz}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}}
Takes first {\it nLength} characters from the C string {\it psz}.
-The default value of STRING\_MAXLEN means take all the string.
+The default value of wxSTRING\_MAXLEN means to take all the string.
+
+Note that this constructor may be used even if {\it psz} points to a buffer
+with binary data (i.e. containing {\tt NUL} characters) as long as you provide
+the correct value for {\it nLength}. However, the default form of it works
+only with strings without intermediate {\tt NUL}s because it uses
+{\tt strlen()} to calculate the effective length and it would not give correct
+results otherwise.
-\func{}{wxString}{\param{const unsigned char*}{ psz}, \param{size\_t}{ nLength = STRING\_MAXLEN}}
+\func{}{wxString}{\param{const unsigned char*}{ psz}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}}
For compilers using unsigned char: takes first {\it nLength} characters from the C string {\it psz}.
-The default value of STRING\_MAXLEN means take all the string.
+The default value of wxSTRING\_MAXLEN means take all the string.
\func{}{wxString}{\param{const wchar\_t*}{ psz}}
String destructor. Note that this is not virtual, so wxString must not be inherited from.
-\membersection{wxString::Alloc}\label{wxstringAlloc}
+\membersection{wxString::Alloc}\label{wxstringalloc}
+
+\func{void}{Alloc}{\param{size\_t}{ nLen}}
+
+Preallocate enough space for wxString to store {\it nLen} characters. This function
+may be used to increase speed when the string is constructed by repeated
+concatenation as in
+
+\begin{verbatim}
+
+// delete all vowels from the string
+wxString DeleteAllVowels(const wxString& original)
+{
+ wxString result;
+
+ size_t len = original.length();
+
+ result.Alloc(len);
-\func{void}{Alloc}{\param{uint}{ newsize}}
+ for ( size_t n = 0; n < len; n++ )
+ {
+ if ( strchr("aeuio", tolower(original[n])) == NULL )
+ result += original[n];
+ }
-Preallocate some space for wxString. Only works if the data of this string is not shared.
+ return result;
+}
-\membersection{wxString::Append}\label{wxstringAppend}
+\end{verbatim}
+
+because it will avoid the need of reallocating string memory many times (in case
+of long strings). Note that it does not set the maximal length of a string - it
+will still expand if more than {\it nLen} characters are stored in it. Also, it
+does not truncate the existing string (use
+\helpref{Truncate()}{wxstringtruncate} for this) even if its current length is
+greater than {\it nLen}
+
+\membersection{wxString::Append}\label{wxstringappend}
\func{wxString\&}{Append}{\param{const char*}{ psz}}
Concatenates character {\it ch} to this string, {\it count} times, returning a reference
to it.
-\membersection{wxString::After}\label{wxstringAfter}
+\membersection{wxString::AfterFirst}\label{wxstringafterfirst}
-\constfunc{wxString}{After}{\param{char}{ ch}}
+\constfunc{wxString}{AfterFirst}{\param{char}{ ch}}
-Gets all the characters after the first occurence of {\it ch}.
+Gets all the characters after the first occurrence of {\it ch}.
Returns the empty string if {\it ch} is not found.
-\membersection{wxString::Before}\label{wxstringBefore}
+\membersection{wxString::AfterLast}\label{wxstringafterlast}
+
+\constfunc{wxString}{AfterLast}{\param{char}{ ch}}
+
+Gets all the characters after the last occurrence of {\it ch}.
+Returns the whole string if {\it ch} is not found.
-\constfunc{wxString}{Before}{\param{char}{ ch}}
+\membersection{wxString::BeforeFirst}\label{wxstringbeforefirst}
-Gets all characters before the last occurence of {\it ch}.
-Returns empty string if {\it ch} is not found.
+\constfunc{wxString}{BeforeFirst}{\param{char}{ ch}}
+
+Gets all characters before the first occurrence of {\it ch}.
+Returns the whole string if {\it ch} is not found.
+
+\membersection{wxString::BeforeLast}\label{wxstringbeforelast}
+
+\constfunc{wxString}{BeforeLast}{\param{char}{ ch}}
+
+Gets all characters before the last occurrence 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}
Case-sensitive comparison.
-Returns 0 if equal, +1 if greater or -1 if less.
+Returns a positive value if the string is greater than the argument, zero if
+it is equal to it or a negative value if it is less than the argument (same semantics
+as the standard {\it strcmp()} function).
-See also CmpNoCase, IsSameAs.
+See also \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas}.
\membersection{wxString::CmpNoCase}\label{wxstringcmpnocase}
Case-insensitive comparison.
-Returns 0 if equal, +1 if greater or -1 if less.
+Returns a positive value if the string is greater than the argument, zero if
+it is equal to it or a negative value if it is less than the argument (same semantics
+as the standard {\it strcmp()} function).
-See also Cmp, IsSameAs.
+See also \helpref{Cmp}{wxstringcmp}, \helpref{IsSameAs}{wxstringissameas}.
-\membersection{wxString::CompareTo}\label{wxstringCompareTo}
+\membersection{wxString::CompareTo}\label{wxstringcompareto}
\begin{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.
-\membersection{wxString::Contains}\label{wxstringContains}
+\membersection{wxString::Contains}\label{wxstringcontains}
-\func{bool}{Contains}{\param{const wxString\&}{ str}}
+\constfunc{bool}{Contains}{\param{const wxString\&}{ str}}
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}
Returns the first occurrence of the item.
+\membersection{wxString::Format}\label{wxstringformat}
+
+\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{}{...}}
+
+This static function returns the string containing the result of calling
+\helpref{Printf}{wxstringprintf} with the passed parameters on it.
+
+\wxheading{See also}
+
+\helpref{FormatV}{wxstringformatv}, \helpref{Printf}{wxstringprintf}
+
+\membersection{wxString::FormatV}\label{wxstringformatv}
+
+\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{va\_list }{argptr}}
+
+This static function returns the string containing the result of calling
+\helpref{PrintfV}{wxstringprintfv} with the passed parameters on it.
+
+\wxheading{See also}
+
+\helpref{Format}{wxstringformat}, \helpref{PrintfV}{wxstringprintfv}
+
+\membersection{wxString::Freq}\label{wxstringfreq}
+
+\constfunc{int}{Freq}{\param{char }{ch}}
+
+Returns the number of occurrences of {\it ch} in the string.
+
\membersection{wxString::GetChar}\label{wxstringgetchar}
\constfunc{char}{GetChar}{\param{size\_t}{ n}}
Returns the character at position {\it n} (read-only).
-\membersection{wxString::GetData}\label{wxstringGetData}
+\membersection{wxString::GetData}\label{wxstringgetdata}
\constfunc{const char*}{GetData}{\void}
\membersection{wxString::GetWriteBuf}\label{wxstringgetwritebuf}
-\func{char*}{GetWriteBuf}{\param{uint}{ len}}
+\func{char*}{GetWriteBuf}{\param{size\_t}{ len}}
Returns a writable buffer of at least {\it len} bytes.
Call \helpref{wxString::UngetWriteBuf}{wxstringungetwritebuf} as soon as possible
to put the string back into a reasonable state.
-\membersection{wxString::Index}\label{wxstringIndex}
+\membersection{wxString::Index}\label{wxstringindex}
-\constfunc{size\_t}{Index}{\param{char}{ ch}, \param{int}{ startpos = 0}}
+\constfunc{size\_t}{Index}{\param{char}{ ch}}
Same as \helpref{wxString::Find}{wxstringfind}.
If {\bf caseSensitive}, comparison is case sensitive (the default).
-Returns the index of the first item matched, or NOT\_FOUND.
-
-\membersection{wxString::Insert}\label{wxstringInsert}
+Returns the index of the first item matched, or wxNOT\_FOUND.
-\func{void}{Insert}{\param{const wxString\&}{ str}, \param{uint}{ index}}
-
-Add new element at the given position.
-
-\membersection{wxString::IsAscii}\label{wxstringIsAscii}
+% TODO
+%\membersection{wxString::insert}\label{wxstringinsert}
+% Wrong!
+%\func{void}{insert}{\param{const wxString\&}{ str}, \param{size\_t}{ index}}
+%
+%Add new element at the given position.
+%
+\membersection{wxString::IsAscii}\label{wxstringisascii}
\constfunc{bool}{IsAscii}{\void}
-Returns TRUE if the string is ASCII.
+Returns TRUE if the string contains only ASCII characters.
\membersection{wxString::IsEmpty}\label{wxstringisempty}
\constfunc{bool}{IsEmpty}{\void}
-Returns TRUE if the string is NULL.
+Returns TRUE if the string is empty.
-\membersection{wxString::IsNull}\label{wxstringIsNull}
+\membersection{wxString::IsNull}\label{wxstringisnull}
\constfunc{bool}{IsNull}{\void}
-Returns TRUE if the string is NULL (same as IsEmpty).
+Returns TRUE if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}).
-\membersection{wxString::IsNumber}\label{wxstringIsNumber}
+\membersection{wxString::IsNumber}\label{wxstringisnumber}
\constfunc{bool}{IsNumber}{\void}
-Returns TRUE if the string is a number.
+Returns TRUE if the string is an integer (with possible sign).
\membersection{wxString::IsSameAs}\label{wxstringissameas}
Returns TRUE if strings are equal, FALSE otherwise.
-See also Cmp, CmpNoCase.
+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.
-\membersection{wxString::IsWord}\label{wxstringIsWord}
+See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas}
+
+\membersection{wxString::IsWord}\label{wxstringisword}
\constfunc{bool}{IsWord}{\void}
Returns TRUE if the string is a word. TODO: what's the definition of a word?
-\membersection{wxString::Last}\label{wxstringLast}
+\membersection{wxString::Last}\label{wxstringlast}
\constfunc{char}{Last}{\void}
\constfunc{wxString}{Left}{\param{size\_t}{ count}}
-Returns the first {\it count} characters.
-
-\constfunc{wxString}{Left}{\param{char}{ ch}}
-
-Returns all characters before the first occurence of {\it ch}.
-Returns the whole string if {\it ch} is not found.
+Returns the first {\it count} characters of the string.
\membersection{wxString::Len}\label{wxstringlen}
Returns the length of the string (same as Len).
-\membersection{wxString::LowerCase}\label{wxstringLowerCase}
+\membersection{wxString::Lower}\label{wxstringlower}
+
+\constfunc{wxString}{Lower}{\void}
+
+Returns this string converted to the lower case.
+
+\membersection{wxString::LowerCase}\label{wxstringlowercase}
\func{void}{LowerCase}{\void}
Converts all characters to upper case.
-\membersection{wxString::Matches}\label{wxstringMatches}
+\membersection{wxString::Matches}\label{wxstringmatches}
\constfunc{bool}{Matches}{\param{const char*}{ szMask}}
\membersection{wxString::Mid}\label{wxstringmid}
-\constfunc{wxString}{Mid}{\param{size\_t}{ first}, \param{size\_t}{ count = STRING\_MAXLEN}}
+\constfunc{wxString}{Mid}{\param{size\_t}{ first}, \param{size\_t}{ count = wxSTRING\_MAXLEN}}
Returns a substring starting at {\it first}, with length {\it count}, or the rest of
the string if {\it count} is the default value.
Removes spaces from the left or from the right (default).
-\membersection{wxString::Prepend}\label{wxstringPrepend}
+\membersection{wxString::Prepend}\label{wxstringprepend}
\func{wxString\&}{Prepend}{\param{const wxString\&}{ str}}
\func{int}{Printf}{\param{const char* }{pszFormat}, \param{}{...}}
-Similar to sprintf. Returns the number of characters written, or an integer less than zero
-on error.
+Similar to the standard function {\it sprintf()}. Returns the number of
+characters written, or an integer less than zero on error.
+
+{\bf NB:} This function will use a safe version of {\it vsprintf()} (usually called
+{\it vsnprintf()}) whenever available to always allocate the buffer of correct
+size. Unfortunately, this function is not available on all platforms and the
+dangerous {\it vsprintf()} will be used then which may lead to buffer overflows.
\membersection{wxString::PrintfV}\label{wxstringprintfv}
Similar to vprintf. Returns the number of characters written, or an integer less than zero
on error.
-\membersection{wxString::Remove}\label{wxstringRemove}
+\membersection{wxString::Remove}\label{wxstringremove}
\func{wxString\&}{Remove}{\param{size\_t}{ pos}}
\func{wxString\&}{Remove}{\param{size\_t}{ pos}, \param{size\_t}{ len}}
-Removes the last {\it len} characters from the string, starting at {\it pos}.
+Removes the {\it len} characters from the string, starting at {\it pos}.
\membersection{wxString::RemoveLast}\label{wxstringremovelast}
Removes the last character.
-\membersection{wxString::Replace}\label{wxstringReplace}
+\membersection{wxString::Replace}\label{wxstringreplace}
-\func{uint}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll}}
+\func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = TRUE}}
-Replace first (or all) occurences of substring with another one.
+Replace first (or all) occurrences of substring with another one.
-{\it replaceAll}: global replace (default), or only the first occurence.
+{\it replaceAll}: global replace (default), or only the first occurrence.
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}}
\func{void}{Shrink}{\void}
-Minimizes the string's memory. Only works if the data of this string is not shared.
+Minimizes the string's memory. This can be useful after a call to
+\helpref{Alloc()}{wxstringalloc} if too much memory were preallocated.
\membersection{wxString::sprintf}\label{wxstringsprintf}
The same as Printf.
-\membersection{wxString::Strip}\label{wxstringStrip}
+\membersection{wxString::StartsWith}\label{wxstringstartswith}
+
+\constfunc{bool}{StartsWith}{\param{const wxChar }{*prefix}, \param{wxString }{*rest = NULL}}
+
+This function can be used to test if the string starts with the specified
+{\it prefix}. If it does, the function will return {\tt TRUE} and put the rest
+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}.
+
+\membersection{wxString::Strip}\label{wxstringstrip}
\begin{verbatim}
enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
Strip characters at the front and/or end. The same as Trim except that it
doesn't change this string.
+\membersection{wxString::SubString}\label{wxstringsubstring}
+
+\constfunc{wxString}{SubString}{\param{size\_t}{ from}, \param{size\_t}{ to}}
+
+Deprecated, use \helpref{Mid}{wxstringmid} instead (but note that parameters
+have different meaning).
+
+Returns the part of the string between the indices {\it from} and {\it to}
+inclusive.
+
+\membersection{wxString::ToDouble}\label{wxstringtodouble}
+
+\constfunc{bool}{ToDouble}{\param{double}{ *val}}
+
+Attempts to convert the string to a floating point number. Returns TRUE on
+success (the number is stored in the location pointed to by {\it val}) or FALSE
+if the string does not represent such number.
+
+\wxheading{See also}
+
+\helpref{wxString::ToLong}{wxstringtolong},\\
+\helpref{wxString::ToULong}{wxstringtoulong}
+
+\membersection{wxString::ToLong}\label{wxstringtolong}
+
+\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = $10$}}
+
+Attempts to convert the string to a signed 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.
+
+The value of {\it base} must be comprised between $2$ and $36$, inclusive, or
+be a special value $0$ which means that the usual rules of {\tt C} numbers are
+applied: if the number starts with {\tt 0x} it is considered to be in base
+$16$, if it starts with {\tt 0} - in base $8$ and in base $10$ otherwise. Note
+that you may not want to specify the base $0$ if you are parsing the numbers
+which may have leading zeroes as they can yield unexpected (to the user not
+familiar with C) results.
+
+\wxheading{See also}
+
+\helpref{wxString::ToDouble}{wxstringtodouble},\\
+\helpref{wxString::ToULong}{wxstringtoulong}
+
+\membersection{wxString::ToULong}\label{wxstringtoulong}
+
+\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $10$}}
+
+Attempts to convert the string to a ansigned 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.
+
+See \helpref{wxString::ToLong}{wxstringtolong} for the more detailed
+description of the {\it base} parameter.
+
+\wxheading{See also}
+
+\helpref{wxString::ToDouble}{wxstringtodouble},\\
+\helpref{wxString::ToLong}{wxstringtolong}
+
\membersection{wxString::Trim}\label{wxstringtrim}
\func{wxString\&}{Trim}{\param{bool}{ fromRight = TRUE}}
Puts the string back into a reasonable state, after
\rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called.
-\membersection{wxString::UpperCase}\label{wxstringUpperCase}
+\membersection{wxString::Upper}\label{wxstringupper}
+
+\constfunc{wxString}{Upper}{\void}
+
+Returns this string converted to upper case.
+
+\membersection{wxString::UpperCase}\label{wxstringuppercase}
\func{void}{UpperCase}{\void}
The same as MakeUpper.
+\membersection{wxString::operator!}\label{wxstringoperatornot}
+
+\constfunc{bool}{operator!}{\void}
+
+Empty string is FALSE, so !string will only return TRUE if the string is empty.
+This allows the tests for NULLness of a {\it const char *} pointer and emptyness
+of the string to look the same in the code and makes it easier to port old code
+to wxString.
+
+See also \helpref{IsEmpty()}{wxstringisempty}.
+
\membersection{wxString::operator $=$}\label{wxstringoperatorassign}
\func{wxString\&}{operator $=$}{\param{const wxString\&}{ str}}
\func{wxString\&}{operator $=$}{\param{const wchar\_t*}{ pwz}}
-Assignment.
-
-\membersection{wxString::operator $+=$}\label{wxstringPlusEqual}
+Assignment: the effect of each operation is the same as for the corresponding
+constructor (see \helpref{wxString constructors}{wxstringconstruct}).
+
+\membersection{wxString::operator $+$}\label{wxstringoperatorplus}
+
+Concatenation: all these operators return a new strign equal to the sum of the
+operands.
+
+\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
+
+\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const char*}{ y}}
+
+\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{char}{ y}}
+
+\func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxString\&}{ y}}
+
+\membersection{wxString::operator $+=$}\label{wxstringplusequal}
\func{void}{operator $+=$}{\param{const wxString\&}{ str}}
\func{void}{operator $+=$}{\param{char}{ c}}
-Concatenation.
+Concatenation in place: the argument is appended to the string.
\membersection{wxString::operator []}\label{wxstringoperatorbracket}
\membersection{wxString::operator \cinsert}\label{wxstringoperatorout}
-\func{wxString\&}{operator \cinsert}{\\param{const wxString\&}{ str}}
+\func{wxString\&}{operator \cinsert}{\param{const wxString\&}{ str}}
-\func{wxString\&}{operator \cinsert}{\\param{const char*}{ psz}}
+\func{wxString\&}{operator \cinsert}{\param{const char*}{ psz}}
-\func{wxString\&}{operator \cinsert}{\\param{char }{ch}}
+\func{wxString\&}{operator \cinsert}{\param{char }{ch}}
Same as $+=$.
+\func{wxString\&}{operator \cinsert}{\param{int}{ i}}
+
+\func{wxString\&}{operator \cinsert}{\param{float}{ f}}
+
+\func{wxString\&}{operator \cinsert}{\param{double}{ d}}
+
+These functions work as C++ stream insertion operators: they insert the given
+value into the string. Precision or format cannot be set using them, you can use
+\helpref{Printf}{wxstringprintf} for this.
+
\membersection{wxString::operator \cextract}\label{wxstringoperatorin}
\func{friend istream\&}{operator \cextract}{\param{istream\&}{ is}, \param{wxString\&}{ str}}
Implicit conversion to a C string.
-\membersection{Comparison operators}\label{wxstringComparison}
+\membersection{Comparison operators}\label{wxstringcomparison}
\func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
These comparisons are case-sensitive.
-\membersection{operator $+$}\label{wxstringoperatorplus}
-\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}
+\section{\class{wxStringBuffer}}\label{wxstringbuffer}
-\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const char*}{ y}}
+This tiny class allows to conveniently access the \helpref{wxString}{wxstring}
+internal buffer as a writable pointer without any risk to forget to restore
+the string to the usable state later.
-\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{char}{ y}}
+For example, assuming you have a low-level OS function called
+{\tt GetMeaningOfLifeAsString(char *)} returning the value in the provided
+buffer (which must be writable, of course) you might call it like this:
-\func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxString\&}{ y}}
+\begin{verbatim}
+ wxString theAnswer;
+ GetMeaningOfLifeAsString(wxStringBuffer(theAnswer, 1024));
+ if ( theAnswer != "42" )
+ {
+ wxLogError("Something is very wrong!");
+ }
+\end{verbatim}
+
+\wxheading{Derived from}
+
+None
+
+\wxheading{Include files}
+
+<wx/string.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxStringBuffer::wxStringBuffer}
+
+\func{}{wxStringBuffer}{\param{const wxString\& }{str}, \param{size\_t }{len}}
+
+Constructs a writable string buffer object associated with the given string
+and containing enough space for at least {\it len} characters. Basically, this
+is equivalent to calling \helpref{GetWriteBuf}{wxstringgetwritebuf} and
+saving the result.
+
+\membersection{wxStringBuffer::\destruct{wxStringBuffer}}
+
+\func{}{\destruct{wxStringBuffer}}{\void}
+
+Restores the string passed to the constructor to the usable state by calling
+\helpref{UngetWriteBuf}{wxstringungetwritebuf} on it.
+
+\membersection{wxStringBuffer::operator wxChar *}
+
+\constfunc{wxChar *}{operator wxChar *}{\void}
+
+Returns the writable pointer to a buffer of the size at least equal to the
+length specified in the constructor.
projects / wxWidgets.git / blobdiff