X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cd0b170911637899ac3c126367ee5821f357c185..9bf58645bf1a7797f39cdf4823929ce950a06976:/docs/latex/wx/wxstring.tex diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 2427335159..b81b116412 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -8,6 +8,14 @@ These standard functions are not documented in this manual so please see the STL The behaviour of all these functions is identical to the behaviour described there. +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 wxWindows +starts using it instead of wxString. + \wxheading{Derived from} None @@ -30,7 +38,7 @@ Objects: \membersection{Constructors and assignment operators} -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. @@ -55,7 +63,7 @@ or empty it. 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. @@ -92,17 +100,23 @@ 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} \membersection{Substring extraction} @@ -117,12 +131,13 @@ substring. \helpref{BeforeFirst}{wxstringbeforefirst}\\ \helpref{BeforeLast}{wxstringbeforelast}\\ \helpref{AfterFirst}{wxstringafterfirst}\\ -\helpref{AfterLast}{wxstringafterlast} +\helpref{AfterLast}{wxstringafterlast}\\ +\helpref{StartsWith}{wxstringstartswith} \membersection{Case conversion} The MakeXXX() variants modify the string in place, while the other functions -return a new string which 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}\\ @@ -142,7 +157,7 @@ functions. 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 +put the numeric value in and return true if the {\bf entire} string could be converted to a number. \helpref{ToLong}{wxstringtolong}\\ @@ -152,15 +167,29 @@ converted to a number. \membersection{Writing values into the string} 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} \membersection{Memory management} -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 @@ -182,9 +211,9 @@ Other string functions. \helpref{Pad}{wxstringpad}\\ \helpref{Truncate}{wxstringtruncate} -\membersection{wxWindows 1.xx compatiblity functions} +\membersection{wxWindows 1.xx compatibility functions} -These functiosn are deprecated, please consider using new wxWindows 2.0 +These functions are deprecated, please consider using new wxWindows 2.0 functions instead of them (or, even better, std::string compatible variants). \helpref{SubString}{wxstringsubstring}\\ @@ -293,7 +322,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 @@ -307,7 +336,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; @@ -322,7 +351,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; @@ -381,7 +410,14 @@ 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 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}} @@ -450,28 +486,28 @@ 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} @@ -495,7 +531,7 @@ See also: \helpref{Empty}{wxstringempty} 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}. @@ -507,7 +543,7 @@ See also \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissa 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}. @@ -539,7 +575,7 @@ 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. @@ -549,21 +585,41 @@ 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{size\_t}{First}{\param{const char*}{ psz}} +\constfunc{int}{First}{\param{const char*}{ psz}} -\constfunc{size\_t}{First}{\param{const wxString\&}{ str}} +\constfunc{int}{First}{\param{const wxString\&}{ str}} -\constfunc{size\_t}{First}{\param{const char}{ ch}} +Same as \helpref{Find}{wxstringfind}. -Returns the first occurrence of the item. +\membersection{wxString::Format}\label{wxstringformat} + +\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{}{...}} + +This static function returns the string containing the result of calling +\helpref{Printf}{wxstringprintf} with the passed parameters on it. + +\wxheading{See also} + +\helpref{FormatV}{wxstringformatv}, \helpref{Printf}{wxstringprintf} + +\membersection{wxString::FormatV}\label{wxstringformatv} + +\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{va\_list }{argptr}} + +This static function returns the string containing the result of calling +\helpref{PrintfV}{wxstringprintfv} with the passed parameters on it. + +\wxheading{See also} + +\helpref{Format}{wxstringformat}, \helpref{PrintfV}{wxstringprintfv} \membersection{wxString::Freq}\label{wxstringfreq} -\constfunc{int}{Frec}{\param{char }{ch}} +\constfunc{int}{Freq}{\param{char }{ch}} -Returns the number of occurences of {it ch} in the string. +Returns the number of occurrences of {\it ch} in the string. \membersection{wxString::GetChar}\label{wxstringgetchar} @@ -585,32 +641,32 @@ 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}} +\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 {\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. +Returns the index of the first item matched, or wxNOT\_FOUND. % TODO %\membersection{wxString::insert}\label{wxstringinsert} @@ -623,46 +679,46 @@ 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. +Returns true if strings are equal, false otherwise. 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}} +\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = true}} Test whether the string is equal to the single character {\it c}. The test is -case-sensitive if {\it caseSensitive} is TRUE (default) or not if it is FALSE. +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. +Returns true if the string is equal to the character, false otherwise. See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas} @@ -670,7 +726,7 @@ See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \he \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} @@ -686,12 +742,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} @@ -719,21 +770,21 @@ 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::Mid}\label{wxstringmid} @@ -744,7 +795,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). @@ -783,7 +834,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 the {\it len} characters from the string, starting at {\it pos}. \membersection{wxString::RemoveLast}\label{wxstringremovelast} @@ -793,11 +844,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. @@ -826,6 +877,16 @@ 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::Strip}\label{wxstringstrip} \begin{verbatim} @@ -839,37 +900,69 @@ 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). -Same as \helpref{Mid}{wxstringmid}. +Returns the part of the string between the indices {\it from} and {\it to} +inclusive. \membersection{wxString::ToDouble}\label{wxstringtodouble} -\cosntfunc{bool}{To}{\param{double}{ *val}} +\constfunc{bool}{ToDouble}{\param{double}{ *val}} -Attempts to convert the string to a floating point number. Returns TRUE on -suceess (the number is stored in the location pointed to by {\it val}) or FALSE +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} -\cosntfunc{bool}{To}{\param{long}{ *val}} +\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} -Attempts to convert the string to a signed integer. Returns TRUE on suceess -(the number is stored in the location pointed to by {\it val}) or FALSE if the -string does not represent such number. +\helpref{wxString::ToDouble}{wxstringtodouble},\\ +\helpref{wxString::ToULong}{wxstringtoulong} \membersection{wxString::ToULong}\label{wxstringtoulong} -\cosntfunc{bool}{To}{\param{unsigned long}{ *val}} +\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $10$}} + +Attempts to convert the string to a ansigned integer in base {\it base}. +Returns {\tt true} on success in which case the number is stored in the +location pointed to by {\it val} or {\tt false} if the string does not +represent a valid number in the given base. + +See \helpref{wxString::ToLong}{wxstringtolong} for the more detailed +description of the {\it base} parameter. + +\wxheading{See also} -Attempts to convert the string to an unsigned integer. Returns TRUE on suceess -(the number is stored in the location pointed to by {\it val}) or FALSE if the -string does not represent such number. +\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). @@ -883,9 +976,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} @@ -902,7 +1005,7 @@ The same as MakeUpper. \constfunc{bool}{operator!}{\void} -Empty string is FALSE, so !string will only return TRUE if the string is empty. +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. @@ -924,7 +1027,7 @@ 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. @@ -1025,3 +1128,57 @@ 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 to forget 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} + +\wxheading{Derived from} + +None + +\wxheading{Include files} + + + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxStringBuffer::wxStringBuffer} + +\func{}{wxStringBuffer}{\param{const wxString\& }{str}, \param{size\_t }{len}} + +Constructs a writable string buffer object associated with the given string +and containing enough space for at least {\it len} characters. Basically, this +is equivalent to calling \helpref{GetWriteBuf}{wxstringgetwritebuf} and +saving the result. + +\membersection{wxStringBuffer::\destruct{wxStringBuffer}} + +\func{}{\destruct{wxStringBuffer}}{\void} + +Restores the string passed to the constructor to the usable state by calling +\helpref{UngetWriteBuf}{wxstringungetwritebuf} on it. + +\membersection{wxStringBuffer::operator wxChar *} + +\constfunc{wxChar *}{operator wxChar *}{\void} + +Returns the writable pointer to a buffer of the size at least equal to the +length specified in the constructor. + +