typo

[wxWidgets.git] / docs / latex / wx / wxstring.tex

diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index 3a35293c249189d2edd8b697b431f99050101ff9..cdd13d86b7b9ceec9e32ed6f9aa6bc72a6c81e70 100644 (file)
--- a/docs/latex/wx/wxstring.tex
+++ b/docs/latex/wx/wxstring.tex
@@ -26,6 +26,10 @@ None
 
 <wx/string.h>
 
 
 <wx/string.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{Predefined objects}
 
 Objects:
 \wxheading{Predefined objects}
 
 Objects:


@@ -454,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.
 
 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.
 
 Initializes the string from first \arg{nLength} characters of wide string. 
 The default value of {\tt wxSTRING\_MAXLEN} means take all the string.


@@ -462,7 +466,7 @@ 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.
 
 \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 = wxConvLibc}, \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.
 
 Initializes the string from first \arg{nLength} characters of C string.
 The default value of {\tt wxSTRING\_MAXLEN} means take all the string.


@@ -586,7 +590,7 @@ to a function expecting non-const pointer.
 
 \membersection{wxString::char\_str}\label{wxstringcharstr}
 
 
 \membersection{wxString::char\_str}\label{wxstringcharstr}
 

-\constfunc{wxWritableCharBuffer}{char\_str}{\param{wxMBConv\&}{ conv = wxConvLibc}}
+\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
 
 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


@@ -770,7 +774,13 @@ This is a convenience method useful when storing binary data in wxString.
 
 \func{static wxString }{FromAscii}{\param{const char*}{ s}}
 
 
 \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
 
 Converts the string or character from an ASCII, 7-bit form
 to the native wxString representation. Most useful when using


@@ -779,6 +789,19 @@ Use \helpref{wxString constructors}{wxstringconstruct} if you
 need to convert from another charset.
 
 
 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}}
 \membersection{wxString::GetChar}\label{wxstringgetchar}
 
 \constfunc{wxChar}{GetChar}{\param{size\_t}{ n}}


@@ -967,9 +990,9 @@ Returns \true if the string contents matches a mask containing '*' and '?'.
 
 \membersection{wxString::mb\_str}\label{wxstringmbstr}
 
 
 \membersection{wxString::mb\_str}\label{wxstringmbstr}
 

-\constfunc{const char*}{mb\_str}{\param{wxMBConv\&}{ conv = wxConvLibc}}
+\constfunc{const char*}{mb\_str}{\param{const wxMBConv\&}{ conv = wxConvLibc}}

 
 

-\constfunc{const wxCharBuffer}{mb\_str}{\param{wxMBConv\&}{ conv = wxConvLibc}}
+\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}
 
 Returns multibyte (C string) representation of the string.
 In Unicode build, converts using \arg{conv}'s \helpref{cWC2MB}{wxmbconvcwc2mb}


@@ -1097,7 +1120,7 @@ Minimizes the string's memory. This can be useful after a call to
 
 \membersection{wxString::StartsWith}\label{wxstringstartswith}
 
 
 \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
 
 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


@@ -1108,7 +1131,7 @@ of the string (i.e. after the prefix) into {\it rest} string if it is not
 
 \membersection{wxString::EndsWith}\label{wxstringendswith}
 
 
 \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
 
 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


@@ -1166,12 +1189,10 @@ This is a convenience method useful when storing binary data in wxString.
 
 \constfunc{const char*}{ToAscii}{\void}
 
 
 \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
 \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
 
 Note that this conversion only works if the string contains only ASCII
 characters. The \helpref{mb\_str}{wxstringmbstr} method provides more


@@ -1183,8 +1204,9 @@ 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
 \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.
+success (the number is stored in the location pointed to by \arg{val}) or \false
+if the string does not represent such number (the value of \arg{val} is not
+modified in this case).

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -1198,8 +1220,9 @@ if the string does not represent such number.
 
 Attempts to convert the string to a signed integer in base {\it base}. Returns
 \true on success in which case the number is stored in the location
 
 Attempts to convert the string to a signed integer in base {\it base}. 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.
+pointed to by \arg{val} or \false if the string does not represent a
+valid number in the given base (the value of \arg{val} is not modified
+in this case).

 
 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
 
 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


@@ -1238,8 +1261,9 @@ with C99 support and Microsoft Visual C++ version 7 and higher do support this.
 
 Attempts to convert the string to an unsigned integer in base {\it base}.
 Returns \true on success in which case the number is stored in the
 
 Attempts to convert the string to an unsigned integer in base {\it base}.
 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
+location pointed to by \arg{val} or \false if the string does not
+represent a valid number in the given base (the value of \arg{val} is not
+modified in this case). 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}).
 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}).


@@ -1263,6 +1287,15 @@ bit integer numbers.
 Please see \helpref{ToLongLong}{wxstringtolonglong} for additional remarks.
 
 
 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}}
 \membersection{wxString::Trim}\label{wxstringtrim}
 
 \func{wxString\&}{Trim}{\param{bool}{ fromRight = true}}


@@ -1316,11 +1349,23 @@ The same as MakeUpper.
 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
 
 
 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}
 
 \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}
 
 Returns wide character representation of the string.
 In ANSI build, converts using \arg{conv}'s \helpref{cMB2WC}{wxmbconvcmb2wc}


@@ -1339,10 +1384,10 @@ The macro wxWX2WCbuf is defined as the correct return type (without const).
 \constfunc{wxWritableWCharBuffer}{wchar\_str}{\void}
 
 Returns an object with string data that is implicitly convertible to
 \constfunc{wxWritableWCharBuffer}{wchar\_str}{\void}
 
 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.
+{\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}
 
 
 \wxheading{See also}