X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d6718dd17be552c69c7e4dbca183f6078998c042..066f3611df971be93b2ec46b82c2f05f3ff9a422:/docs/latex/wx/wxstring.tex?ds=sidebyside diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 87287ca01d..5016c78fbe 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -1,12 +1,14 @@ \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. +\helpref{wxString overview}{wxstringoverview} for more information about it. + +As explained there, wxString implements most of the methods of the std::string +class. +These standard functions are not documented in this manual, please see the +\urlref{STL documentation}{http://www.cppreference.com/cppstl.html}). The behaviour of all these functions is identical to the behaviour described -there (except that wxString is sensitive to null character). +there. You may notice that wxString sometimes has many functions which do the same thing like, for example, \helpref{Length()}{wxstringlength}, @@ -16,11 +18,6 @@ method ({\tt length()} in this case, always the lowercase version) should be used as it will ensure smoother transition to {\tt std::string} when wxWidgets starts using it instead of wxString. -Also please note that in this manual \texttt{char} is sometimes used instead of -\texttt{wxChar} because it hasn't been fully updated yet. Please substitute as -necessary and refer to the sources in case of a doubt. - - \wxheading{Derived from} None @@ -29,6 +26,10 @@ None +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{Predefined objects} Objects: @@ -37,7 +38,7 @@ Objects: \wxheading{See also} -\overview{Overview}{wxstringoverview} +\helpref{wxString overview}{wxstringoverview}, \helpref{Unicode overview}{unicode} \latexignore{\rtfignore{\wxheading{Function groups}}} @@ -113,7 +114,7 @@ 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) +\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: @@ -177,11 +178,13 @@ 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}\\ +\helpref{ToLongLong}{wxstringtolonglong}\\ \helpref{ToULong}{wxstringtoulong}\\ +\helpref{ToULongLong}{wxstringtoulonglong}\\ \helpref{ToDouble}{wxstringtodouble} @@ -214,16 +217,15 @@ formatted value to a string: These are "advanced" functions and they will be needed quite rarely. \helpref{Alloc}{wxstringalloc} and \helpref{Shrink}{wxstringshrink} are only interesting for optimization purposes. -\helpref{GetWriteBuf}{wxstringgetwritebuf} may be very useful when working with -some external API which requires the caller to provide a writable buffer, but -extreme care should be taken when using it: before performing any other -operation on the string \helpref{UngetWriteBuf}{wxstringungetwritebuf} {\bf -must} be called! +\helpref{wxStringBuffer}{wxstringbuffer} +and \helpref{wxStringBufferLength}{wxstringbufferlength} classes may be very +useful when working with some external API which requires the caller to provide +a writable buffer. \helpref{Alloc}{wxstringalloc}\\ \helpref{Shrink}{wxstringshrink}\\ -\helpref{GetWriteBuf}{wxstringgetwritebuf}\\ -\helpref{UngetWriteBuf}{wxstringungetwritebuf} +\helpref{wxStringBuffer}{wxstringbuffer}\\ +\helpref{wxStringBufferLength}{wxstringbufferlength} \membersection{Miscellaneous}\label{miscellaneousinwxstring} @@ -231,8 +233,8 @@ must} be called! Other string functions. \helpref{Trim}{wxstringtrim}\\ -\helpref{Pad}{wxstringpad}\\ -\helpref{Truncate}{wxstringtruncate} +\helpref{Truncate}{wxstringtruncate}\\ +\helpref{Pad}{wxstringpad} \membersection{wxWidgets 1.xx compatibility functions}\label{backwardcompatibilityinwxstring} @@ -240,23 +242,23 @@ Other string functions. These functions are deprecated, please consider using new wxWidgets 2.0 functions instead of them (or, even better, std::string compatible variants). -\helpref{SubString}{wxstringsubstring}\\ -\helpref{sprintf}{wxstringsprintf}\\ +% keep ordered alphabetically \helpref{CompareTo}{wxstringcompareto}\\ -\helpref{Length}{wxstringlength}\\ +\helpref{Contains}{wxstringcontains}\\ +\helpref{First}{wxstringfirst}\\ \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{IsNull}{wxstringisnull}\\ \helpref{IsNumber}{wxstringisnumber}\\ -\helpref{IsWord}{wxstringisword} +\helpref{IsWord}{wxstringisword}\\ +\helpref{Last}{wxstringlast}\\ +\helpref{Length}{wxstringlength}\\ +\helpref{LowerCase}{wxstringlowercase}\\ +\helpref{Remove}{wxstringremove}\\ +\helpref{Strip}{wxstringstrip}\\ +\helpref{SubString}{wxstringsubstring}\\ +\helpref{UpperCase}{wxstringuppercase} \membersection{std::string compatibility functions}\label{wxstringat} @@ -429,11 +431,11 @@ Default constructor. Initializes the string to {\tt ""} (empty string). Copy constructor. -\func{}{wxString}{\param{char}{ ch}, \param{size\_t}{ n = 1}} +\func{}{wxString}{\param{wxChar}{ ch}, \param{size\_t}{ n = 1}} Constructs a string of {\it n} copies of character {\it ch}. -\func{}{wxString}{\param{const char*}{ psz}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}} +\func{}{wxString}{\param{const wxChar*}{ psz}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}} Takes first {\it nLength} characters from the C string {\it psz}. The default value of {\tt wxSTRING\_MAXLEN} means to take all the string. @@ -449,16 +451,14 @@ results otherwise. For compilers using unsigned char: takes first {\it nLength} characters from the C string {\it psz}. The default value of {\tt wxSTRING\_MAXLEN} means take all the string. - -{\bf Note:} In Unicode build, all of the above constructors take -{\tt wchar\_t} arguments instead of {\tt char}. +For ANSI builds only (note the use of {\tt char} instead of {\tt wxChar}). \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. +The following constructors allow you to construct wxString from a wide string +in ANSI build or from a C string in Unicode build. -\func{}{wxString}{\param{const wchar\_t*}{ psz}, \param{wxMBConv\&}{ conv}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}} +\func{}{wxString}{\param{const wchar\_t*}{ psz}, \param{const 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. @@ -466,13 +466,14 @@ 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}} +\func{}{wxString}{\param{const char*}{ psz}, \param{const wxMBConv\&}{ conv = wxConvLibc}, \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. +convert \arg{psz} to wide string (the default converter uses current locale's +charset). It is ignored in ANSI build. \wxheading{See also} @@ -527,11 +528,11 @@ greater than {\it nLen} \membersection{wxString::Append}\label{wxstringappend} -\func{wxString\&}{Append}{\param{const char*}{ psz}} +\func{wxString\&}{Append}{\param{const wxChar*}{ psz}} Concatenates {\it psz} to this string, returning a reference to it. -\func{wxString\&}{Append}{\param{char}{ ch}, \param{int}{ count = 1}} +\func{wxString\&}{Append}{\param{wxChar}{ ch}, \param{int}{ count = 1}} Concatenates character {\it ch} to this string, {\it count} times, returning a reference to it. @@ -539,7 +540,7 @@ to it. \membersection{wxString::AfterFirst}\label{wxstringafterfirst} -\constfunc{wxString}{AfterFirst}{\param{char}{ ch}} +\constfunc{wxString}{AfterFirst}{\param{wxChar}{ ch}} Gets all the characters after the first occurrence of {\it ch}. Returns the empty string if {\it ch} is not found. @@ -547,7 +548,7 @@ Returns the empty string if {\it ch} is not found. \membersection{wxString::AfterLast}\label{wxstringafterlast} -\constfunc{wxString}{AfterLast}{\param{char}{ ch}} +\constfunc{wxString}{AfterLast}{\param{wxChar}{ ch}} Gets all the characters after the last occurrence of {\it ch}. Returns the whole string if {\it ch} is not found. @@ -555,7 +556,7 @@ Returns the whole string if {\it ch} is not found. \membersection{wxString::BeforeFirst}\label{wxstringbeforefirst} -\constfunc{wxString}{BeforeFirst}{\param{char}{ ch}} +\constfunc{wxString}{BeforeFirst}{\param{wxChar}{ ch}} Gets all characters before the first occurrence of {\it ch}. Returns the whole string if {\it ch} is not found. @@ -563,7 +564,7 @@ Returns the whole string if {\it ch} is not found. \membersection{wxString::BeforeLast}\label{wxstringbeforelast} -\constfunc{wxString}{BeforeLast}{\param{char}{ ch}} +\constfunc{wxString}{BeforeLast}{\param{wxChar}{ ch}} Gets all characters before the last occurrence of {\it ch}. Returns the empty string if {\it ch} is not found. @@ -576,10 +577,32 @@ Returns the empty string if {\it ch} is not found. Returns a pointer to the string data ({\tt const char*} in ANSI build, {\tt const wchar\_t*} in Unicode build). +Note that the returned value is not convertible to {\tt char*} or +{\tt wchar\_t*}, use \helpref{char\_str}{wxstringcharstr} or +\helpref{wchar\_string}{wxstringwcharstr} if you need to pass string value +to a function expecting non-const pointer. + \wxheading{See also} \helpref{mb\_str}{wxstringmbstr}, \helpref{wc\_str}{wxstringwcstr}, -\helpref{fn\_str}{wxstringfnstr} +\helpref{fn\_str}{wxstringfnstr}, \helpref{char\_str}{wxstringcharstr}, +\helpref{wchar\_string}{wxstringwcharstr} + +\membersection{wxString::char\_str}\label{wxstringcharstr} + +\constfunc{wxWritableCharBuffer}{char\_str}{\param{const wxMBConv\&}{ conv = wxConvLibc}} + +Returns an object with string data that is implicitly convertible to +{\tt char*} pointer. Note that any change to the returned buffer is lost and so +this function is only usable for passing strings to legacy libraries that +don't have const-correct API. Use \helpref{wxStringBuffer}{wxstringbuffer} if +you want to modify the string. + +\wxheading{See also} + +\helpref{mb\_str}{wxstringmbstr}, \helpref{wc\_str}{wxstringwcstr}, +\helpref{fn\_str}{wxstringfnstr}, \helpref{c\_str}{wxstringcstr}, +\helpref{wchar\_str}{wxstringwcharstr} \membersection{wxString::Clear}\label{wxstringclear} @@ -595,7 +618,7 @@ See also: \helpref{Empty}{wxstringempty} \constfunc{int}{Cmp}{\param{const wxString\&}{ s}} -\constfunc{int}{Cmp}{\param{const char*}{ psz}} +\constfunc{int}{Cmp}{\param{const wxChar*}{ psz}} Case-sensitive comparison. @@ -610,7 +633,7 @@ See also \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissa \constfunc{int}{CmpNoCase}{\param{const wxString\&}{ s}} -\constfunc{int}{CmpNoCase}{\param{const char*}{ psz}} +\constfunc{int}{CmpNoCase}{\param{const wxChar*}{ psz}} Case-insensitive comparison. @@ -624,20 +647,23 @@ See also \helpref{Cmp}{wxstringcmp}, \helpref{IsSameAs}{wxstringissameas}. \membersection{wxString::CompareTo}\label{wxstringcompareto} \begin{verbatim} -#define NO_POS ((int)(-1)) // undefined position -enum caseCompare {exact, ignoreCase}; +enum wxString::caseCompare {exact, ignoreCase}; \end{verbatim} -\constfunc{int}{CompareTo}{\param{const char*}{ psz}, \param{caseCompare}{ cmp = exact}} +\constfunc{int}{CompareTo}{\param{const wxChar*}{ psz}, \param{caseCompare}{ cmp = exact}} Case-sensitive comparison. Returns 0 if equal, 1 if greater or -1 if less. +This is a wxWidgets 1.xx compatibility function; use \helpref{Cmp}{wxstringcmp} instead. + \membersection{wxString::Contains}\label{wxstringcontains} \constfunc{bool}{Contains}{\param{const wxString\&}{ str}} -Returns 1 if target appears anywhere in wxString; else 0. +Returns \true if target appears anywhere in wxString; else \false. + +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. \membersection{wxString::Empty}\label{wxstringempty} @@ -651,25 +677,27 @@ See also: \helpref{Clear()}{wxstringclear}. \membersection{wxString::Find}\label{wxstringfind} -\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = false}} +\constfunc{int}{Find}{\param{wxUniChar}{ ch}, \param{bool}{ fromEnd = false}} -Searches for the given character. Returns the starting index, or -1 if not found. +Searches for the given character. Returns the starting index, or {\tt wxNOT\_FOUND} if not found. -\constfunc{int}{Find}{\param{const char*}{ sz}} +\constfunc{int}{Find}{\param{const wxString\&}{ sub}} -Searches for the given string. Returns the starting index, or -1 if not found. +Searches for the given string. Returns the starting index, or {\tt wxNOT\_FOUND} if not found. \membersection{wxString::First}\label{wxstringfirst} -\func{int}{First}{\param{char}{ c}} +\func{int}{First}{\param{wxChar}{ c}} -\constfunc{int}{First}{\param{const char*}{ psz}} +\constfunc{int}{First}{\param{const wxChar*}{ psz}} \constfunc{int}{First}{\param{const wxString\&}{ str}} Same as \helpref{Find}{wxstringfind}. +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. + \membersection{wxString::fn\_str}\label{wxstringfnstr} @@ -717,27 +745,66 @@ This static function returns the string containing the result of calling \membersection{wxString::Freq}\label{wxstringfreq} -\constfunc{int}{Freq}{\param{char }{ch}} +\constfunc{int}{Freq}{\param{wxChar }{ch}} Returns the number of occurrences of {\it ch} in the string. +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. + +\membersection{wxString::From8BitData}\label{wxstringfrom8bitdata} + +\func{static wxString }{From8BitData}{\param{const char*}{ buf}, \param{size\_t}{len}} + +\func{static wxString }{From8BitData}{\param{const char*}{ buf}} + +Converts given buffer of binary data from 8-bit string to wxString. In Unicode +build, the string is interpreted as being in ISO-8859-1 encoding. The version +without \arg{len} parameter takes NUL-terminated data. + +This is a convenience method useful when storing binary data in wxString. + +\newsince{2.8.4} + +\wxheading{See also} + +\helpref{To8BitData}{wxstringto8bitdata} + \membersection{wxString::FromAscii}\label{wxstringfromascii} \func{static wxString }{FromAscii}{\param{const char*}{ s}} -\func{static wxString }{FromAscii}{\param{const char}{ c}} +\func{static wxString }{FromAscii}{\param{const unsigned char*}{ s}} + +\func{static wxString }{FromAscii}{\param{const char*}{ s}, \param{size\_t}{ len}} + +\func{static wxString }{FromAscii}{\param{const unsigned char*}{ s}, \param{size\_t}{ len}} + +\func{static wxString }{FromAscii}{\param{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. +a Unicode build of wxWidgets (note the use of {\tt char} instead of {\tt wxChar}). Use \helpref{wxString constructors}{wxstringconstruct} if you need to convert from another charset. +\membersection{wxString::FromUTF8}\label{wxstringfromutf8} + +\func{static wxString }{FromUTF8}{\param{const char*}{ s}} + +\func{static wxString }{FromUTF8}{\param{const char*}{ s}, \param{size\_t}{ len}} + +Converts C string encoded in UTF-8 to wxString. + +Note that this method assumes that \arg{s} is a valid UTF-8 sequence and +doesn't do any validation in release builds, it's validity is only checked in +debug builds. + + \membersection{wxString::GetChar}\label{wxstringgetchar} -\constfunc{char}{GetChar}{\param{size\_t}{ n}} +\constfunc{wxChar}{GetChar}{\param{size\_t}{ n}} Returns the character at position {\it n} (read-only). @@ -751,7 +818,7 @@ wxWidgets compatibility conversion. Returns a constant pointer to the data in th \membersection{wxString::GetWritableChar}\label{wxstringgetwritablechar} -\func{char\&}{GetWritableChar}{\param{size\_t}{ n}} +\func{wxChar\&}{GetWritableChar}{\param{size\_t}{ n}} Returns a reference to the character at position {\it n}. @@ -764,72 +831,77 @@ 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. +Call \helpref{wxString::UngetWriteBuf}{wxstringungetwritebuf} as soon as +possible to put the string back into a reasonable state. + +This method is deprecated, please use +\helpref{wxStringBuffer}{wxstringbuffer} or +\helpref{wxStringBufferLength}{wxstringbufferlength} instead. \membersection{wxString::Index}\label{wxstringindex} -\constfunc{size\_t}{Index}{\param{char}{ ch}} +\constfunc{size\_t}{Index}{\param{wxChar}{ ch}} -\constfunc{size\_t}{Index}{\param{const char*}{ sz}} +\constfunc{size\_t}{Index}{\param{const wxChar*}{ sz}} Same as \helpref{wxString::Find}{wxstringfind}. -% 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. -% +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. + \membersection{wxString::IsAscii}\label{wxstringisascii} \constfunc{bool}{IsAscii}{\void} -Returns true if the string contains only ASCII characters. +Returns \true if the string contains only ASCII characters. + +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. \membersection{wxString::IsEmpty}\label{wxstringisempty} \constfunc{bool}{IsEmpty}{\void} -Returns true if the string is empty. +Returns \true if the string is empty. \membersection{wxString::IsNull}\label{wxstringisnull} \constfunc{bool}{IsNull}{\void} -Returns true if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}). +Returns \true if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}). + +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. \membersection{wxString::IsNumber}\label{wxstringisnumber} \constfunc{bool}{IsNumber}{\void} -Returns true if the string is an integer (with possible sign). +Returns \true if the string is an integer (with possible sign). + +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. \membersection{wxString::IsSameAs}\label{wxstringissameas} -\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = true}} +\constfunc{bool}{IsSameAs}{\param{const wxChar*}{ 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} -\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = true}} +\constfunc{bool}{IsSameAs}{\param{wxChar}{ 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} @@ -838,19 +910,23 @@ See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase} \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. + +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. \membersection{wxString::Last}\label{wxstringlast} -\constfunc{char}{Last}{\void} +\constfunc{wxChar}{Last}{\void} Returns the last character. -\func{char\&}{Last}{\void} +\func{wxChar\&}{Last}{\void} Returns a reference to the last character (writable). +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. + \membersection{wxString::Left}\label{wxstringleft} @@ -872,6 +948,8 @@ Returns the length of the string. Returns the length of the string (same as Len). +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. + \membersection{wxString::Lower}\label{wxstringlower} @@ -886,6 +964,8 @@ Returns this string converted to the lower case. Same as MakeLower. +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. + \membersection{wxString::MakeLower}\label{wxstringmakelower} @@ -903,16 +983,16 @@ Converts all characters to upper case and returns the result. \membersection{wxString::Matches}\label{wxstringmatches} -\constfunc{bool}{Matches}{\param{const char*}{ szMask}} +\constfunc{bool}{Matches}{\param{const wxString\&}{ mask}} -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 char*}{mb\_str}{\param{const wxMBConv\&}{ conv = wxConvLibc}} -\constfunc{const wxCharBuffer}{mb\_str}{\param{wxMBConv\&}{ conv}} +\constfunc{const wxCharBuffer}{mb\_str}{\param{const wxMBConv\&}{ conv = wxConvLibc}} Returns multibyte (C string) representation of the string. In Unicode build, converts using \arg{conv}'s \helpref{cWC2MB}{wxmbconvcwc2mb} @@ -924,7 +1004,7 @@ The macro wxWX2MBbuf is defined as the correct return type (without const). \helpref{wxMBConv}{wxmbconv}, \helpref{c\_str}{wxstringcstr}, \helpref{wc\_str}{wxstringwcstr}, -\helpref{fn\_str}{wxstringfnstr} +\helpref{fn\_str}{wxstringfnstr}, \helpref{char\_str}{wxstringcharstr} \membersection{wxString::Mid}\label{wxstringmid} @@ -937,7 +1017,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{wxChar}{ pad = ' '}, \param{bool}{ fromRight = true}} Adds {\it count} copies of {\it pad} to the beginning, or to the end of the string (the default). @@ -953,7 +1033,7 @@ Prepends {\it str} to this string, returning a reference to this string. \membersection{wxString::Printf}\label{wxstringprintf} -\func{int}{Printf}{\param{const char* }{pszFormat}, \param{}{...}} +\func{int}{Printf}{\param{const wxChar* }{pszFormat}, \param{}{...}} Similar to the standard function {\it sprintf()}. Returns the number of characters written, or an integer less than zero on error. @@ -979,7 +1059,7 @@ dangerous {\it vsprintf()} will be used then which may lead to buffer overflows. \membersection{wxString::PrintfV}\label{wxstringprintfv} -\func{int}{PrintfV}{\param{const char* }{pszFormat}, \param{va\_list}{ argPtr}} +\func{int}{PrintfV}{\param{const wxChar* }{pszFormat}, \param{va\_list}{ argPtr}} Similar to vprintf. Returns the number of characters written, or an integer less than zero on error. @@ -995,6 +1075,8 @@ Same as Truncate. Removes the portion from {\it pos} to the end of the string. Removes {\it len} characters from the string, starting at {\it pos}. +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. + \membersection{wxString::RemoveLast}\label{wxstringremovelast} @@ -1005,7 +1087,7 @@ 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 wxString\&}{ strOld}, \param{const wxString\&}{ strNew}, \param{bool}{ replaceAll = true}} Replace first (or all) occurrences of substring with another one. @@ -1023,7 +1105,7 @@ Returns the last {\it count} characters. \membersection{wxString::SetChar}\label{wxstringsetchar} -\func{void}{SetChar}{\param{size\_t}{ n}, \param{char}{ch}} +\func{void}{SetChar}{\param{size\_t}{ n}, \param{wxChar}{ch}} Sets the character at position {\it n}. @@ -1036,39 +1118,32 @@ Minimizes the string's memory. This can be useful after a call to \helpref{Alloc()}{wxstringalloc} if too much memory were preallocated. -\membersection{wxString::sprintf}\label{wxstringsprintf} - -\func{void}{sprintf}{\param{const char* }{ fmt}} - -The same as Printf. - - \membersection{wxString::StartsWith}\label{wxstringstartswith} -\constfunc{bool}{StartsWith}{\param{const wxChar }{*prefix}, \param{wxString }{*rest = NULL}} +\constfunc{bool}{StartsWith}{\param{const wxString\& }{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 +{\it prefix}. If it does, the function will return \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 +{\tt NULL}. Otherwise, the function returns \false and doesn't modify the {\it rest}. \membersection{wxString::EndsWith}\label{wxstringendswith} -\constfunc{bool}{EndsWith}{\param{const wxChar }{*suffix}, \param{wxString }{*rest = NULL}} +\constfunc{bool}{EndsWith}{\param{const wxString\& }{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 +{\it suffix}. If it does, the function will return \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 +{\tt NULL}. Otherwise, the function returns \false and doesn't modify the {\it rest}. \membersection{wxString::Strip}\label{wxstringstrip} \begin{verbatim} -enum stripType {leading = 0x1, trailing = 0x2, both = 0x3}; +enum wxString::stripType {leading = 0x1, trailing = 0x2, both = 0x3}; \end{verbatim} \constfunc{wxString}{Strip}{\param{stripType}{ s = trailing}} @@ -1076,28 +1151,48 @@ 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. +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. + \membersection{wxString::SubString}\label{wxstringsubstring} \constfunc{wxString}{SubString}{\param{size\_t}{ from}, \param{size\_t}{ to}} -Deprecated, use \helpref{Mid}{wxstringmid} instead (but note that parameters -have different meaning). - Returns the part of the string between the indices {\it from} and {\it to} inclusive. +This is a wxWidgets 1.xx compatibility function, use \helpref{Mid}{wxstringmid} +instead (but note that parameters have different meaning). + + +\membersection{wxString::To8BitData}\label{wxstringto8bitdata} + +\constfunc{const char*}{To8BitData}{\void} + +Converts the string to an 8-bit string (ANSI builds only). + +\constfunc{const wxCharBuffer}{To8BitData}{\void} + +Converts the string to an 8-bit string in ISO-8859-1 encoding in the form of +a wxCharBuffer (Unicode builds only). + +This is a convenience method useful when storing binary data in wxString. + +\newsince{2.8.4} + +\wxheading{See also} + +\helpref{From8BitData}{wxstringfrom8bitdata} + \membersection{wxString::ToAscii}\label{wxstringtoascii} \constfunc{const char*}{ToAscii}{\void} -Converts the string to an ASCII, 7-bit string (ANSI builds only). - \constfunc{const wxCharBuffer}{ToAscii}{\void} Converts the string to an ASCII, 7-bit string in the form of -a wxCharBuffer (Unicode builds only). +a wxCharBuffer (Unicode builds only) or a C string (ANSI builds). Note that this conversion only works if the string contains only ASCII characters. The \helpref{mb\_str}{wxstringmbstr} method provides more @@ -1108,8 +1203,8 @@ powerful means of converting wxString to C string. \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 +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} @@ -1123,8 +1218,8 @@ if the string does not represent such number. \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 +\true on success in which case the number is stored in the location +pointed to by {\it val} or \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 @@ -1163,8 +1258,8 @@ with C99 support and Microsoft Visual C++ version 7 and higher do support this. \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 +Returns \true on success in which case the number is stored in the +location pointed to by {\it val} or \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 @@ -1189,6 +1284,15 @@ bit integer numbers. Please see \helpref{ToLongLong}{wxstringtolonglong} for additional remarks. +\membersection{wxString::ToUTF8}\label{wxstringtoutf8} + +\constfunc{const char*}{ToUTF8}{\void} + +\constfunc{const wxCharBuffer}{ToUF8}{\void} + +Same as \helpref{utf8\_str}{wxstringutf8str}. + + \membersection{wxString::Trim}\label{wxstringtrim} \func{wxString\&}{Trim}{\param{bool}{ fromRight = true}} @@ -1221,6 +1325,10 @@ 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). +This method is deprecated, please use +\helpref{wxStringBuffer}{wxstringbuffer} or +\helpref{wxStringBufferLength}{wxstringbufferlength} instead. + \membersection{wxString::Upper}\label{wxstringupper} @@ -1235,12 +1343,26 @@ Returns this string converted to upper case. The same as MakeUpper. +This is a wxWidgets 1.xx compatibility function; you should not use it in new code. + + +\membersection{wxString::utf8\_str}\label{wxstringutf8str} + +\constfunc{const char*}{utf8\_str}{\void} + +\constfunc{const wxCharBuffer}{utf8\_str}{\void} + +Converts the strings contents to UTF-8 and returns it either as a temporary +wxCharBuffer object or as a pointer to the internal string contents in +UTF-8 build. +% FIXME-UTF8: link to a topic explaining UTF-8 build here + \membersection{wxString::wc\_str}\label{wxstringwcstr} -\constfunc{const wchar\_t*}{wc\_str}{\param{wxMBConv\&}{ conv}} +\constfunc{const wchar\_t*}{wc\_str}{\param{const wxMBConv\&}{ conv}} -\constfunc{const wxWCharBuffer}{wc\_str}{\param{wxMBConv\&}{ conv}} +\constfunc{const wxWCharBuffer}{wc\_str}{\param{const wxMBConv\&}{ conv}} Returns wide character representation of the string. In ANSI build, converts using \arg{conv}'s \helpref{cMB2WC}{wxmbconvcmb2wc} @@ -1252,15 +1374,31 @@ The macro wxWX2WCbuf is defined as the correct return type (without const). \helpref{wxMBConv}{wxmbconv}, \helpref{c\_str}{wxstringcstr}, \helpref{mb\_str}{wxstringwcstr}, -\helpref{fn\_str}{wxstringfnstr} +\helpref{fn\_str}{wxstringfnstr}, \helpref{wchar\_str}{wxstringwcharstr} + +\membersection{wxString::wchar\_str}\label{wxstringwcharstr} + +\constfunc{wxWritableWCharBuffer}{wchar\_str}{\void} + +Returns an object with string data that is implicitly convertible to +{\tt char*} pointer. Note that changes to the returned buffer may or may +not be lost (depending on the build) and so this function is only usable for +passing strings to legacy libraries that don't have const-correct API. Use +\helpref{wxStringBuffer}{wxstringbuffer} if you want to modify the string. + +\wxheading{See also} + +\helpref{mb\_str}{wxstringmbstr}, \helpref{wc\_str}{wxstringwcstr}, +\helpref{fn\_str}{wxstringfnstr}, \helpref{c\_str}{wxstringcstr}, +\helpref{char\_str}{wxstringcharstr} \membersection{wxString::operator!}\label{wxstringoperatornot} \constfunc{bool}{operator!}{\void} -Empty string is false, so !string will only return true if the string is empty. -This allows the tests for NULLness of a {\it const char *} pointer and emptiness +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 wxChar *} pointer and emptiness of the string to look the same in the code and makes it easier to port old code to wxString. @@ -1271,13 +1409,9 @@ See also \helpref{IsEmpty()}{wxstringisempty}. \func{wxString\&}{operator $=$}{\param{const wxString\&}{ str}} -\func{wxString\&}{operator $=$}{\param{const char*}{ psz}} - -\func{wxString\&}{operator $=$}{\param{char}{ c}} - -\func{wxString\&}{operator $=$}{\param{const unsigned char*}{ psz}} +\func{wxString\&}{operator $=$}{\param{const wxChar*}{ psz}} -\func{wxString\&}{operator $=$}{\param{const wchar\_t*}{ pwz}} +\func{wxString\&}{operator $=$}{\param{wxChar}{ c}} Assignment: the effect of each operation is the same as for the corresponding constructor (see \helpref{wxString constructors}{wxstringconstruct}). @@ -1290,20 +1424,20 @@ concatenation of the operands. \func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} -\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const char*}{ y}} +\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{const wxChar*}{ y}} -\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{char}{ y}} +\func{wxString}{operator $+$}{\param{const wxString\&}{ x}, \param{wxChar}{ y}} -\func{wxString}{operator $+$}{\param{const char*}{ x}, \param{const wxString\&}{ y}} +\func{wxString}{operator $+$}{\param{const wxChar*}{ x}, \param{const wxString\&}{ y}} \membersection{wxString::operator $+=$}\label{wxstringplusequal} \func{void}{operator $+=$}{\param{const wxString\&}{ str}} -\func{void}{operator $+=$}{\param{const char*}{ psz}} +\func{void}{operator $+=$}{\param{const wxChar*}{ psz}} -\func{void}{operator $+=$}{\param{char}{ c}} +\func{void}{operator $+=$}{\param{wxChar}{ c}} Concatenation in place: the argument is appended to the string. @@ -1332,9 +1466,9 @@ Same as Mid (substring extraction). \func{wxString\&}{operator \cinsert}{\param{const wxString\&}{ str}} -\func{wxString\&}{operator \cinsert}{\param{const char*}{ psz}} +\func{wxString\&}{operator \cinsert}{\param{const wxChar*}{ psz}} -\func{wxString\&}{operator \cinsert}{\param{char }{ch}} +\func{wxString\&}{operator \cinsert}{\param{wxChar }{ch}} Same as $+=$. @@ -1356,9 +1490,9 @@ value into the string. Precision or format cannot be set using them, you can use Extraction from a stream. -\membersection{wxString::operator const char*}\label{wxstringoperatorconstcharpt} +\membersection{wxString::operator const wxChar*}\label{wxstringoperatorconstcharpt} -\constfunc{}{operator const char*}{\void} +\constfunc{}{operator const wxChar*}{\void} Implicit conversion to a C string. @@ -1367,27 +1501,27 @@ Implicit conversion to a C string. \func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} -\func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} +\func{bool}{operator $==$}{\param{const wxString\&}{ x}, \param{const wxChar*}{ t}} \func{bool}{operator $!=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} -\func{bool}{operator $!=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} +\func{bool}{operator $!=$}{\param{const wxString\&}{ x}, \param{const wxChar*}{ t}} \func{bool}{operator $>$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} -\func{bool}{operator $>$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} +\func{bool}{operator $>$}{\param{const wxString\&}{ x}, \param{const wxChar*}{ t}} \func{bool}{operator $>=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} -\func{bool}{operator $>=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} +\func{bool}{operator $>=$}{\param{const wxString\&}{ x}, \param{const wxChar*}{ t}} \func{bool}{operator $<$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} -\func{bool}{operator $<$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} +\func{bool}{operator $<$}{\param{const wxString\&}{ x}, \param{const wxChar*}{ t}} \func{bool}{operator $<=$}{\param{const wxString\&}{ x}, \param{const wxString\&}{ y}} -\func{bool}{operator $<=$}{\param{const wxString\&}{ x}, \param{const char*}{ t}} +\func{bool}{operator $<=$}{\param{const wxString\&}{ x}, \param{const wxChar*}{ t}} \wxheading{Remarks}