added wxCheckBox::IsChecked() to wxMac and documented it

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

diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex
index 62f1f245e6c65125495bcd0071432a2a6826635c..611c3e8ad6d0b384f60dd3a1363d599d56c4dd01 100644 (file)
--- a/docs/latex/wx/arrstrng.tex
+++ b/docs/latex/wx/arrstrng.tex
@@ -80,6 +80,20 @@ reasons it is not virtual, so this class should not be derived from.
 
 Assignment operator.
 
 
 Assignment operator.
 

+\membersection{wxArrayString::operator==}\label{wxarraystringoperatorequal}
+
+\constfunc{bool}{operator $==$}{\param{const wxArrayString\&}{ array}}
+
+Compares 2 arrays respecting the case. Returns TRUE only if the arrays have
+the same number of elements and the same strings in the same order.
+
+\membersection{wxArrayString::operator!=}\label{wxarraystringoperatornotequal}
+
+\constfunc{bool}{operator $!=$}{\param{const wxArrayString\&}{ array}}
+
+Compares 2 arrays respecting the case. Returns TRUE if the arrays have
+different number of elements or if the elements don't match pairwise.
+

 \membersection{wxArrayString::operator[]}\label{wxarraystringoperatorindex}
 
 \func{wxString\&}{operator[]}{\param{size\_t }{nIndex}}
 \membersection{wxArrayString::operator[]}\label{wxarraystringoperatorindex}
 
 \func{wxString\&}{operator[]}{\param{size\_t }{nIndex}}


@@ -92,9 +106,10 @@ This is the operator version of \helpref{Item}{wxarraystringitem} method.
 
 \membersection{wxArrayString::Add}\label{wxarraystringadd}
 
 
 \membersection{wxArrayString::Add}\label{wxarraystringadd}
 

-\func{void}{Add}{\param{const wxString\& }{str}}
+\func{size\_t}{Add}{\param{const wxString\& }{str}, \param{size\_t}{ copies = $1$}}

 
 

-Appends a new item to the array.
+Appends the given number of {\it copies} of the new item {\it str} to the
+array and returns the index of the first new item in the array.

 
 {\bf Warning:} For sorted arrays, the index of the inserted item will not be,
 in general, equal to \helpref{GetCount()}{wxarraystringgetcount} - 1 because
 
 {\bf Warning:} For sorted arrays, the index of the inserted item will not be,
 in general, equal to \helpref{GetCount()}{wxarraystringgetcount} - 1 because


@@ -162,21 +177,21 @@ Returns index of the first item matched or wxNOT\_FOUND if there is no match.
 
 \membersection{wxArrayString::Insert}\label{wxarraystringinsert}
 
 
 \membersection{wxArrayString::Insert}\label{wxarraystringinsert}
 

-\func{void}{Insert}{\param{const wxString\& }{str}, \param{size\_t}{ nIndex}}
+\func{void}{Insert}{\param{const wxString\& }{str}, \param{size\_t}{ nIndex}, \param{size\_t }{copies = $1$}}

 
 

-Insert a new element in the array before the position {\it nIndex}. Thus, for
+Insert the given number of {\it copies} of the new element in the array before the position {\it nIndex}. Thus, for

 example, to insert the string in the beginning of the array you would write
 
 \begin{verbatim}
 Insert("foo", 0);
 \end{verbatim}
 
 example, to insert the string in the beginning of the array you would write
 
 \begin{verbatim}
 Insert("foo", 0);
 \end{verbatim}
 

-If {\it nIndex} is equal to {\it GetCount() + 1} this function behaves as 
+If {\it nIndex} is equal to {\it GetCount()} this function behaves as 

 \helpref{Add}{wxarraystringadd}.
 
 \helpref{Add}{wxarraystringadd}.
 

-{\bf Warning:} this function should not be used with sorted array because it
+{\bf Warning:} this function should not be used with sorted arrays because it

 could break the order of items and, for example, subsequent calls to 
 could break the order of items and, for example, subsequent calls to 

-\helpref{Index()}{wxarraystringindex} would not work then!
+\helpref{Index()}{wxarraystringindex} would then not work!

 
 \membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
 
 
 \membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
 


