X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/99f09bc1b9cbc93a6cc952ec2c777d999d5483d0..db67d86dd1de506a5bb14dd59e9c45230120758a:/docs/latex/wx/wxstring.tex?ds=sidebyside diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index a70122b4ea..40305dd472 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -1,12 +1,25 @@ \section{\class{wxString}}\label{wxstring} -wxString is a class representing a character string. Please see wxString -\helpref{overview}{wxstringoverview} for more information about it. As explained -there, wxStrign implements about 90\% of methods of std::string class (iterators -are not supported and so all methods which use them are not supported neither), -but they are not documented here - please see any source of STL documentation. +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. +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} @@ -16,15 +29,21 @@ None +\wxheading{Predefined objects} + +Objects: + +{\bf wxEmptyString} + \wxheading{See also} \overview{Overview}{wxstringoverview} \latexignore{\rtfignore{\wxheading{Function groups}}} -\membersection{Constructors and assignment operators} +\membersection{Constructors and assignment operators}\label{constructorsinwxstring} -A strign may be constructed either from a C string, (some number of copies of) +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. @@ -33,7 +52,7 @@ operator. \helpref{operator $=$}{wxstringoperatorassign}\\ \helpref{\destruct{wxString}}{wxstringdestruct} -\membersection{String length} +\membersection{String length}\label{lengthfunctionsinwxstring} These functions return the string length and check whether the string is empty or empty it. @@ -44,19 +63,19 @@ or empty it. \helpref{Empty}{wxstringempty}\\ \helpref{Clear}{wxstringclear} -\membersection{Character access} +\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 provocate an assert +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{overiview}{wxstringadvices} for the cases where it is necessary to +see \helpref{overview}{wxstringadvices} for the cases where it is necessary to use it. \helpref{GetChar}{wxstringgetchar}\\ @@ -65,9 +84,12 @@ use it. \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} +\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 @@ -79,26 +101,33 @@ should be converted to a wxString first. \helpref{Append}{wxstringappend}\\ \helpref{Prepend}{wxstringprepend} -\membersection{Comparison} +\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 Cmp does. +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{Matches}{wxstringmatches}\\ +\helpref{StartsWith}{wxstringstartswith}\\ +\helpref{EndsWith}{wxstringendswith} -\membersection{Substring extraction} +\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 @@ -111,12 +140,15 @@ substring. \helpref{BeforeFirst}{wxstringbeforefirst}\\ \helpref{BeforeLast}{wxstringbeforelast}\\ \helpref{AfterFirst}{wxstringafterfirst}\\ -\helpref{AfterLast}{wxstringafterlast} +\helpref{AfterLast}{wxstringafterlast}\\ +\helpref{StartsWith}{wxstringstartswith}\\ +\helpref{EndsWith}{wxstringendswith} + -\membersection{Case conversion} +\membersection{Case conversion}\label{caseconversioninwxstring} 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 +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}\\ @@ -124,26 +156,51 @@ lower case and leave the original string unchanged. \helpref{MakeLower}{wxstringmakelower}\\ \helpref{Lower}{wxstringlower} -\membersection{Searching and replacing} +\membersection{Searching and replacing}\label{searchingandreplacinginwxstring} -These functions replace the standard {\it strchr()} and {\it strstr()} +These functions replace the standard {\it strchr()} and {\it strstr()} functions. \helpref{Find}{wxstringfind}\\ \helpref{Replace}{wxstringreplace} -\membersection{Writing values into the string} +\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). +insertion operators exist (for basic types only). Additionally, the +\helpref{Format}{wxstringformat} function allows to use simply append +formatted value to a string: + +\begin{verbatim} + // the following 2 snippets are equivalent + + wxString s = "..."; + s += wxString::Format("%d", n); + + wxString s; + s.Printf("...%d", n); +\end{verbatim} +\helpref{Format}{wxstringformat}\\ +\helpref{FormatV}{wxstringformatv}\\ \helpref{Printf}{wxstringprintf}\\ \helpref{PrintfV}{wxstringprintfv}\\ -\helpref{operator \cinsert}{wxstringoperatorout) +\helpref{operator \cinsert}{wxstringoperatorout} -\membersection{Memory management} +\membersection{Memory management}\label{memoryinwxstring} -These are "advanced" functions and they will be needed quite rarily. +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 @@ -157,7 +214,7 @@ must} be called! \helpref{GetWriteBuf}{wxstringgetwritebuf}\\ \helpref{UngetWriteBuf}{wxstringungetwritebuf} -\membersection{Miscellaneous} +\membersection{Miscellaneous}\label{miscellaneousinwxstring} Other string functions. @@ -165,9 +222,9 @@ Other string functions. \helpref{Pad}{wxstringpad}\\ \helpref{Truncate}{wxstringtruncate} -\membersection{wxWindows 1.xx compatiblity functions} +\membersection{wxWidgets 1.xx compatibility functions}\label{backwardcompatibilityinwxstring} -These functiosn are deprecated, please consider using new wxWindows 2.0 +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}\\ @@ -188,7 +245,7 @@ functions instead of them (or, even better, std::string compatible variants). \helpref{IsNumber}{wxstringisnumber}\\ \helpref{IsWord}{wxstringisword} -\membersection{std::string compatibility functions} +\membersection{std::string compatibility functions}\label{wxstringat} The supported functions are only listed here, please see any STL reference for their documentation. @@ -276,7 +333,7 @@ their documentation. // 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 + // 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 @@ -290,7 +347,7 @@ their documentation. // 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 + // find first/last occurrence of any character in the set // size_t find_first_of(const wxString& str, size_t nStart = 0) const; @@ -305,7 +362,7 @@ their documentation. // 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 + // 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; @@ -351,7 +408,7 @@ their documentation. \func{}{wxString}{\void} -Default constructor. +Default constructor. Initializes the string to {\tt ""} (empty string). \func{}{wxString}{\param{const wxString\&}{ x}} @@ -364,16 +421,48 @@ 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 wxSTRING\_MAXLEN means take all the string. +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 wxSTRING\_MAXLEN means take all the string. +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} + +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. -\func{}{wxString}{\param{const wchar\_t*}{ psz}} +\wxheading{See also} -Constructs a string from the wide (UNICODE) string. +\helpref{wxMBConv classes}{mbconvclasses}, \helpref{mb\_str}{wxstringmbstr}, +\helpref{wc\_str}{wxstringwcstr} \membersection{wxString::\destruct{wxString}}\label{wxstringdestruct} @@ -411,7 +500,7 @@ wxString DeleteAllVowels(const wxString& original) \end{verbatim} -because it will avoid the need of reallocating string memory many times (in case +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 @@ -433,50 +522,74 @@ to it. \constfunc{wxString}{AfterFirst}{\param{char}{ ch}} -Gets all the characters after the first occurence of {\it ch}. +Gets all the characters after the first occurrence of {\it ch}. Returns the empty string if {\it ch} is not found. \membersection{wxString::AfterLast}\label{wxstringafterlast} \constfunc{wxString}{AfterLast}{\param{char}{ ch}} -Gets all the characters after the last occurence of {\it ch}. +Gets all the characters after the last occurrence 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}. +Gets all characters before the first occurrence of {\it ch}. Returns the whole string if {\it ch} is not found. \membersection{wxString::BeforeLast}\label{wxstringbeforelast} \constfunc{wxString}{BeforeLast}{\param{char}{ ch}} -Gets all characters before the last occurence of {\it ch}. +Gets all characters before the last occurrence of {\it ch}. Returns the empty string if {\it ch} is not found. +\membersection{wxString::c\_str}\label{wxstringcstr} + +\constfunc{const wxChar *}{c\_str}{\void} + +Returns a pointer to the string data ({\tt const char*} in ANSI build, +{\tt const wchar\_t*} in Unicode build). + +\wxheading{See also} + +\helpref{mb\_str}{wxstringmbstr}, \helpref{wc\_str}{wxstringwcstr}, +\helpref{fn\_str}{wxstringfnstr} + +\membersection{wxString::Clear}\label{wxstringclear} + +\func{void}{Clear}{\void} + +Empties the string and frees memory occupied by it. + +See also: \helpref{Empty}{wxstringempty} + \membersection{wxString::Cmp}\label{wxstringcmp} +\constfunc{int}{Cmp}{\param{const 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 si equal to it or negative value if it is less than argument (same semantics +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 si equal to it or negative value if it is less than argument (same semantics +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}. @@ -487,7 +600,7 @@ See also \helpref{Cmp}{wxstringcmp}, \helpref{IsSameAs}{wxstringissameas}. #define NO_POS ((int)(-1)) // undefined position enum caseCompare {exact, ignoreCase}; \end{verbatim} - + \constfunc{int}{CompareTo}{\param{const char*}{ psz}, \param{caseCompare}{ cmp = exact}} Case-sensitive comparison. Returns 0 if equal, 1 if greater or -1 if less. @@ -496,17 +609,19 @@ Case-sensitive comparison. Returns 0 if equal, 1 if greater or -1 if less. \constfunc{bool}{Contains}{\param{const wxString\&}{ str}} -Returns 1 if target appears anyhere in wxString; else 0. +Returns 1 if target appears anywhere in wxString; else 0. \membersection{wxString::Empty}\label{wxstringempty} \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} -\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = FALSE}} +\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = false}} Searches for the given character. Returns the starting index, or -1 if not found. @@ -516,21 +631,72 @@ Searches for the given string. Returns the starting index, or -1 if not found. \membersection{wxString::First}\label{wxstringfirst} -\func{size\_t}{First}{\param{char}{ c}} +\func{int}{First}{\param{char}{ c}} + +\constfunc{int}{First}{\param{const char*}{ psz}} + +\constfunc{int}{First}{\param{const wxString\&}{ str}} + +Same as \helpref{Find}{wxstringfind}. + +\membersection{wxString::fn\_str}\label{wxstringfnstr} + +\constfunc{const wchar\_t*}{fn\_str}{\void} + +\constfunc{const char*}{fn\_str}{\void} + +\constfunc{const wxCharBuffer}{fn\_str}{\void} + +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. + +\wxheading{See also} + +\helpref{wxMBConv}{wxmbconv}, +\helpref{wc\_str}{wxstringwcstr}, \helpref{mb\_str}{wxstringwcstr} + +\membersection{wxString::Format}\label{wxstringformat} + +\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{}{...}} + +This static function returns the string containing the result of calling +\helpref{Printf}{wxstringprintf} with the passed parameters on it. + +\wxheading{See also} + +\helpref{FormatV}{wxstringformatv}, \helpref{Printf}{wxstringprintf} + +\membersection{wxString::FormatV}\label{wxstringformatv} -\constfunc{size\_t}{First}{\param{const char*}{ psz}} +\func{static wxString}{FormatV}{\param{const wxChar }{*format}, \param{va\_list }{argptr}} -\constfunc{size\_t}{First}{\param{const wxString\&}{ str}} +This static function returns the string containing the result of calling +\helpref{PrintfV}{wxstringprintfv} with the passed parameters on it. -\constfunc{size\_t}{First}{\param{const char}{ ch}} +\wxheading{See also} -Returns the first occurrence of the item. +\helpref{Format}{wxstringformat}, \helpref{PrintfV}{wxstringprintfv} \membersection{wxString::Freq}\label{wxstringfreq} -\constfunc{int}{Frec}{\param{char }{ch}} +\constfunc{int}{Freq}{\param{char }{ch}} + +Returns the number of occurrences of {\it ch} in the string. + +\membersection{wxString::FromAscii}\label{wxstringfromascii} -Returns the number of occurences of {it ch} in the string. +\func{static wxString }{FromAscii}{\param{const char*}{ s}} + +\func{static wxString }{FromAscii}{\param{const char}{ c}} + +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. \membersection{wxString::GetChar}\label{wxstringgetchar} @@ -540,9 +706,9 @@ Returns the character at position {\it n} (read-only). \membersection{wxString::GetData}\label{wxstringgetdata} -\constfunc{const char*}{GetData}{\void} +\constfunc{const wxChar*}{GetData}{\void} -wxWindows compatibility conversion. Returns a constant pointer to the data in the string. +wxWidgets compatibility conversion. Returns a constant pointer to the data in the string. \membersection{wxString::GetWritableChar}\label{wxstringgetwritablechar} @@ -552,33 +718,23 @@ Returns a reference to the character at position {\it n}. \membersection{wxString::GetWriteBuf}\label{wxstringgetwritebuf} -\func{char*}{GetWriteBuf}{\param{size\_t}{ len}} +\func{wxChar*}{GetWriteBuf}{\param{size\_t}{ len}} 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. Call \helpref{wxString::UngetWriteBuf}{wxstringungetwritebuf} as soon as possible to put the string back into a reasonable state. \membersection{wxString::Index}\label{wxstringindex} -\constfunc{size\_t}{Index}{\param{char}{ ch}, \param{int}{ startpos = 0}} - -Same as \helpref{wxString::Find}{wxstringfind}. +\constfunc{size\_t}{Index}{\param{char}{ ch}} \constfunc{size\_t}{Index}{\param{const char*}{ sz}} Same as \helpref{wxString::Find}{wxstringfind}. -\constfunc{size\_t}{Index}{\param{const char*}{ sz}, \param{bool}{ caseSensitive = TRUE}, \param{bool}{ fromEnd = FALSE}} - -Search the element in the array, starting from either side. - -If {\it fromEnd} is TRUE, reverse search direction. - -If {\bf caseSensitive}, comparison is case sensitive (the default). - -Returns the index of the first item matched, or NOT\_FOUND. - % TODO %\membersection{wxString::insert}\label{wxstringinsert} % Wrong! @@ -590,43 +746,52 @@ Returns the index of the first item matched, or NOT\_FOUND. \constfunc{bool}{IsAscii}{\void} -Returns TRUE if the string is ASCII. +Returns true if the string contains only ASCII characters. \membersection{wxString::IsEmpty}\label{wxstringisempty} \constfunc{bool}{IsEmpty}{\void} -Returns TRUE if the string is NULL. +Returns true if the string is empty. \membersection{wxString::IsNull}\label{wxstringisnull} \constfunc{bool}{IsNull}{\void} -Returns TRUE if the string is NULL (same as IsEmpty). +Returns true if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}). \membersection{wxString::IsNumber}\label{wxstringisnumber} \constfunc{bool}{IsNumber}{\void} -Returns TRUE if the string is a number. +Returns true if the string is an integer (with possible sign). \membersection{wxString::IsSameAs}\label{wxstringissameas} -\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = TRUE}} +\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = true}} Test for string equality, case-sensitive (default) or not. -caseSensitive is TRUE by default (case matters). +caseSensitive is true by default (case matters). + +Returns true if strings are equal, false otherwise. + +See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase} + +\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = true}} -Returns TRUE if strings are equal, FALSE otherwise. +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. -See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}. +Returns true if the string is equal to the character, false otherwise. + +See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase} \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? +Returns true if the string is a word. TODO: what's the definition of a word? \membersection{wxString::Last}\label{wxstringlast} @@ -642,12 +807,7 @@ Returns a reference to the last character (writable). \constfunc{wxString}{Left}{\param{size\_t}{ count}} -Returns the first {\it count} characters. - -\constfunc{wxString}{Left}{\param{char}{ ch}} - -Returns all characters before the first occurence of {\it ch}. -Returns the whole string if {\it ch} is not found. +Returns the first {\it count} characters of the string. \membersection{wxString::Len}\label{wxstringlen} @@ -675,21 +835,39 @@ Same as MakeLower. \membersection{wxString::MakeLower}\label{wxstringmakelower} -\func{void}{MakeLower}{\void} +\func{wxString\&}{MakeLower}{\void} -Converts all characters to lower case. +Converts all characters to lower case and returns the result. \membersection{wxString::MakeUpper}\label{wxstringmakeupper} -\func{void}{MakeUpper}{\void} +\func{wxString\&}{MakeUpper}{\void} -Converts all characters to upper case. +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 '?'. +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} @@ -700,7 +878,7 @@ 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}} +\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). @@ -739,7 +917,7 @@ 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 the last {\it len} characters from the string, starting at {\it pos}. +Removes {\it len} characters from the string, starting at {\it pos}. \membersection{wxString::RemoveLast}\label{wxstringremovelast} @@ -749,11 +927,11 @@ 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}} +\func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = true}} -Replace first (or all) occurences of substring with another one. +Replace first (or all) occurrences of substring with another one. -{\it replaceAll}: global replace (default), or only the first occurence. +{\it replaceAll}: global replace (default), or only the first occurrence. Returns the number of replacements made. @@ -763,11 +941,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}} @@ -787,6 +960,26 @@ Minimizes the string's memory. This can be useful after a call to The same as Printf. +\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} @@ -800,15 +993,90 @@ doesn't change this string. \membersection{wxString::SubString}\label{wxstringsubstring} -\constfunc{wxString}{SubString}{\param{size\_t}{ to}, \param{size\_t}{ from}} +\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} -Same as \helpref{Mid}{wxstringmid}. +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} -\func{wxString\&}{Trim}{\param{bool}{ fromRight = TRUE}} +\func{wxString\&}{Trim}{\param{bool}{ fromRight = true}} -Removes spaces from the left or from the right (default). +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). \membersection{wxString::Truncate}\label{wxstringtruncate} @@ -820,9 +1088,19 @@ Truncate the string to the given length. \func{void}{UngetWriteBuf}{\void} -Puts the string back into a reasonable state, after +\func{void}{UngetWriteBuf}{\param{size\_t }{len}} + +Puts the string back into a reasonable state (in which it can be used +normally), after \rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called. +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} @@ -835,12 +1113,30 @@ Returns this string converted to upper case. 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 emptyness +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. @@ -861,10 +1157,10 @@ See also \helpref{IsEmpty()}{wxstringisempty}. Assignment: the effect of each operation is the same as for the corresponding constructor (see \helpref{wxString constructors}{wxstringconstruct}). -\membersection{operator wxString::$+$}\label{wxstringoperatorplus} +\membersection{wxString::operator $+$}\label{wxstringoperatorplus} -Concatenation: all these operators return a new strign equal to the sum of the -operands. +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}} @@ -886,11 +1182,13 @@ Concatenation in place: the argument is appended to the string. \membersection{wxString::operator []}\label{wxstringoperatorbracket} -\func{char\&}{operator []}{\param{size\_t}{ i}} +\func{wxChar\&}{operator []}{\param{size\_t}{ i}} -\func{char}{operator []}{\param{size\_t}{ i}} +\constfunc{wxChar}{operator []}{\param{size\_t}{ i}} -\func{char}{operator []}{\param{int}{ i}} +\func{wxChar\&}{operator []}{\param{int}{ i}} + +\constfunc{wxChar}{operator []}{\param{int}{ i}} Element extraction. @@ -963,3 +1261,139 @@ Implicit conversion to a C string. 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} + wxString theAnswer; + GetMeaningOfLifeAsString(wxStringBuffer(theAnswer, 1024)); + 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. + +\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. + +