removed wxListEvent::m_oldItemIndex from docs, it is not used for anything anyhow

[wxWidgets.git] / docs / latex / wx / wxstring.tex

diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index 94157dacf41dfb332cc48ec8c3a700df52ae80d7..9b1f85ca85fa2c336f0e1076e58187395f3a4d8b 100644 (file)
--- a/docs/latex/wx/wxstring.tex
+++ b/docs/latex/wx/wxstring.tex
@@ -314,7 +314,7 @@ their documentation.
     // find first n characters of sz
   size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const;
 
     // find first n characters of sz
   size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const;
 

-    // find the first occurence of character ch after nStart
+    // find the first occurrence of character ch after nStart

   size_t find(char ch, size_t nStart = 0) const;
 
     // rfind() family is exactly like find() but works right to left
   size_t find(char ch, size_t nStart = 0) const;
 
     // rfind() family is exactly like find() but works right to left


@@ -328,7 +328,7 @@ their documentation.
     // as find, but from the end
   size_t rfind(char ch, size_t nStart = npos) const;
 
     // as find, but from the end
   size_t rfind(char ch, size_t nStart = npos) const;
 

-    // find first/last occurence of any character in the set
+    // find first/last occurrence of any character in the set

 
     //
   size_t find_first_of(const wxString& str, size_t nStart = 0) const;
 
     //
   size_t find_first_of(const wxString& str, size_t nStart = 0) const;


@@ -343,7 +343,7 @@ their documentation.
     // same as rfind(char, size_t)
   size_t find_last_of (char c, size_t nStart = npos) const;
 
     // same as rfind(char, size_t)
   size_t find_last_of (char c, size_t nStart = npos) const;
 

-    // find first/last occurence of any character not in the set
+    // find first/last occurrence of any character not in the set

 
     //
   size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;
 
     //
   size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;


@@ -478,28 +478,28 @@ to it.
 
 \constfunc{wxString}{AfterFirst}{\param{char}{ ch}}
 
 
 \constfunc{wxString}{AfterFirst}{\param{char}{ ch}}
 

-Gets all the characters after the first occurence of {\it ch}.
+Gets all the characters after the first occurrence of {\it ch}.

 Returns the empty string if {\it ch} is not found.
 
 \membersection{wxString::AfterLast}\label{wxstringafterlast}
 
 \constfunc{wxString}{AfterLast}{\param{char}{ ch}}
 
 Returns the empty string if {\it ch} is not found.
 
 \membersection{wxString::AfterLast}\label{wxstringafterlast}
 
 \constfunc{wxString}{AfterLast}{\param{char}{ ch}}
 

-Gets all the characters after the last occurence of {\it ch}.
+Gets all the characters after the last occurrence of {\it ch}.

 Returns the whole string if {\it ch} is not found.
 
 \membersection{wxString::BeforeFirst}\label{wxstringbeforefirst}
 
 \constfunc{wxString}{BeforeFirst}{\param{char}{ ch}}
 
 Returns the whole string if {\it ch} is not found.
 
 \membersection{wxString::BeforeFirst}\label{wxstringbeforefirst}
 
 \constfunc{wxString}{BeforeFirst}{\param{char}{ ch}}
 

-Gets all characters before the first occurence of {\it ch}.
+Gets all characters before the first occurrence of {\it ch}.

 Returns the whole string if {\it ch} is not found.
 
 \membersection{wxString::BeforeLast}\label{wxstringbeforelast}
 
 \constfunc{wxString}{BeforeLast}{\param{char}{ ch}}
 
 Returns the whole string if {\it ch} is not found.
 
 \membersection{wxString::BeforeLast}\label{wxstringbeforelast}
 
 \constfunc{wxString}{BeforeLast}{\param{char}{ ch}}
 

-Gets all characters before the last occurence of {\it ch}.
+Gets all characters before the last occurrence of {\it ch}.

 Returns the empty string if {\it ch} is not found.
 
 \membersection{wxString::c\_str}\label{wxstringcstr}
 Returns the empty string if {\it ch} is not found.
 
 \membersection{wxString::c\_str}\label{wxstringcstr}


@@ -673,25 +673,25 @@ Returns the index of the first item matched, or NOT\_FOUND.
 
 \constfunc{bool}{IsAscii}{\void}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \membersection{wxString::IsSameAs}\label{wxstringissameas}
 


@@ -740,7 +740,7 @@ Returns the first {\it count} characters.
 
 \constfunc{wxString}{Left}{\param{char}{ ch}}
 
 
 \constfunc{wxString}{Left}{\param{char}{ ch}}
 

-Returns all characters before the first occurence of {\it ch}.
+Returns all characters before the first occurrence of {\it ch}.

 Returns the whole string if {\it ch} is not found.
 
 \membersection{wxString::Len}\label{wxstringlen}
 Returns the whole string if {\it ch} is not found.
 
 \membersection{wxString::Len}\label{wxstringlen}


@@ -845,9 +845,9 @@ Removes the last character.
 
 \func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = TRUE}}
 
 
 \func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = TRUE}}
 

-Replace first (or all) occurences of substring with another one.
+Replace first (or all) occurrences of substring with another one.

 
 

-{\it replaceAll}: global replace (default), or only the first occurence.
+{\it replaceAll}: global replace (default), or only the first occurrence.

 
 Returns the number of replacements made.
 
 
 Returns the number of replacements made.
 


@@ -901,7 +901,11 @@ doesn't change this string.
 
 \constfunc{wxString}{SubString}{\param{size\_t}{ from}, \param{size\_t}{ to}}
 
 
 \constfunc{wxString}{SubString}{\param{size\_t}{ from}, \param{size\_t}{ to}}
 

-Same as \helpref{Mid}{wxstringmid}.
+Deprecated, use \helpref{Mid}{wxstringmid} instead (but note that parameters
+have different meaning).
+
+Returns the part of the string between the indices {\it from} and {\it to}
+inclusive.

 
 \membersection{wxString::ToDouble}\label{wxstringtodouble}
 
 
 \membersection{wxString::ToDouble}\label{wxstringtodouble}
 


@@ -918,11 +922,17 @@ if the string does not represent such number.
 
 \membersection{wxString::ToLong}\label{wxstringtolong}
 
 
 \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 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 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.
+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}
 
 
 \wxheading{See also}
 


@@ -931,11 +941,17 @@ string does not represent such number.
 
 \membersection{wxString::ToULong}\label{wxstringtoulong}
 
 
 \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}
 
 
 \wxheading{See also}