@@ -204,22 +219,18 @@ Returns the last element of the array. Attempt to access the last element of
 an empty array will result in assert failure in debug build, however no checks
 are done in release mode.
 
 an empty array will result in assert failure in debug build, however no checks
 are done in release mode.
 

-\membersection{wxArrayString::Remove (by value)}\label{wxarraystringremoveval}
+\membersection{wxArrayString::Remove}\label{wxarraystringremove}

 
 \func{void}{Remove}{\param{const char *}{ sz}}
 
 Removes the first item matching this value. An assert failure is provoked by
 an attempt to remove an element which does not exist in debug build.
 
 
 \func{void}{Remove}{\param{const char *}{ sz}}
 
 Removes the first item matching this value. An assert failure is provoked by
 an attempt to remove an element which does not exist in debug build.
 

-See also: \helpref{Index}{wxarraystringindex}, \helpref{Remove}{wxarraystringremove}
-
-\membersection{wxArrayString::Remove (by index)}\label{wxarraystringremove}
-
-\func{void}{Remove}{\param{size\_t }{nIndex}}
+See also: \helpref{Index}{wxarraystringindex}

 
 

-Removes the item at given position.
+\func{void}{Remove}{\param{size\_t }{nIndex}, \param{size\_t }{count = $1$}}

 
 

-See also: \helpref{Remove}{wxarraystringremoveval}
+Removes {\it count} items starting at position {\it nIndex} from the array.

 
 \membersection{wxArrayString::Shrink}\label{wxarraystringshrink}
 
 
 \membersection{wxArrayString::Shrink}\label{wxarraystringshrink}
 


@@ -230,26 +241,22 @@ minimize the array memory consumption.
 
 See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory management}{wxarraymemorymanagement}
 
 
 See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory management}{wxarraymemorymanagement}
 

-\membersection{wxArrayString::Sort (alphabetically)}\label{wxarraystringsort}
+\membersection{wxArrayString::Sort}\label{wxarraystringsort}

 
 \func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}}
 
 
 \func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}}
 

-Sorts the array in alphabetical order or in reverse alphabetical order if
+Sorts the array in alphabetical order or in reverse alphabetical order if 

 {\it reverseOrder} is TRUE.
 
 {\bf Warning:} this function should not be used with sorted array because it
 could break the order of items and, for example, subsequent calls to 
 {\it reverseOrder} is TRUE.
 
 {\bf Warning:} this function should not be used with sorted array because it
 could break the order of items and, for example, subsequent calls to 

-\helpref{Index()}{wxarraystringindex} would not work then!
-
-See also: \helpref{Sort}{wxarraystringsortcallback}
-
-\membersection{wxArrayString::Sort (user defined)}\label{wxarraystringsortcallback}
+\helpref{Index()}{wxarraystringindex} would then not work!

 
 \func{void}{Sort}{\param{CompareFunction }{compareFunction}}
 
 Sorts the array using the specified {\it compareFunction} for item comparison.
 {\it CompareFunction} is defined as a function taking two {\it const
 
 \func{void}{Sort}{\param{CompareFunction }{compareFunction}}
 
 Sorts the array using the specified {\it compareFunction} for item comparison.
 {\it CompareFunction} is defined as a function taking two {\it const

-wxString\&} parameters and returning {\it int} value less than, equal to or
+wxString\&} parameters and returning an {\it int} value less than, equal to or

 greater than 0 if the first string is less than, equal to or greater than the
 second one.
 
 greater than 0 if the first string is less than, equal to or greater than the
 second one.
 


@@ -277,7 +284,5 @@ array.Sort(CompareStringLen);
 
 {\bf Warning:} this function should not be used with sorted array because it
 could break the order of items and, for example, subsequent calls to 
 
 {\bf Warning:} this function should not be used with sorted array because it
 could break the order of items and, for example, subsequent calls to 

-\helpref{Index()}{wxarraystringindex} would not work then!
-
-See also: \helpref{Sort}{wxarraystringsort}
+\helpref{Index()}{wxarraystringindex} would then not work!