X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..db67d86dd1de506a5bb14dd59e9c45230120758a:/docs/latex/wx/wxstring.tex diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 5777dcf3eb..40305dd472 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -1,593 +1,1399 @@ \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 (except that wxString is sensitive to null character). + +You may notice that wxString sometimes has many functions which do the same +thing like, for example, \helpref{Length()}{wxstringlength}, +\helpref{Len()}{wxstringlen} and {\tt length()} which all return the string +length. In all cases of such duplication the {\tt std::string}-compatible +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. + +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{Include files} + + + +\wxheading{Predefined objects} + +Objects: + +{\bf wxEmptyString} + +\wxheading{See also} + \overview{Overview}{wxstringoverview} -\helpref{Member functions by category}{wxstringcategories} +\latexignore{\rtfignore{\wxheading{Function groups}}} + +\membersection{Constructors and assignment operators}\label{constructorsinwxstring} + +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}\label{lengthfunctionsinwxstring} + +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}\label{characteraccessinwxstring} + +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{mb\_str}{wxstringmbstr}\\ +\helpref{wc\_str}{wxstringwcstr}\\ +\helpref{fn\_str}{wxstringfnstr}\\ +\helpref{operator const char*}{wxstringoperatorconstcharpt} + +\membersection{Concatenation}\label{concatenationinwxstring} + +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}\label{comparisoninwxstring} + +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}\\ +\helpref{EndsWith}{wxstringendswith} + +\membersection{Substring extraction}\label{substringextractioninwxstring} + +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}\\ +\helpref{EndsWith}{wxstringendswith} + + +\membersection{Case conversion}\label{caseconversioninwxstring} + +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}\label{searchingandreplacinginwxstring} + +These functions replace the standard {\it strchr()} and {\it strstr()} +functions. + +\helpref{Find}{wxstringfind}\\ +\helpref{Replace}{wxstringreplace} + +\membersection{Conversion to numbers}\label{conversiontonumbersinwxstring} + +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}\label{writingintostringinwxstring} + +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 -{\bf CAVE:} The description of the memberfunctions is very -sparse in the moment. It will be extended in the next -version of the help file. The list of memberfunctions -is complete. + 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}\label{memoryinwxstring} + +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}\label{miscellaneousinwxstring} + +Other string functions. + +\helpref{Trim}{wxstringtrim}\\ +\helpref{Pad}{wxstringpad}\\ +\helpref{Truncate}{wxstringtruncate} + +\membersection{wxWidgets 1.xx compatibility functions}\label{backwardcompatibilityinwxstring} + +These functions are deprecated, please consider using new wxWidgets 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} -\func{void}{wxString}{\param{void}{}}\\ -\func{void}{wxString}{\param{const wxString\&}{ x}}\\ -\func{void}{wxString}{\param{const wxSubString\&}{ x}}\\ -\func{void}{wxString}{\param{const char*}{ t}}\\ -\func{void}{wxString}{\param{const char*}{ t}, \param{int}{ len}}\\ -\func{void}{wxString}{\param{char}{ c}} +\func{}{wxString}{\void} + +Default constructor. Initializes the string to {\tt ""} (empty string). + +\func{}{wxString}{\param{const wxString\&}{ x}} + +Copy constructor. + +\func{}{wxString}{\param{char}{ ch}, \param{size\_t}{ n = 1}} + +Constructs a string of {\it n} copies of character {\it ch}. + +\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 {\tt 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 = wxSTRING\_MAXLEN}} + +For compilers using unsigned char: takes first {\it nLength} characters from the C string {\it psz}. +The default value of {\tt wxSTRING\_MAXLEN} means take all the string. + +{\bf Note:} In Unicode build, all of the above constructors take +{\tt wchar\_t} arguments instead of {\tt char}. + +\wxheading{Constructors with conversion} -Constructors. +The following constructors allow you to construct wxString from wide string +in ANSI build or from C string in Unicode build. + +\func{}{wxString}{\param{const wchar\_t*}{ psz}, \param{wxMBConv\&}{ conv}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}} + +Initializes the string from first \arg{nLength} characters of wide string. +The default value of {\tt wxSTRING\_MAXLEN} means take all the string. +In ANSI build, \arg{conv}'s +\helpref{WC2MB}{wxmbconvwc2mb} method is called to +convert \arg{psz} to wide string. It is ignored in Unicode build. + +\func{}{wxString}{\param{const char*}{ psz}, \param{wxMBConv\&}{ conv}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}} + +Initializes the string from first \arg{nLength} characters of C string. +The default value of {\tt wxSTRING\_MAXLEN} means take all the string. +In Unicode build, \arg{conv}'s +\helpref{MB2WC}{wxmbconvmb2wc} method is called to +convert \arg{psz} to wide string. It is ignored in ANSI build. + +\wxheading{See also} + +\helpref{wxMBConv classes}{mbconvclasses}, \helpref{mb\_str}{wxstringmbstr}, +\helpref{wc\_str}{wxstringwcstr} \membersection{wxString::\destruct{wxString}}\label{wxstringdestruct} -\func{void}{\destruct{wxString}}{\void} +\func{}{\destruct{wxString}}{\void} + +String destructor. Note that this is not virtual, so wxString must not be inherited from. + +\membersection{wxString::Alloc}\label{wxstringalloc} + +\func{void}{Alloc}{\param{size\_t}{ nLen}} -String destructor. +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); + + for ( size_t n = 0; n < len; n++ ) + { + if ( strchr("aeuio", tolower(original[n])) == NULL ) + result += original[n]; + } + + return result; +} + +\end{verbatim} -\membersection{wxString::Alloc}\label{wxstringAlloc} +because it will avoid the need to reallocate 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} -\func{void}{Alloc}{\param{int}{ newsize}} +\membersection{wxString::Append}\label{wxstringappend} -Preallocate some space for wxString. +\func{wxString\&}{Append}{\param{const char*}{ psz}} -\membersection{wxString::Allocation}\label{wxstringAllocation} +Concatenates {\it psz} to this string, returning a reference to it. -\func{int}{Allocation}{\param{void}{}} \param{ const}{} +\func{wxString\&}{Append}{\param{char}{ ch}, \param{int}{ count = 1}} -Report current allocation (not length!). +Concatenates character {\it ch} to this string, {\it count} times, returning a reference +to it. -\membersection{wxString::Append}\label{wxstringAppend} +\membersection{wxString::AfterFirst}\label{wxstringafterfirst} -\func{wxString\&}{Append}{\param{const char*}{ cs}}\\ -\func{wxString\&}{Append}{\param{const wxString\&}{ s}} +\constfunc{wxString}{AfterFirst}{\param{char}{ ch}} -Concatenation. +Gets all the characters after the first occurrence of {\it ch}. +Returns the empty string if {\it ch} is not found. -\func{wxString\&}{Append}{\param{char}{ c}, \param{int}{ rep = 1}} +\membersection{wxString::AfterLast}\label{wxstringafterlast} -Append {\it c}, {\it rep} times +\constfunc{wxString}{AfterLast}{\param{char}{ ch}} -\membersection{wxString::After}\label{wxstringAfter} +Gets all the characters after the last occurrence of {\it ch}. +Returns the whole string if {\it ch} is not found. -\func{wxSubString}{After}{\param{int}{ pos}}\\ -\func{wxSubString}{After}{\param{const wxString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{After}{\param{const wxSubString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{After}{\param{const char*}{ t}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{After}{\param{char}{ c}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{After}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}} +\membersection{wxString::BeforeFirst}\label{wxstringbeforefirst} -\membersection{wxString::At}\label{wxstringAt} +\constfunc{wxString}{BeforeFirst}{\param{char}{ ch}} -\func{wxSubString}{At}{\param{int}{ pos}, \param{int}{ len}}\\ -\func{wxSubString}{operator ()}{\param{int}{ pos}, \param{int}{ len}}\\ -\func{wxSubString}{At}{\param{const wxString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{At}{\param{const wxSubString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{At}{\param{const char*}{ t}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{At}{\param{char}{ c}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{At}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}} +Gets all characters before the first occurrence of {\it ch}. +Returns the whole string if {\it ch} is not found. -wxSubString extraction. +\membersection{wxString::BeforeLast}\label{wxstringbeforelast} -Note that you can't take a substring of a const wxString, since -this leaves open the possiblility of indirectly modifying the -wxString through the wxSubString. +\constfunc{wxString}{BeforeLast}{\param{char}{ ch}} -\membersection{wxString::Before}\label{wxstringBefore} +Gets all characters before the last occurrence of {\it ch}. +Returns the empty string if {\it ch} is not found. -\func{wxSubString}{Before}{\param{int}{ pos}}\\ -\func{wxSubString}{Before}{\param{const wxString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{Before}{\param{const wxSubString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{Before}{\param{const char*}{ t}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{Before}{\param{char}{ c}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{Before}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}} +\membersection{wxString::c\_str}\label{wxstringcstr} -\membersection{wxString::Capitalize}\label{wxstringCapitalize} +\constfunc{const wxChar *}{c\_str}{\void} -\func{void}{Capitalize}{\param{void}{}}\\ -\func{friend wxString}{Capitalize}{\param{wxString\&}{ x}} +Returns a pointer to the string data ({\tt const char*} in ANSI build, +{\tt const wchar\_t*} in Unicode build). -\membersection{wxString::Cat}\label{wxstringCat} +\wxheading{See also} -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxString\&}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxSubString\&}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const char*}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{char}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const wxSubString\&}{ a}, \param{const wxString\&}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const wxSubString\&}{ a}, \param{const wxSubString\&}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const wxSubString\&}{ a}, \param{const char*}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const wxSubString\&}{ a}, \param{char}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxString\&}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxSubString\&}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const char*}{ b}, \param{wxString\&}{ c}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{char}{ b}, \param{wxString\&}{ c}} +\helpref{mb\_str}{wxstringmbstr}, \helpref{wc\_str}{wxstringwcstr}, +\helpref{fn\_str}{wxstringfnstr} -Concatenate first two arguments, store the result in the last argument. +\membersection{wxString::Clear}\label{wxstringclear} -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxString\&}{ b}, \param{const wxString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxString\&}{ b}, \param{const wxSubString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxString\&}{ b}, \param{const char*}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxString\&}{ b}, \param{char}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxSubString\&}{ b}, \param{const wxString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxSubString\&}{ b}, \param{const wxSubString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxSubString\&}{ b}, \param{const char*}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const wxSubString\&}{ b}, \param{char}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const char*}{ b}, \param{const wxString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const char*}{ b}, \param{const wxSubString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const char*}{ b}, \param{const char*}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const wxString\&}{ a}, \param{const char*}{ b}, \param{char}{ c}, \param{wxString\&}{ d}} +\func{void}{Clear}{\void} -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxString\&}{ b}, \param{const wxString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxString\&}{ b}, \param{const wxSubString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxString\&}{ b}, \param{const char*}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxString\&}{ b}, \param{char}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxSubString\&}{ b}, \param{const wxString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxSubString\&}{ b}, \param{const wxSubString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxSubString\&}{ b}, \param{const char*}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const wxSubString\&}{ b}, \param{char}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const char*}{ b}, \param{const wxString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const char*}{ b}, \param{const wxSubString\&}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const char*}{ b}, \param{const char*}{ c}, \param{wxString\&}{ d}}\\ -\func{friend void}{Cat}{\param{const char*}{ a}, \param{const char*}{ b}, \param{char}{ c}, \param{wxString\&}{ d}} +Empties the string and frees memory occupied by it. -Double concatenation, by request. (Yes, there are too many versions, -but if one is supported, then the others should be too). -Concatenate the first 3 args, store the result in the last argument. +See also: \helpref{Empty}{wxstringempty} -\membersection{wxString::Chars}\label{wxstringChars} +\membersection{wxString::Cmp}\label{wxstringcmp} -\func{const char*}{Chars}{\param{void}{}} \param{ const}{} - -Conversion. - -\membersection{wxString::CompareTo}\label{wxstringCompareTo} +\constfunc{int}{Cmp}{\param{const wxString\&}{ s}} + +\constfunc{int}{Cmp}{\param{const char*}{ psz}} + +Case-sensitive comparison. + +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 \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas}. + +\membersection{wxString::CmpNoCase}\label{wxstringcmpnocase} + +\constfunc{int}{CmpNoCase}{\param{const wxString\&}{ s}} + +\constfunc{int}{CmpNoCase}{\param{const char*}{ psz}} + +Case-insensitive comparison. + +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 \helpref{Cmp}{wxstringcmp}, \helpref{IsSameAs}{wxstringissameas}. + +\membersection{wxString::CompareTo}\label{wxstringcompareto} \begin{verbatim} #define NO_POS ((int)(-1)) // undefined position -enum CaseCompare {exact, ignoreCase}; +enum caseCompare {exact, ignoreCase}; \end{verbatim} - -\func{int}{CompareTo}{\param{const char*}{ cs}, \param{CaseCompare}{ cmp = exact}} \param{ const}{}\\ -\func{int}{CompareTo}{\param{const wxString\&}{ cs}, \param{CaseCompare}{ cmp = exact}} \param{ const}{} -\membersection{wxString::Contains}\label{wxstringContains} +\constfunc{int}{CompareTo}{\param{const char*}{ psz}, \param{caseCompare}{ cmp = exact}} -\func{bool}{Contains}{\param{char}{ c}} \param{ const}{}\\ -\func{bool}{Contains}{\param{const wxString\&}{ y}} \param{ const}{}\\ -\func{bool}{Contains}{\param{const wxSubString\&}{ y}} \param{ const}{}\\ -\func{bool}{Contains}{\param{const char*}{ t}} \param{ const}{}\\ -\func{bool}{Contains}{\param{const wxRegex\&}{ r}} \param{ const}{} +Case-sensitive comparison. Returns 0 if equal, 1 if greater or -1 if less. -Return 1 if target appears anyhere in wxString; else 0. +\membersection{wxString::Contains}\label{wxstringcontains} -\func{bool}{Contains}{\param{const char*}{ pat}, \param{CaseCompare}{ cmp}} \param{ const}{}\\ -\func{bool}{Contains}{\param{const wxString\&}{ pat}, \param{CaseCompare}{ cmp}} \param{ const}{} +\constfunc{bool}{Contains}{\param{const wxString\&}{ str}} -Case dependent/independent variation . +Returns 1 if target appears anywhere in wxString; else 0. -\func{bool}{Contains}{\param{char}{ c}, \param{int}{ pos}} \param{ const}{}\\ -\func{bool}{Contains}{\param{const wxString\&}{ y}, \param{int}{ pos}} \param{ const}{}\\ -\func{bool}{Contains}{\param{const wxSubString\&}{ y}, \param{int}{ pos}} \param{ const}{}\\ -\func{bool}{Contains}{\param{const char*}{ t}, \param{int}{ pos}} \param{ const}{}\\ -\func{bool}{Contains}{\param{const wxRegex\&}{ r}, \param{int}{ pos}} \param{ const}{} +\membersection{wxString::Empty}\label{wxstringempty} -Return 1 if the target appears anywhere after position {\it pos} (or -before, if {\it pos} is negative) in wxString; else 0. +\func{void}{Empty}{\void} -\membersection{wxString::Copy}\label{wxstringCopy} +Makes the string empty, but doesn't free memory occupied by the string. -\func{wxString}{Copy}{\param{void}{}} \param{ const}{} +See also: \helpref{Clear()}{wxstringclear}. -Duplication. +\membersection{wxString::Find}\label{wxstringfind} -\membersection{wxString::Del}\label{wxstringDel} +\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = false}} -\func{wxString\&}{Del}{\param{int}{ pos}, \param{int}{ len}} +Searches for the given character. Returns the starting index, or -1 if not found. -Delete {\it len} characters starting at {\it pos}. +\constfunc{int}{Find}{\param{const char*}{ sz}} -\func{wxString\&}{Del}{\param{const wxString\&}{ y}, \param{int}{ startpos = 0}}\\ -\func{wxString\&}{Del}{\param{const wxSubString\&}{ y}, \param{int}{ startpos = 0}}\\ -\func{wxString\&}{Del}{\param{const char*}{ t}, \param{int}{ startpos = 0}}\\ -\func{wxString\&}{Del}{\param{char}{ c}, \param{int}{ startpos = 0}}\\ -\func{wxString\&}{Del}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}} +Searches for the given string. Returns the starting index, or -1 if not found. -Delete the first occurrence of target after {\it startpos}. +\membersection{wxString::First}\label{wxstringfirst} -\membersection{wxString::DownCase}\label{wxstringDownCase} +\func{int}{First}{\param{char}{ c}} -\func{void}{Downcase}{\param{void}{}}\\ -\func{friend wxString}{Downcase}{\param{wxString\&}{ x}} +\constfunc{int}{First}{\param{const char*}{ psz}} -\membersection{wxString::Elem}\label{wxstringElem} +\constfunc{int}{First}{\param{const wxString\&}{ str}} -\func{char}{Elem}{\param{int}{ i}} \param{ const}{} +Same as \helpref{Find}{wxstringfind}. -Element extraction. +\membersection{wxString::fn\_str}\label{wxstringfnstr} -\membersection{wxString::Empty}\label{wxstringEmpty} +\constfunc{const wchar\_t*}{fn\_str}{\void} -\func{int}{Empty}{\param{void}{}} \param{ const}{} +\constfunc{const char*}{fn\_str}{\void} -\membersection{wxString::Error}\label{wxstringError} +\constfunc{const wxCharBuffer}{fn\_str}{\void} -\func{void}{Error}{\param{const char*}{ msg}} \param{ const}{} +Returns string representation suitable for passing to OS' functions for +file handling. In ANSI build, this is same as \helpref{c\_str}{wxstringcstr}. +In Unicode build, returned value can be either wide character string +or C string in charset matching the {\tt wxConvFileName} object, depending on +the OS. -\membersection{wxString::First}\label{wxstringFirst} +\wxheading{See also} -\func{int}{First}{\param{char}{ c}} \param{ const}{}\\ -\func{int}{First}{\param{const char*}{ cs}} \param{ const}{}\\ -\func{int}{First}{\param{const wxString\&}{ cs}} \param{ const}{} +\helpref{wxMBConv}{wxmbconv}, +\helpref{wc\_str}{wxstringwcstr}, \helpref{mb\_str}{wxstringwcstr} -Return first or last occurrence of item. - -\membersection{wxString::Firstchar}\label{wxstringFirstchar} -\func{char}{Firstchar}{\param{void}{}} \param{ const}{} +\membersection{wxString::Format}\label{wxstringformat} -Element extraction. +\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{}{...}} -\membersection{wxString::Freq}\label{wxstringFreq} +This static function returns the string containing the result of calling +\helpref{Printf}{wxstringprintf} with the passed parameters on it. -\func{int}{Freq}{\param{char}{ c}} \param{ const}{}\\ -\func{int}{Freq}{\param{const wxString\&}{ y}} \param{ const}{}\\ -\func{int}{Freq}{\param{const wxSubString\&}{ y}} \param{ const}{}\\ -\func{int}{Freq}{\param{const char*}{ t}} \param{ const}{} +\wxheading{See also} -Return number of occurrences of target in wxString. +\helpref{FormatV}{wxstringformatv}, \helpref{Printf}{wxstringprintf} -\membersection{wxString::From}\label{wxstringFrom} +\membersection{wxString::FormatV}\label{wxstringformatv} -\func{wxSubString}{From}{\param{int}{ pos}}\\ -\func{wxSubString}{From}{\param{const wxString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{From}{\param{const wxSubString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{From}{\param{const char*}{ t}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{From}{\param{char}{ c}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{From}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}} +\func{static wxString}{FormatV}{\param{const wxChar }{*format}, \param{va\_list }{argptr}} -\membersection{wxString::GetData}\label{wxstringGetData} +This static function returns the string containing the result of calling +\helpref{PrintfV}{wxstringprintfv} with the passed parameters on it. -\func{char*}{GetData}{\param{void}{}} +\wxheading{See also} -wxWindows compatibility conversion. +\helpref{Format}{wxstringformat}, \helpref{PrintfV}{wxstringprintfv} -\membersection{wxString::GSub}\label{wxstringGSub} -\func{int}{GSub}{\param{const wxString\&}{ pat}, \param{const wxString\&}{ repl}}\\ -\func{int}{GSub}{\param{const wxSubString\&}{ pat}, \param{const wxString\&}{ repl}}\\ -\func{int}{GSub}{\param{const char*}{ pat}, \param{const wxString\&}{ repl}}\\ -\func{int}{GSub}{\param{const char*}{ pat}, \param{const char*}{ repl}}\\ -\func{int}{GSub}{\param{const wxRegex\&}{ pat}, \param{const wxString\&}{ repl}} +\membersection{wxString::Freq}\label{wxstringfreq} -Global substitution: substitute all occurrences of {\it pat} with {\it repl}, -returning the number of matches. +\constfunc{int}{Freq}{\param{char }{ch}} -\membersection{wxString::Index}\label{wxstringIndex} +Returns the number of occurrences of {\it ch} in the string. -\func{int}{Index}{\param{char}{ c}, \param{int}{ startpos = 0}} \param{ const}{}\\ -\func{int}{Index}{\param{const wxString\&}{ y}, \param{int}{ startpos = 0}} \param{ const}{}\\ -\func{int}{Index}{\param{const wxString\&}{ y}, \param{int}{ startpos}, \param{CaseCompare}{ cmp}} \param{ const}{}\\ -\func{int}{Index}{\param{const wxSubString\&}{ y}, \param{int}{ startpos = 0}} \param{ const}{}\\ -\func{int}{Index}{\param{const char*}{ t}, \param{int}{ startpos = 0}} \param{ const}{}\\ -\func{int}{Index}{\param{const char*}{ t}, \param{int}{ startpos}, \param{CaseCompare}{ cmp}} \param{ const}{}\\ -\func{int}{Index}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}} \param{ const}{} +\membersection{wxString::FromAscii}\label{wxstringfromascii} -Return the position of target in string, or -1 for failure. +\func{static wxString }{FromAscii}{\param{const char*}{ s}} -\membersection{wxString::Insert}\label{wxstringInsert} +\func{static wxString }{FromAscii}{\param{const char}{ c}} -\func{wxString\&}{Insert}{\param{int}{ pos}, \param{const char*}{ s}}\\ -\func{wxString\&}{Insert}{\param{int}{ pos}, \param{const wxString\&}{ s}} +Converts the string or character from an ASCII, 7-bit form +to the native wxString representation. Most useful when using +a Unicode build of wxWidgets. +Use \helpref{wxString constructors}{wxstringconstruct} if you +need to convert from another charset. -Insertion. - -\membersection{wxString::IsAscii}\label{wxstringIsAscii} +\membersection{wxString::GetChar}\label{wxstringgetchar} -\func{int}{IsAscii}{\param{void}{}} \param{ const}{} +\constfunc{char}{GetChar}{\param{size\_t}{ n}} -Classification (should be capital, because of ctype.h macros). +Returns the character at position {\it n} (read-only). -\membersection{wxString::IsDefined}\label{wxstringIsDefined} +\membersection{wxString::GetData}\label{wxstringgetdata} -\func{int}{IsDefined}{\param{void}{}} \param{ const}{} +\constfunc{const wxChar*}{GetData}{\void} -Classification (should be capital, because of ctype.h macros). +wxWidgets compatibility conversion. Returns a constant pointer to the data in the string. -\membersection{wxString::IsNull}\label{wxstringIsNull} +\membersection{wxString::GetWritableChar}\label{wxstringgetwritablechar} -\func{int}{IsNull}{\param{void}{}} \param{ const}{} +\func{char\&}{GetWritableChar}{\param{size\_t}{ n}} -Classification (should be capital, because of ctype.h macros). +Returns a reference to the character at position {\it n}. -\membersection{wxString::IsNumber}\label{wxstringIsNumber} +\membersection{wxString::GetWriteBuf}\label{wxstringgetwritebuf} -\func{int}{IsNumber}{\param{void}{}} \param{ const}{} +\func{wxChar*}{GetWriteBuf}{\param{size\_t}{ len}} -Classification (should be capital, because of ctype.h macros). +Returns a writable buffer of at least {\it len} bytes. +It returns a pointer to a new memory block, and the +existing data will not be copied. -\membersection{wxString::IsWord}\label{wxstringIsWord} +Call \helpref{wxString::UngetWriteBuf}{wxstringungetwritebuf} as soon as possible +to put the string back into a reasonable state. -\func{int}{IsWord}{\param{void}{}} \param{ const}{} +\membersection{wxString::Index}\label{wxstringindex} -Classification (should be capital, because of ctype.h macros). +\constfunc{size\_t}{Index}{\param{char}{ ch}} -\membersection{wxString::Last}\label{wxstringLast} +\constfunc{size\_t}{Index}{\param{const char*}{ sz}} -\func{int}{Last}{\param{char}{ c}} \param{ const}{}\\ -\func{int}{Last}{\param{const char*}{ cs}} \param{ const}{}\\ -\func{int}{Last}{\param{const wxString\&}{ cs}} \param{ const}{} +Same as \helpref{wxString::Find}{wxstringfind}. -First or last occurrence of item. +% 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} -\membersection{wxString::Lastchar}\label{wxstringLastchar} +\constfunc{bool}{IsAscii}{\void} -\func{char}{Lastchar}{\param{void}{}} \param{ const}{} +Returns true if the string contains only ASCII characters. -Element extraction. +\membersection{wxString::IsEmpty}\label{wxstringisempty} + +\constfunc{bool}{IsEmpty}{\void} + +Returns true if the string is empty. + +\membersection{wxString::IsNull}\label{wxstringisnull} -\membersection{wxString::Length}\label{wxstringLength} +\constfunc{bool}{IsNull}{\void} -\func{unsigned int}{Length}{\param{void}{}} \param{ const}{} +Returns true if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}). -\membersection{wxString::LowerCase}\label{wxstringLowerCase} +\membersection{wxString::IsNumber}\label{wxstringisnumber} -\func{void}{LowerCase}{\param{void}{}} +\constfunc{bool}{IsNumber}{\void} -\membersection{wxString::Matches}\label{wxstringMatches} +Returns true if the string is an integer (with possible sign). -\func{bool}{Matches}{\param{char}{ c}, \param{int}{ pos = 0}} \param{ const}{}\\ -\func{bool}{Matches}{\param{const wxString\&}{ y}, \param{int}{ pos = 0}} \param{ const}{}\\ -\func{bool}{Matches}{\param{const wxSubString\&}{ y}, \param{int}{ pos = 0}} \param{ const}{}\\ -\func{bool}{Matches}{\param{const char*}{ t}, \param{int}{ pos = 0}} \param{ const}{}\\ -\func{bool}{Matches}{\param{const wxRegex\&}{ r}, \param{int}{ pos = 0}} \param{ const}{} +\membersection{wxString::IsSameAs}\label{wxstringissameas} -Return 1 if target appears at position {\it pos} in wxString; else 0. +\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = true}} -\membersection{wxString::OK}\label{wxstringOK} +Test for string equality, case-sensitive (default) or not. -\func{int}{OK}{\param{void}{}} \param{ const}{} +caseSensitive is true by default (case matters). -\membersection{wxString::Prepend}\label{wxstringPrepend} +Returns true if strings are equal, false otherwise. -\func{wxString\&}{Prepend}{\param{const wxString\&}{ y}}\\ -\func{wxString\&}{Prepend}{\param{const wxSubString\&}{ y}}\\ -\func{wxString\&}{Prepend}{\param{const char*}{ t}}\\ -\func{wxString\&}{Prepend}{\param{char}{ c}} +See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase} -Prepend. +\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = true}} -\func{wxString\&}{Prepend}{\param{char}{ c}, \param{int}{ rep=1}} +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. -Prepend {\it c}, {\it rep} times. - -\membersection{wxString::Readline}\label{wxstringReadline} +Returns true if the string is equal to the character, false otherwise. -\func{friend int}{Readline}{\param{istream\&}{ s}, \param{wxString\&}{ x}, - \param{char}{ terminator = '$\backslash$n'}, - \param{int}{ discard\_terminator = 1}}\\ -\func{friend int}{Readline}{\param{FILE *}{ f}, \param{wxString\&}{ x}, - \param{char}{ terminator = '$\backslash$n'}, - \param{int}{ discard\_terminator = 1}} +See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase} -\membersection{wxString::Remove}\label{wxstringRemove} +\membersection{wxString::IsWord}\label{wxstringisword} -\func{wxString\&}{RemoveLast}{\param{void}{}}\\ -\func{wxString\&}{Remove}{\param{int}{ pos}}\\ -\func{wxString\&}{Remove}{\param{int}{ pos}, \param{int}{ len}} +\constfunc{bool}{IsWord}{\void} -Remove {\it pos} to end of string. +Returns true if the string is a word. TODO: what's the definition of a word? -\membersection{wxString::Replace}\label{wxstringReplace} +\membersection{wxString::Last}\label{wxstringlast} -\func{wxString\&}{Replace}{\param{int}{ pos}, \param{int}{ n}, \param{const char*}{ s}}\\ -\func{wxString\&}{Replace}{\param{int}{ pos}, \param{int}{ n}, \param{const wxString\&}{ s}} +\constfunc{char}{Last}{\void} -\membersection{wxString::Replicate}\label{wxstringReplicate} +Returns the last character. -\func{friend wxString}{Replicate}{\param{char}{ c}, \param{int}{ n}}\\ -\func{friend wxString}{Replicate}{\param{const wxString\&}{ y}, \param{int}{ n}} +\func{char\&}{Last}{\void} -Replication. +Returns a reference to the last character (writable). -\membersection{wxString::Reverse}\label{wxstringReverse} +\membersection{wxString::Left}\label{wxstringleft} -\func{void}{Reverse}{\param{void}{}}\\ -\func{friend wxString}{Reverse}{\param{wxString\&}{ x}} +\constfunc{wxString}{Left}{\param{size\_t}{ count}} + +Returns the first {\it count} characters of the string. + +\membersection{wxString::Len}\label{wxstringlen} + +\constfunc{size\_t}{Len}{\void} + +Returns the length of the string. + +\membersection{wxString::Length}\label{wxstringlength} + +\constfunc{size\_t}{Length}{\void} + +Returns the length of the string (same as Len). + +\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} + +Same as MakeLower. + +\membersection{wxString::MakeLower}\label{wxstringmakelower} + +\func{wxString\&}{MakeLower}{\void} + +Converts all characters to lower case and returns the result. + +\membersection{wxString::MakeUpper}\label{wxstringmakeupper} + +\func{wxString\&}{MakeUpper}{\void} + +Converts all characters to upper case and returns the result. + +\membersection{wxString::Matches}\label{wxstringmatches} + +\constfunc{bool}{Matches}{\param{const char*}{ szMask}} + +Returns true if the string contents matches a mask containing '*' and '?'. + +\membersection{wxString::mb\_str}\label{wxstringmbstr} + +\constfunc{const char*}{mb\_str}{\param{wxMBConv\&}{ conv}} + +\constfunc{const wxCharBuffer}{mb\_str}{\param{wxMBConv\&}{ conv}} + +Returns multibyte (C string) representation of the string. +In Unicode build, converts using \arg{conv}'s \helpref{cWC2MB}{wxmbconvcwc2mb} +method and returns wxCharBuffer. In ANSI build, this function is same +as \helpref{c\_str}{wxstringcstr}. +The macro wxWX2MBbuf is defined as the correct return type (without const). + +\wxheading{See also} + +\helpref{wxMBConv}{wxmbconv}, +\helpref{c\_str}{wxstringcstr}, \helpref{wc\_str}{wxstringwcstr}, +\helpref{fn\_str}{wxstringfnstr} + +\membersection{wxString::Mid}\label{wxstringmid} + +\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. + +\membersection{wxString::Pad}\label{wxstringpad} + +\func{wxString\&}{Pad}{\param{size\_t}{ count}, \param{char}{ pad = ' '}, \param{bool}{ fromRight = true}} + +Adds {\it count} copies of {\it pad} to the beginning, or to the end of the string (the default). + +Removes spaces from the left or from the right (default). + +\membersection{wxString::Prepend}\label{wxstringprepend} + +\func{wxString\&}{Prepend}{\param{const wxString\&}{ str}} + +Prepends {\it str} to this string, returning a reference to this string. + +\membersection{wxString::Printf}\label{wxstringprintf} + +\func{int}{Printf}{\param{const char* }{pszFormat}, \param{}{...}} + +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} + +\func{int}{PrintfV}{\param{const char* }{pszFormat}, \param{va\_list}{ argPtr}} + +Similar to vprintf. Returns the number of characters written, or an integer less than zero +on error. + +\membersection{wxString::Remove}\label{wxstringremove} + +\func{wxString\&}{Remove}{\param{size\_t}{ pos}} + +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}} + +Removes {\it len} characters from the string, starting at {\it pos}. + +\membersection{wxString::RemoveLast}\label{wxstringremovelast} + +\func{wxString\&}{RemoveLast}{\void} + +Removes the last character. + +\membersection{wxString::Replace}\label{wxstringreplace} + +\func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = true}} + +Replace first (or all) occurrences of substring with another one. + +{\it replaceAll}: global replace (default), or only the first occurrence. + +Returns the number of replacements made. + +\membersection{wxString::Right}\label{wxstringright} + +\constfunc{wxString}{Right}{\param{size\_t}{ count}} + +Returns the last {\it count} characters. + +\membersection{wxString::SetChar}\label{wxstringsetchar} + +\func{void}{SetChar}{\param{size\_t}{ n}, \param{char}{ch}} + +Sets the character at position {\it n}. + +\membersection{wxString::Shrink}\label{wxstringshrink} + +\func{void}{Shrink}{\void} + +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} -\func{void}{sprintf}{\param{const wxString\& }{ fmt}} -Formatted assignment. We do not use the 'sprintf' constructor anymore, -because with that constructor, every initialisation with a string would -go through sprintf and this is not desirable, because sprintf -interprets some characters. With the above function we can write: +\func{void}{sprintf}{\param{const char* }{ fmt}} -\begin{verbatim} -wxString msg; msg.sprintf("Processing item %d\n", count); -\end{verbatim} +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::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} -enumStripType {leading = 0x1, trailing = 0x2, both = 0x3}; +enum stripType {leading = 0x1, trailing = 0x2, both = 0x3}; \end{verbatim} -\func{wxSubString}{Strip}{\param{StripType}{ s = trailing}, \param{char}{ c = ' '}} +\constfunc{wxString}{Strip}{\param{stripType}{ s = trailing}} + +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::ToAscii}\label{wxstringtoascii} + +\constfunc{const char*}{ToAscii}{\void} + +Converts the string to an ASCII, 7-bit string (ANSI builds only). + +\constfunc{const wxCharBuffer}{ToAscii}{\void} + +Converts the string to an ASCII, 7-bit string in the form of +a wxCharBuffer (Unicode builds only). + +Note that this conversion only works if the string contains only ASCII +characters. The \helpref{mb\_str}{wxstringmbstr} method provides more +powerful means of converting wxString to C string. + +\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 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. 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. + +\wxheading{See also} + +\helpref{wxString::ToDouble}{wxstringtodouble},\\ +\helpref{wxString::ToLong}{wxstringtolong} + +\membersection{wxString::Trim}\label{wxstringtrim} -Strip characterss at the front and/or end. -StripType is defined for bitwise ORing. +\func{wxString\&}{Trim}{\param{bool}{ fromRight = true}} -\membersection{wxString::SubString}\label{wxstringSubString} +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). -\func{wxString}{SubString}{\param{int}{ from}, \param{int}{ to}} +\membersection{wxString::Truncate}\label{wxstringtruncate} -Edward Zimmermann's additions. +\func{wxString\&}{Truncate}{\param{size\_t}{ len}} -\membersection{wxString::Through}\label{wxstringThrough} +Truncate the string to the given length. -\func{wxSubString}{Through}{\param{int}{ pos}}\\ -\func{wxSubString}{Through}{\param{const wxString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{Through}{\param{const wxSubString\&}{ x}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{Through}{\param{const char*}{ t}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{Through}{\param{char}{ c}, \param{int}{ startpos = 0}}\\ -\func{wxSubString}{Through}{\param{const wxRegex\&}{ r}, \param{int}{ startpos = 0}} +\membersection{wxString::UngetWriteBuf}\label{wxstringungetwritebuf} -\membersection{wxString::Upcase}\label{wxstringUpcase} +\func{void}{UngetWriteBuf}{\void} -\func{void}{Upcase}{\param{void}{}}\\ -\func{friend wxString}{Upcase}{\param{wxString\&}{ x}} +\func{void}{UngetWriteBuf}{\param{size\_t }{len}} -\membersection{wxString::UpperCase}\label{wxstringUpperCase} +Puts the string back into a reasonable state (in which it can be used +normally), after +\rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called. -\func{void}{UpperCase}{\param{void}{}}\\ +The version of the function without the {\it len} parameter will calculate the +new string length itself assuming that the string is terminated by the first +{\tt NUL} character in it while the second one will use the specified length +and thus is the only version which should be used with the strings with +embedded {\tt NUL}s (it is also slightly more efficient as {\tt strlen()} +doesn't have to be called). + +\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::wc\_str}\label{wxstringwcstr} + +\constfunc{const wchar\_t*}{wc\_str}{\param{wxMBConv\&}{ conv}} + +\constfunc{const wxWCharBuffer}{wc\_str}{\param{wxMBConv\&}{ conv}} + +Returns wide character representation of the string. +In ANSI build, converts using \arg{conv}'s \helpref{cMB2WC}{wxmbconvcmb2wc} +method and returns wxWCharBuffer. In Unicode build, this function is same +as \helpref{c\_str}{wxstringcstr}. +The macro wxWX2WCbuf is defined as the correct return type (without const). + +\wxheading{See also} + +\helpref{wxMBConv}{wxmbconv}, +\helpref{c\_str}{wxstringcstr}, \helpref{mb\_str}{wxstringwcstr}, +\helpref{fn\_str}{wxstringfnstr} + +\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 emptiness +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\&}{ y}}\\ -\func{wxString\&}{operator $=$}{\param{const char*}{ y}}\\ -\func{wxString\&}{operator $=$}{\param{char}{ c}}\\ -\func{wxString\&}{operator $=$}{\param{const wxSubString\&}{ y}} +\func{wxString\&}{operator $=$}{\param{const wxString\&}{ str}} + +\func{wxString\&}{operator $=$}{\param{const char*}{ psz}} -Assignment. - -\membersection{wxString::operator $+=$}\label{wxstringPlusEqual} +\func{wxString\&}{operator $=$}{\param{char}{ c}} -\func{wxString\&}{operator $+=$}{\param{const wxString\&}{ y}}\\ -\func{wxString\&}{operator $+=$}{\param{const wxSubString\&}{ y}}\\ -\func{wxString\&}{operator $+=$}{\param{const char*}{ t}}\\ -\func{wxString\&}{operator $+=$}{\param{char}{ c}} +\func{wxString\&}{operator $=$}{\param{const unsigned char*}{ psz}} -Concatenation. +\func{wxString\&}{operator $=$}{\param{const wchar\_t*}{ pwz}} + +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 string equal to the +concatenation 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{const char*}{ psz}} + +\func{void}{operator $+=$}{\param{char}{ c}} + +Concatenation in place: the argument is appended to the string. \membersection{wxString::operator []}\label{wxstringoperatorbracket} -\func{char\&}{operator []}{\param{int}{ i}} +\func{wxChar\&}{operator []}{\param{size\_t}{ i}} + +\constfunc{wxChar}{operator []}{\param{size\_t}{ i}} + +\func{wxChar\&}{operator []}{\param{int}{ i}} + +\constfunc{wxChar}{operator []}{\param{int}{ i}} Element extraction. \membersection{wxString::operator ()}\label{wxstringoperatorparenth} -\func{char\&}{operator ()}{\param{int}{ i}} +\func{wxString}{operator ()}{\param{size\_t}{ start}, \param{size\_t}{ len}} + +Same as Mid (substring extraction). \membersection{wxString::operator \cinsert}\label{wxstringoperatorout} -\func{friend ostream\&}{operator \cinsert}{\param{ostream\&}{ s}, \param{const wxString\&}{ x}}\\ -\func{friend ostream\&}{operator \cinsert}{\param{ostream\&}{ s}, \param{const wxSubString\&}{ x}} + +\func{wxString\&}{operator \cinsert}{\param{const wxString\&}{ str}} + +\func{wxString\&}{operator \cinsert}{\param{const char*}{ psz}} + +\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\&}{ s}, \param{wxString\&}{ x}} + +\func{friend istream\&}{operator \cextract}{\param{istream\&}{ is}, \param{wxString\&}{ str}} + +Extraction from a stream. \membersection{wxString::operator const char*}\label{wxstringoperatorconstcharpt} -\constfunc{}{operator const char*}{\param{void}{}} -Conversion. +\constfunc{}{operator const char*}{\void} + +Implicit conversion to a C string. + +\membersection{Comparison operators}\label{wxstringcomparison} + +\func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} + +\func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} + +\func{bool}{operator $!=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} + +\func{bool}{operator $!=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} + +\func{bool}{operator $>$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} + +\func{bool}{operator $>$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} + +\func{bool}{operator $>=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} -\membersection{wxCHARARG}\label{wxstringwxCHARARG} +\func{bool}{operator $>=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} + +\func{bool}{operator $<$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} + +\func{bool}{operator $<$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} + +\func{bool}{operator $<=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} + +\func{bool}{operator $<=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} + +\wxheading{Remarks} + +These comparisons are case-sensitive. + + +\section{\class{wxStringBuffer}}\label{wxstringbuffer} + +This tiny class allows to conveniently access the \helpref{wxString}{wxstring} +internal buffer as a writable pointer without any risk of forgetting to restore +the string to the usable state later. + +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: \begin{verbatim} -#define wxCHARARG(s) ((const wxString\& )(s).Chars()) + wxString theAnswer; + GetMeaningOfLifeAsString(wxStringBuffer(theAnswer, 1024)); + if ( theAnswer != "42" ) + { + wxLogError("Something is very wrong!"); + } \end{verbatim} -Here is a very, very, very ugly macro, but it makes things more -transparent in cases, where a library function requires a -(const wxString\& ) argument. This is especially the case in wxWindows, -where all char-arguments are (const wxString\& ) and not (const char* ). -This macro should only be used in such cases and NOT to -modify the internal data. -The conventional way would be 'function((char*)string.Chars())'. -With the wxCHARARG macro, this can be achieved by 'function(wxCHARARG(string))'. -This makes it clearer that the usage should be confined -to arguments. - -\membersection{CommonPrefix}\label{wxstringCommonPrefix} - -\func{friend wxString}{CommonPrefix}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y},\\ - \param{int}{ startpos = 0}}\\ - -\membersection{CommonSuffix}\label{wxstringCommonSuffix} - -\func{friend wxString}{CommonSuffix}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y},\\ - \param{int}{ startpos = -1}} - -\membersection{Compare}\label{wxstringCompare} - -\func{int}{Compare}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{Compare}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{Compare}{\param{const wxString\&}{ x}, \param{const char*}{ y}}\\ -\func{int}{Compare}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{Compare}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{Compare}{\param{const wxSubString\&}{ x}, \param{const char*}{ y}} - -Case dependent comparison. Returns 0 if the match succeeded. - -\membersection{FCompare}\label{wxstringFCompare} - -\func{int}{FCompare}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} - -Case independent comparison. Returns 0 if the match succeeded. - -\membersection{Comparison operators}\label{wxstringComparison} - -\func{int}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $!=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $>$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $>=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $<$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $<=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $!=$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $>$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $>=$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $<$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $<=$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $==$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $!=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $>$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $>=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $<$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $<=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $==$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $!=$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $>$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $>=$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $<$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $<=$}{\param{const wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{int}{operator $==$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $!=$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $>$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $>=$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $<$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $<=$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{int}{operator $==$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $!=$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $>$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $>=$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $<$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}}\\ -\func{int}{operator $<=$}{\param{const wxSubString\&}{ x}, \param{const char*}{ t}} - -\membersection{operator $+$}\label{wxstringoperatorplus} - -\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxSubString\&}{ 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 wxSubString\&}{ x}, \param{const wxString\&}{ y}}\\ -\func{wxString}{operator $+$}{\param{const wxSubString\&}{ x}, \param{const wxSubString\&}{ y}}\\ -\func{wxString}{operator $+$}{\param{const wxSubString\&}{ x}, \param{const char*}{ y}}\\ -\func{wxString}{operator $+$}{\param{const wxSubString\&}{ x}, \param{char}{ y}}\\ -\func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxString\&}{ y}}\\ -\func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxSubString\&}{ y}} - -\membersection{Join}\label{wxstringJoin} - -\func{friend wxString}{Join}{\param{wxString}{ src[]}, \param{int}{ n}, \param{const wxString\&}{ sep}} - -\membersection{Split}\label{wxstringSplit} - -\func{friend int}{Split}{\param{const wxString\&}{ x}, \param{wxString}{ res[]}, \param{int}{ maxn},\\ - \param{const wxString\&}{ sep}}\\ -\func{friend int}{Split}{\param{const wxString\&}{ x}, \param{wxString}{ res[]}, \param{int}{ maxn},\\ - \param{const wxRegex\&}{ sep}}\\ - -Split string into array res at separators; return number of elements +Note that the exact usage of this depends on whether on not wxUSE\_STL is enabled. If +wxUSE\_STL is enabled, wxStringBuffer creates a separate empty character buffer, and +if wxUSE\_STL is disabled, it uses GetWriteBuf() from wxString, keeping the same buffer +wxString uses intact. In other words, relying on wxStringBuffer containing the old +wxString data is probably not a good idea if you want to build your program in both +with and without wxUSE\_STL. + +\wxheading{Derived from} + +None + +\wxheading{Include files} + + + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxStringBuffer::wxStringBuffer}\label{wxstringbufferctor} + +\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}}\label{wxstringbufferdtor} + +\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 *}\label{wxstringbufferwxchar} + +\func{wxChar *}{operator wxChar *}{\void} + +Returns the writable pointer to a buffer of the size at least equal to the +length specified in the constructor. + + + +\section{\class{wxStringBufferLength}}\label{wxstringbufferlength} + +This tiny class allows to conveniently access the \helpref{wxString}{wxstring} +internal buffer as a writable pointer without any risk of forgetting to restore +the string to the usable state later, and allows the user to set the internal +length of the string. + +For example, assuming you have a low-level OS function called +{\tt int GetMeaningOfLifeAsString(char *)} copying the value in the provided +buffer (which must be writable, of course), and returning the actual length +of the string, you might call it like this: + +\begin{verbatim} + wxString theAnswer; + wxStringBuffer theAnswerBuffer(theAnswer, 1024); + int nLength = GetMeaningOfLifeAsString(theAnswerBuffer); + theAnswerBuffer.SetLength(nLength); + if ( theAnswer != "42" ) + { + wxLogError("Something is very wrong!"); + } +\end{verbatim} + +Note that the exact usage of this depends on whether on not wxUSE\_STL is enabled. If +wxUSE\_STL is enabled, wxStringBuffer creates a separate empty character buffer, and +if wxUSE\_STL is disabled, it uses GetWriteBuf() from wxString, keeping the same buffer +wxString uses intact. In other words, relying on wxStringBuffer containing the old +wxString data is probably not a good idea if you want to build your program in both +with and without wxUSE\_STL. + +Note that SetLength {\tt must} be called before wxStringBufferLength destructs. + +\wxheading{Derived from} + +None + +\wxheading{Include files} + + + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxStringBufferLength::wxStringBufferLength}\label{wxstringbufferlengthctor} + +\func{}{wxStringBufferLength}{\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{wxStringBufferLength::\destruct{wxStringBufferLength}}\label{wxstringbufferlengthdtor} + +\func{}{\destruct{wxStringBufferLength}}{\void} + +Restores the string passed to the constructor to the usable state by calling +\helpref{UngetWriteBuf}{wxstringungetwritebuf} on it. + +\membersection{wxStringBufferLength::SetLength}\label{wxstringbufferlengthsetlength} + +\func{void}{SetLength}{\param{size\_t }{nLength}} + +Sets the internal length of the string referred to by wxStringBufferLength to +{\it nLength} characters. + +Must be called before wxStringBufferLength destructs. + +\membersection{wxStringBufferLength::operator wxChar *}\label{wxstringbufferlengthwxchar} + +\func{wxChar *}{operator wxChar *}{\void} +Returns the writable pointer to a buffer of the size at least equal to the +length specified in the constructor.