\membersection{Constructors and assignment operators}
-A strign may be constructed either from a C string, (some number of copies of)
+A string may be constructed either from a C string, (some number of copies of)
a single character or a wide (UNICODE) string. For all constructors (except the
default which creates an empty string) there is also a corresponding assignment
operator.
Many functions in this section take a character index in the string. As with C
strings and/or arrays, the indices start from $0$, so the first character of a
string is string[$0$]. Attempt to access a character beyond the end of the
-string (which may be even $0$ if the string is empty) will provocate an assert
+string (which may be even $0$ if the string is empty) will provoke an assert
failure in \helpref{debug build}{debuggingoverview}, but no checks are done in
release builds.
\helpref{StartsWith}{wxstringstartswith} is helpful when parsing a line of
text which should start with some predefined prefix and is more efficient than
-doing direct string comparaison as you would also have to precalculate the
+doing direct string comparison as you would also have to precalculate the
length of the prefix then.
\helpref{Cmp}{wxstringcmp}\\
\membersection{Case conversion}
The MakeXXX() variants modify the string in place, while the other functions
-return a new string which containts the original text converted to the upper or
+return a new string which contains the original text converted to the upper or
lower case and leave the original string unchanged.
\helpref{MakeUpper}{wxstringmakeupper}\\
\membersection{Memory management}
-These are "advanced" functions and they will be needed quite rarily.
+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
\constfunc{wxString}{Left}{\param{size\_t}{ count}}
-Returns the first {\it count} characters.
-
-\constfunc{wxString}{Left}{\param{char}{ ch}}
-
-Returns all characters before the first occurrence of {\it ch}.
-Returns the whole string if {\it ch} is not found.
+Returns the first {\it count} characters of the string.
\membersection{wxString::Len}\label{wxstringlen}
\membersection{wxString::ToLong}\label{wxstringtolong}
-\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = $0$}}
+\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = $10$}}
Attempts to convert the string to a signed integer in base {\it base}. Returns
{\tt TRUE} on success in which case the number is stored in the location
pointed to by {\it val} or {\tt FALSE} if the string does not represent a
valid number in the given base.
-The default value of {\it base} $0$ is special and means that the usual rules
-of {\tt C} numbers are applied: if the number starts with {\tt 0x} it is
-considered to be in base $16$, if it starts with {\tt 0} - in base $8$ and in
-base $10$ otherwise. Note that you may want to specify the base $10$ explicitly
-if you are parsing the numbers which may have leading zeroes as otherwise the
-string {\tt "09"} may not be parsed correctly: it would be understood as an
-octal number because of the leading zero and the parsing would then fail as
-{\tt '9'} is not a valid octal digit.
+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
+applied: if the number starts with {\tt 0x} it is considered to be in base
+$16$, if it starts with {\tt 0} - in base $8$ and in base $10$ otherwise. Note
+that you may not want to specify the base $0$ if you are parsing the numbers
+which may have leading zeroes as they can yield unexpected (to the user not
+familiar with C) results.
\wxheading{See also}
\membersection{wxString::ToULong}\label{wxstringtoulong}
-\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $0$}}
+\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $10$}}
Attempts to convert the string to a ansigned integer in base {\it base}.
Returns {\tt TRUE} on success in which case the number is stored in the
\func{}{wxStringBuffer}{\param{const wxString\& }{str}, \param{size\_t }{len}}
Constructs a writable string buffer object associated with the given string
-and containing enough space for at least {\it len} characters. Basicly, this
+and containing enough space for at least {\it len} characters. Basically, this
is equivalent to calling \helpref{GetWriteBuf}{wxstringgetwritebuf} and
saving the result.
projects / wxWidgets.git / blobdiff