X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b0b96f667dbc2fc2d3ebaa342c50bdea10f84a91..0bd2681966523df88ad5cf8e505b532843e58d74:/docs/latex/wx/wxstring.tex diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 76a8e11235..5016c78fbe 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -26,6 +26,10 @@ None +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{Predefined objects} Objects: @@ -213,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} @@ -455,7 +458,7 @@ For ANSI builds only (note the use of {\tt char} instead of {\tt wxChar}). 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. @@ -463,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} @@ -573,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{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{fn\_str}{wxstringfnstr}, \helpref{c\_str}{wxstringcstr}, +\helpref{wchar\_str}{wxstringwcharstr} \membersection{wxString::Clear}\label{wxstringclear} @@ -651,13 +677,13 @@ See also: \helpref{Clear()}{wxstringclear}. \membersection{wxString::Find}\label{wxstringfind} -\constfunc{int}{Find}{\param{wxChar}{ 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 {\tt wxNOT_FOUND} if not found. +Searches for the given character. Returns the starting index, or {\tt wxNOT\_FOUND} if not found. -\constfunc{int}{Find}{\param{const wxChar*}{ sz}} +\constfunc{int}{Find}{\param{const wxString\&}{ sub}} -Searches for the given string. Returns the starting index, or {\tt wxNOT_FOUND} if not found. +Searches for the given string. Returns the starting index, or {\tt wxNOT\_FOUND} if not found. \membersection{wxString::First}\label{wxstringfirst} @@ -725,12 +751,36 @@ 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 @@ -739,6 +789,19 @@ 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{wxChar}{GetChar}{\param{size\_t}{ n}} @@ -768,8 +831,12 @@ 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} @@ -916,16 +983,16 @@ Converts all characters to upper case and returns the result. \membersection{wxString::Matches}\label{wxstringmatches} -\constfunc{bool}{Matches}{\param{const wxChar*}{ szMask}} +\constfunc{bool}{Matches}{\param{const wxString\&}{ mask}} 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} @@ -937,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} @@ -1020,7 +1087,7 @@ Removes the last character. \membersection{wxString::Replace}\label{wxstringreplace} -\func{size\_t}{Replace}{\param{const wxChar*}{ szOld}, \param{const wxChar*}{ 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. @@ -1053,7 +1120,7 @@ Minimizes the string's memory. This can be useful after a call to \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 \true and put the rest @@ -1064,7 +1131,7 @@ of the string (i.e. after the prefix) into {\it rest} string if it is not \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 \true and put the @@ -1098,16 +1165,34 @@ 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 @@ -1199,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}} @@ -1231,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} @@ -1248,11 +1346,23 @@ 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} @@ -1264,7 +1374,23 @@ 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}