X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5de76427c87d8289f5c343cef16e9375056fc49f..135ebb43cba169906a1bc14f7840b26c75ed4240:/docs/latex/wx/wxstring.tex diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 5d1d728a2e..5aa5d9d4a5 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -1,14 +1,357 @@ \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} + + + +\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 strign 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 provocate 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 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{Cmp}{wxstringcmp}\\ +\helpref{CmpNoCase}{wxstringcmpnocase}\\ +\helpref{IsSameAs}{wxstringissameas}\\ +\helpref{Matches}{wxstringmatches} + +\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} + +\membersection{Case conversion} + +The MakeXXX() variants modify the string in place, while the other functions +return a new string which containts 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{Writing values into the string} + +Both formatted versions (\helpref{Printf}{wxstringprintf}) and stream-like +insertion operators exist (for basic types only). + +\helpref{Printf}{wxstringprintf}\\ +\helpref{PrintfV}{wxstringprintfv}\\ +\helpref{operator \cinsert}{wxstringoperatorout} + +\membersection{Memory management} + +These are "advanced" functions and they will be needed quite rarily. +\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 compatiblity functions} + +These functiosn 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 occurence 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 occurence 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 occurence 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} @@ -24,15 +367,15 @@ Copy constructor. 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 take all the string. -\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}} @@ -44,13 +387,44 @@ Constructs a string from the wide (UNICODE) string. 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{uint}{ newsize}} +\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} -Preallocate some space for wxString. Only works if the data of this string is not shared. +// delete all vowels from the string +wxString DeleteAllVowels(const wxString& original) +{ + wxString result; -\membersection{wxString::Append}\label{wxstringAppend} + 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} + +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}} @@ -61,19 +435,47 @@ Concatenates {\it psz} to this string, returning a reference to it. 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}. 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 occurence of {\it ch}. +Returns the whole string if {\it ch} is not found. + +\membersection{wxString::BeforeFirst}\label{wxstringbeforefirst} + +\constfunc{wxString}{BeforeFirst}{\param{char}{ ch}} + +Gets all characters before the first occurence of {\it ch}. +Returns the whole string if {\it ch} is not found. + +\membersection{wxString::BeforeLast}\label{wxstringbeforelast} -\constfunc{wxString}{Before}{\param{char}{ ch}} +\constfunc{wxString}{BeforeLast}{\param{char}{ ch}} Gets all characters before the last occurence of {\it ch}. -Returns empty string if {\it ch} is not found. +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} @@ -81,9 +483,11 @@ Returns empty string if {\it ch} is not found. 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 si equal to it or negative value if it is less than 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} @@ -91,24 +495,26 @@ See also CmpNoCase, IsSameAs. 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 si equal to it or negative value if it is less than 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. @@ -116,7 +522,9 @@ Returns 1 if target appears anyhere in wxString; else 0. \func{void}{Empty}{\void} -Reinitializes the string and frees the data. +Makes the string empty, but doesn't free memory occupied by the string. + +See also: \helpref{Clear()}{wxstringclear}. \membersection{wxString::Find}\label{wxstringfind} @@ -140,13 +548,19 @@ Searches for the given string. Returns the starting index, or -1 if not found. Returns the first occurrence of the item. +\membersection{wxString::Freq}\label{wxstringfreq} + +\constfunc{int}{Frec}{\param{char }{ch}} + +Returns the number of occurences 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} @@ -160,14 +574,14 @@ Returns a reference to the character at position {\it n}. \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}} @@ -187,13 +601,14 @@ 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} - -\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} @@ -205,13 +620,13 @@ Returns TRUE if the string is ASCII. Returns TRUE if the string is NULL. -\membersection{wxString::IsNull}\label{wxstringIsNull} +\membersection{wxString::IsNull}\label{wxstringisnull} \constfunc{bool}{IsNull}{\void} Returns TRUE if the string is NULL (same as IsEmpty). -\membersection{wxString::IsNumber}\label{wxstringIsNumber} +\membersection{wxString::IsNumber}\label{wxstringisnumber} \constfunc{bool}{IsNumber}{\void} @@ -227,15 +642,26 @@ caseSensitive is TRUE by default (case matters). 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}} -\membersection{wxString::IsWord}\label{wxstringIsWord} +Test whether the string is equal to the single character {\it c}. The test is +case-sensitive if {\it caseSensitive} is TRUE (default) or not if it is FALSE. + +Returns TRUE if the string is equal to the character, FALSE otherwise. + +See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas} + +\membersection{wxString::IsWord}\label{wxstringisword} \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} @@ -268,7 +694,13 @@ Returns the length of the string. 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} @@ -286,7 +718,7 @@ Converts all characters to lower case. Converts all characters to upper case. -\membersection{wxString::Matches}\label{wxstringMatches} +\membersection{wxString::Matches}\label{wxstringmatches} \constfunc{bool}{Matches}{\param{const char*}{ szMask}} @@ -294,7 +726,7 @@ Returns TRUE if the string contents matches a mask containing '*' and '?'. \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. @@ -307,7 +739,7 @@ Adds {\it count} copies of {\it pad} to the beginning, or to the end of the stri 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}} @@ -317,8 +749,13 @@ Prepends {\it str} to this string, returning a reference to this string. \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} @@ -327,7 +764,7 @@ on error. 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}} @@ -343,9 +780,9 @@ Removes the last {\it len} characters from the string, starting at {\it pos}. 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. @@ -359,11 +796,6 @@ Returns the number of replacements made. Returns the last {\it count} characters. -\constfunc{wxString}{Right}{\param{char}{ ch}} - -Returns all characters after the last occurence of {\it ch}. -Returns the whole string if {\it ch} is not found. - \membersection{wxString::SetChar}\label{wxstringsetchar} \func{void}{SetChar}{\param{size\_t}{ n}, \param{char}{ch}} @@ -374,7 +806,8 @@ Sets the character at position {\it n}. \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} @@ -382,7 +815,7 @@ Minimizes the string's memory. Only works if the data of this string is not shar The same as Printf. -\membersection{wxString::Strip}\label{wxstringStrip} +\membersection{wxString::Strip}\label{wxstringstrip} \begin{verbatim} enum stripType {leading = 0x1, trailing = 0x2, both = 0x3}; @@ -393,6 +826,12 @@ 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}{ to}, \param{size\_t}{ from}} + +Same as \helpref{Mid}{wxstringmid}. + \membersection{wxString::Trim}\label{wxstringtrim} \func{wxString\&}{Trim}{\param{bool}{ fromRight = TRUE}} @@ -412,12 +851,29 @@ Truncate the string to the given length. 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}} @@ -430,11 +886,13 @@ The same as MakeUpper. \func{wxString\&}{operator $=$}{\param{const wchar\_t*}{ pwz}} -Assignment. +Assignment: the effect of each operation is the same as for the corresponding +constructor (see \helpref{wxString constructors}{wxstringconstruct}). \membersection{operator wxString::$+$}\label{wxstringoperatorplus} -Concatenation. +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}} @@ -444,7 +902,7 @@ Concatenation. \func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxString\&}{ y}} -\membersection{wxString::operator $+=$}\label{wxstringPlusEqual} +\membersection{wxString::operator $+=$}\label{wxstringplusequal} \func{void}{operator $+=$}{\param{const wxString\&}{ str}} @@ -452,7 +910,7 @@ Concatenation. \func{void}{operator $+=$}{\param{char}{ c}} -Concatenation. +Concatenation in place: the argument is appended to the string. \membersection{wxString::operator []}\label{wxstringoperatorbracket} @@ -472,14 +930,24 @@ Same as Mid (substring extraction). \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}} @@ -492,7 +960,7 @@ Extraction from a stream. 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}} @@ -522,4 +990,3 @@ Implicit conversion to a C string. These comparisons are case-sensitive. -