latex/wx/wxstring.tex

3 wxString is a class representing a character string. Please see the
10 The behaviour of all these functions is identical to the behaviour described
46 default which creates an empty string) there is also a corresponding assignment
56 These functions return the string length and check whether the string is empty
70 string is string[$0$]. Attempt to access a character beyond the end of the
71 string (which may be even $0$ if the string is empty) will provoke an assert
76 strings. Although implicit conversion is quite convenient, it is advised to use
78 see \helpref{overview}{wxstringadvices} for the cases where it is necessary to
108 The default comparison function \helpref{Cmp}{wxstringcmp} is case-sensitive and
109 so is the default version of \helpref{IsSameAs}{wxstringissameas}. For case
111 give a second parameter to IsSameAs. This last function is may be more
113 \true value if the strings are the same and not 0 (which is usually false in C)
116 \helpref{Matches}{wxstringmatches} is a poor man's regular expression matcher:
120 \helpref{StartsWith}{wxstringstartswith} is helpful when parsing a line of
121 text which should start with some predefined prefix and is more efficient than
283     // returns true if the string is empty
340     // position to start the search on, the default value is 0. All functions
352     // rfind() family is exactly like find() but works right to left
394     // if the [sub]string is less, equal or greater than the compare() argument.
463 \helpref{WC2MB}{wxmbconvwc2mb} method is called to
464 convert \arg{psz} to wide string. It is ignored in Unicode build.
471 \helpref{MB2WC}{wxmbconvmb2wc} method is called to
472 convert \arg{psz} to wide string. It is ignored in ANSI build.
484 String destructor. Note that this is not virtual, so wxString must not be inherited from.
492 may be used to increase speed when the string is constructed by repeated
521 \helpref{Truncate()}{wxstringtruncate} for this) even if its current length is
542 Returns the empty string if {\it ch} is not found.
550 Returns the whole string if {\it ch} is not found.
558 Returns the whole string if {\it ch} is not found.
566 Returns the empty string if {\it ch} is not found.
592 Returns an object with string data that is implicitly convertible to
593 {\tt char*} pointer. Note that any change to the returned buffer is lost and so
594 this function is only usable for passing strings to legacy libraries that
623 Returns a positive value if the string is greater than the argument, zero if
624 it is equal to it or a negative value if it is less than the argument (same semantics
638 Returns a positive value if the string is greater than the argument, zero if
639 it is equal to it or a negative value if it is less than the argument (same semantics
655 This is a wxWidgets 1.xx compatibility function; use \helpref{Cmp}{wxstringcmp} instead.
664 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
697 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
709 file handling. In ANSI build, this is same as \helpref{c\_str}{wxstringcstr}.
750 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
759 build, the string is interpreted as being in ISO-8859-1 encoding. The version
762 This is a convenience method useful when storing binary data in
795 Note that this method assumes that \arg{s} is a valid UTF-8 sequence and
796 doesn't do any validation in release builds, it's validity is only checked in
841 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
850 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
857 Returns \true if the string is empty.
864 Returns \true if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}).
866 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
873 Returns \true if the string is an integer (with possible sign).
875 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
884 caseSensitive is \true by default (case matters).
892 Test whether the string is equal to the single character {\it c}. The test is
893 case-sensitive if {\it caseSensitive} is \true (default) or not if it is \false.
895 Returns \true if the string is equal to the character, \false otherwise.
904 Returns \true if the string is a word.
906 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
919 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
942 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
958 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
990 method and returns wxCharBuffer. In ANSI build, this function is same
992 The macro wxWX2MBbuf is defined as the correct return type (without const).
1006 the string if {\it count} is the default value.
1032 Note that if {\tt wxUSE\_PRINTF\_POS\_PARAMS} is set to 1, then this function supports
1047 size. Unfortunately, this function is not available on all platforms and the
1069 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
1118 of the string (i.e. after the prefix) into {\it rest} string if it is not
1129 beginning of the string before the suffix into {\it rest} string if it is not
1145 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
1155 This is a wxWidgets 1.xx compatibility function, use \helpref{Mid}{wxstringmid}
1170 This is a convenience method useful when storing binary data in
1171 wxString. It should be used {\it only} for this purpose. It is only valid
1200 success (the number is stored in the location pointed to by {\it val}) or \false
1214 \true on success in which case the number is stored in the location
1220 applied: if the number starts with {\tt 0x} it is considered to be in base
1236 This is exactly the same as \helpref{ToLong}{wxstringtolong} but works with 64
1240 bit numbers is not supported by the underlying C run-time library. Compilers
1254 Returns \true on success in which case the number is stored in the
1259 (e.g. $-1$ is returned as \texttt{ULONG\_MAX}).
1274 This is exactly the same as \helpref{ToULong}{wxstringtoulong} but works with 64
1294 the left or from the right end of the string (right is default).
1315 new string length itself assuming that the string is terminated by the first
1317 and thus is the only version which should be used with the strings with
1318 embedded {\tt NUL}s (it is also slightly more efficient as {\tt strlen()}
1335 This is a wxWidgets 1.xx compatibility function; you should not use it in new code.
1356 method and returns wxWCharBuffer. In Unicode build, this function is same
1358 The macro wxWX2WCbuf is defined as the correct return type (without const).
1370 Returns an object with string data that is implicitly convertible to
1371 {\tt char*} pointer. Note that any change to the returned buffer is lost and so
1372 this function is only usable for passing strings to legacy libraries that
1389 Empty string is \false, so !string will only return \true if the string is empty.
1405 Assignment: the effect of each operation is the same as for the corresponding
1431 Concatenation in place: the argument is appended to the string.
1477 \func{friend istream\&}{operator \cextract}{\param{istream\&}{ is}, \param{wxString\&}{ str}}
1535         wxLogError("Something is very wrong!");
1539 Note that the exact usage of this depends on whether on not wxUSE\_STL is enabled.  If
1540 wxUSE\_STL is enabled, wxStringBuffer creates a separate empty character buffer, and
1541 if wxUSE\_STL is disabled, it uses GetWriteBuf() from wxString, keeping the same buffer
1543 wxString data is probably not a good idea if you want to build your program in both
1563 is equivalent to calling \helpref{GetWriteBuf}{wxstringgetwritebuf} and
1603         wxLogError("Something is very wrong!");
1607 Note that the exact usage of this depends on whether on not wxUSE\_STL is enabled.  If
1608 wxUSE\_STL is enabled, wxStringBuffer creates a separate empty character buffer, and
1609 if wxUSE\_STL is disabled, it uses GetWriteBuf() from wxString, keeping the same buffer
1611 wxString data is probably not a good idea if you want to build your program in both
1633 is equivalent to calling \helpref{GetWriteBuf}{wxstringgetwritebuf} and