X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c5e7a7d769a6ac2b9793591d02fc97c82fb7890a..242019eef3fdcdb12b5310da67af3ef6d15e0f58:/docs/latex/wx/wxstring.tex?ds=sidebyside diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 57504f03e6..cdd13d86b7 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: @@ -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. -\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. @@ -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. -\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. @@ -586,7 +590,7 @@ to a function expecting non-const pointer. \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 @@ -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}{ 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 @@ -980,9 +990,9 @@ 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 = 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} @@ -1194,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 -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} @@ -1209,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 -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 @@ -1249,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 -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}). @@ -1350,9 +1363,9 @@ UTF-8 build. \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} @@ -1371,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 -{\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}