latex/wx/wxstring.tex

3 wxString is a class representing a character string. Please see the
6 As explained there, wxString implements most of the methods of the std::string
15 \helpref{Len()}{wxstringlen} and {\tt length()} which all return the string
16 length. In all cases of such duplication the {\tt std::string}-compatible
18 used as it will ensure smoother transition to {\tt std::string} when wxWidgets
27 <wx/string.h>
44 A string may be constructed either from a C string, (some number of copies of)
45 a single character or a wide (UNICODE) string. For all constructors (except the
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
68 Many functions in this section take a character index in the string. As with C
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
95 Anything may be concatenated (appended to) with a string. However, you can't
96 append something to a C string (including literal constants), so to do this it
122 doing direct string comparison as you would also have to precalculate the
135 These functions allow to extract substring from this string. All of them don't
136 modify the original string and return a new string containing the extracted
154 The MakeXXX() variants modify the string in place, while the other functions
155 return a new string which contains the original text converted to the upper or
156 lower case and leave the original string unchanged.
175 The string provides functions for conversion to signed and unsigned integer and
177 put the numeric value in and return \true if the {\bf entire} string could be
187 \membersection{Writing values into the string}\label{writingintostringinwxstring}
192 formatted value to a string:
219 operation on the string \helpref{UngetWriteBuf}{wxstringungetwritebuf} {\bf
230 Other string functions.
240 functions instead of them (or, even better, std::string compatible variants).
261 \membersection{std::string compatibility functions}\label{wxstringat}
272   // lib.string.capacity
273     // return the length of the string
275     // return the length of the string
277     // return the maximum size of the string
279     // resize the string, filling the space with c if c != 0
281     // delete the contents of the string
283     // returns true if the string is empty
286   // lib.string.access
292   // lib.string.modifiers
293     // append a string
312     // insert another string
394     // if the [sub]string is less, equal or greater than the compare() argument.
425 Default constructor. Initializes the string to {\tt ""} (empty string).
433 Constructs a string of {\it n} copies of character {\it ch}.
437 Takes first {\it nLength} characters from the C string {\it psz}.
438 The default value of {\tt wxSTRING\_MAXLEN} means to take all the string.
449 For compilers using unsigned char: takes first {\it nLength} characters from the C string {\it psz}.
450 The default value of {\tt wxSTRING\_MAXLEN} means take all the string.
455 The following constructors allow you to construct wxString from a wide string
456 in ANSI build or from a C string in Unicode build.
460 Initializes the string from first \arg{nLength} characters of wide string.
461 The default value of {\tt wxSTRING\_MAXLEN} means take all the string.
464 convert \arg{psz} to wide string. It is ignored in Unicode build.
468 Initializes the string from first \arg{nLength} characters of C string.
469 The default value of {\tt wxSTRING\_MAXLEN} means take all the string.
472 convert \arg{psz} to wide string. It is ignored in ANSI build.
492 may be used to increase speed when the string is constructed by repeated
497 // delete all vowels from the string
517 because it will avoid the need to reallocate string memory many times (in case
518 of long strings). Note that it does not set the maximal length of a string - it
520 does not truncate the existing string (use
529 Concatenates {\it psz} to this string, returning a reference to it.
533 Concatenates character {\it ch} to this string, {\it count} times, returning a reference
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.
573 Returns a pointer to the string data ({\tt const char*} in ANSI build,
579 \helpref{wchar\_string}{wxstringwcharstr} if you need to pass string value
592 Returns an object with string data that is implicitly convertible to
596 you want to modify the string.
610 Empties the string and frees memory occupied by it.
623 Returns a positive value if the string is greater than the argument, zero if
638 Returns a positive value if the string is greater than the argument, zero if
671 Makes the string empty, but doesn't free memory occupied by the string.
684 Searches for the given string. Returns the starting index, or {\tt wxNOT\_FOUND} if not found.
708 Returns string representation suitable for passing to OS' functions for
710 In Unicode build, returned value can be either wide character string
711 or C string in charset matching the {\tt wxConvFileName} object, depending on
724 This static function returns the string containing the result of calling
736 This static function returns the string containing the result of calling
748 Returns the number of occurrences of {\it ch} in the string.
758 Converts given buffer of binary data from 8-bit string to wxString. In Unicode
759 build, the string is interpreted as being in ISO-8859-1 encoding. The version
780 Converts the string or character from an ASCII, 7-bit form
793 Converts C string encoded in UTF-8 to wxString.
811 wxWidgets compatibility conversion. Returns a constant pointer to the data in the string.
830 to put the string back into a reasonable state.
848 Returns \true if the string contains only ASCII characters.
857 Returns \true if the string is empty.
864 Returns \true if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}).
873 Returns \true if the string is an integer (with possible sign).
882 Test for string equality, case-sensitive (default) or not.
892 Test whether the string is equal to the single character {\it c}. The test is
895 Returns \true if the string is equal to the character, \false otherwise.
904 Returns \true if the string is a word.
926 Returns the first {\it count} characters of the string.
933 Returns the length of the string.
940 Returns the length of the string (same as Len).
949 Returns this string converted to the lower case.
979 Returns \true if the string contents matches a mask containing '*' and '?'.
988 Returns multibyte (C string) representation of the string.
1006 the string if {\it count} is the default value.
1013 Adds {\it count} copies of {\it pad} to the beginning, or to the end of the string (the default).
1022 Prepends {\it str} to this string, returning a reference to this string.
1063 Same as Truncate. Removes the portion from {\it pos} to the end of the string.
1067 Removes {\it len} characters from the string, starting at {\it pos}.
1108 Minimizes the string's memory. This can be useful after a call to
1116 This function can be used to test if the string starts with the specified
1118 of the string (i.e. after the prefix) into {\it rest} string if it is not
1127 This function can be used to test if the string ends with the specified
1129 beginning of the string before the suffix into {\it rest} string if it is not
1143 doesn't change this string.
1152 Returns the part of the string between the indices {\it from} and {\it to}
1163 Converts the string to an 8-bit string (ANSI builds only).
1167 Converts the string to an 8-bit string in ISO-8859-1 encoding in the form of
1187 Converts the string to an ASCII, 7-bit string in the form of
1188 a wxCharBuffer (Unicode builds only) or a C string (ANSI builds).
1190 Note that this conversion only works if the string contains only ASCII
1192 powerful means of converting wxString to C string.
1199 Attempts to convert the string to a floating point number. Returns \true on
1201 if the string does not represent such number.
1213 Attempts to convert the string to a signed integer in base {\it base}. Returns
1215 pointed to by {\it val} or \false if the string does not represent a
1253 Attempts to convert the string to an unsigned integer in base {\it base}.
1255 location pointed to by {\it val} or \false if the string does not
1294 the left or from the right end of the string (right is default).
1301 Truncate the string to the given length.
1310 Puts the string back into a reasonable state (in which it can be used
1315 new string length itself assuming that the string is terminated by the first
1326 Returns this string converted to upper case.
1354 Returns wide character representation of the string.
1370 Returns an object with string data that is implicitly convertible to
1374 you want to modify the string.
1389 Empty string is \false, so !string will only return \true if the string is empty.
1391 of the string to look the same in the code and makes it easier to port old code
1411 Concatenation: all these operators return a new string equal to the
1431 Concatenation in place: the argument is appended to the string.
1471 value into the string. Precision or format cannot be set using them, you can use
1486 Implicit conversion to a C string.
1524 the string to the usable state later.
1552 <wx/string.h>
1561 Constructs a writable string buffer object associated with the given string
1571 Restores the string passed to the constructor to the usable state by calling
1588 the string to the usable state later, and allows the user to set the internal
1589 length of the string.
1594 of the string, you might call it like this:
1622 <wx/string.h>
1631 Constructs a writable string buffer object associated with the given string
1641 Restores the string passed to the constructor to the usable state by calling
1649 Sets the internal length of the string referred to by wxStringBufferLength to