]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/wxstring.tex
Added 2 extra macros to handle all the flavours of wxInt64 :(
[wxWidgets.git] / docs / latex / wx / wxstring.tex
index bf9a52fddcd2d887130ffd670abca539c97dc13d..9b1f85ca85fa2c336f0e1076e58187395f3a4d8b 100644 (file)
@@ -673,25 +673,25 @@ Returns the index of the first item matched, or NOT\_FOUND.
 
 \constfunc{bool}{IsAscii}{\void}
 
-Returns TRUE if the string is ASCII.
+Returns TRUE if the string contains only ASCII characters.
 
 \membersection{wxString::IsEmpty}\label{wxstringisempty}
 
 \constfunc{bool}{IsEmpty}{\void}
 
-Returns TRUE if the string is NULL.
+Returns TRUE if the string is empty.
 
 \membersection{wxString::IsNull}\label{wxstringisnull}
 
 \constfunc{bool}{IsNull}{\void}
 
-Returns TRUE if the string is NULL (same as IsEmpty).
+Returns TRUE if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}).
 
 \membersection{wxString::IsNumber}\label{wxstringisnumber}
 
 \constfunc{bool}{IsNumber}{\void}
 
-Returns TRUE if the string is a positive or negative integer. Will return FALSE for decimals.
+Returns TRUE if the string is an integer (with possible sign).
 
 \membersection{wxString::IsSameAs}\label{wxstringissameas}
 
@@ -922,11 +922,17 @@ if the string does not represent such number.
 
 \membersection{wxString::ToLong}\label{wxstringtolong}
 
-\constfunc{bool}{ToLong}{\param{long}{ *val}}
+\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = 0}}
 
-Attempts to convert the string to a signed integer. 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.
+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.
 
 \wxheading{See also}
 
@@ -935,11 +941,17 @@ string does not represent such number.
 
 \membersection{wxString::ToULong}\label{wxstringtoulong}
 
-\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}}
+\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = 0}}
+
+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
+location pointed to by {\it val} or {\tt FALSE} if the string does not
+represent a valid number in the given base.
 
-Attempts to convert the string to an unsigned integer. 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.
+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.
 
 \wxheading{See also}