Added logic, API and docs for wxDataViewModel::HasDefaultCompare indicating a compare...

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

diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex
index e449ca6ad829b3b7eb4ad1f505447ae249c72ed8..7bd807ecad02c48c42173fa1e6f2f8127658a95a 100644 (file)
--- a/docs/latex/wx/array.tex
+++ b/docs/latex/wx/array.tex
@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        array.tex
+%% Purpose:     wxArray
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+

 \section{\class{wxArray}}\label{wxarray}
 
 This section describes the so called {\it dynamic arrays}. This is a C
 \section{\class{wxArray}}\label{wxarray}
 
 This section describes the so called {\it dynamic arrays}. This is a C


@@ -22,7 +33,7 @@ but the price is preallocating the memory in advance. In the \helpref{memory man
 you may find some useful hints about optimizing wxArray memory usage. As for executable size, all
 wxArray functions are inline, so they do not take {\it any space at all}.
 
 you may find some useful hints about optimizing wxArray memory usage. As for executable size, all
 wxArray functions are inline, so they do not take {\it any space at all}.
 

-wxWindows has three different kinds of array. All of them derive from
+wxWidgets has three different kinds of array. All of them derive from

 wxBaseArray class which works with untyped data and can not be used directly.
 The standard macros WX\_DEFINE\_ARRAY(), WX\_DEFINE\_SORTED\_ARRAY() and
 WX\_DEFINE\_OBJARRAY() are used to define a new class deriving from it. The
 wxBaseArray class which works with untyped data and can not be used directly.
 The standard macros WX\_DEFINE\_ARRAY(), WX\_DEFINE\_SORTED\_ARRAY() and
 WX\_DEFINE\_OBJARRAY() are used to define a new class deriving from it. The


@@ -39,19 +50,18 @@ deleted when the element is removed from the array. It should be noted that
 all of wxArray's functions are inline, so it costs strictly nothing to define as
 many array types as you want (either in terms of the executable size or the
 speed) as long as at least one of them is defined and this is always the case
 all of wxArray's functions are inline, so it costs strictly nothing to define as
 many array types as you want (either in terms of the executable size or the
 speed) as long as at least one of them is defined and this is always the case

-because wxArrays are used by wxWindows internally. This class has one serious
+because wxArrays are used by wxWidgets internally. This class has one serious

 limitation: it can only be used for storing integral types (bool, char, short,
 int, long and their unsigned variants) or pointers (of any kind). An attempt
 to use with objects of sizeof() greater than sizeof(long) will provoke a
 runtime assertion failure, however declaring a wxArray of floats will not (on
 the machines where sizeof(float) <= sizeof(long)), yet it will {\bf not} work,
 limitation: it can only be used for storing integral types (bool, char, short,
 int, long and their unsigned variants) or pointers (of any kind). An attempt
 to use with objects of sizeof() greater than sizeof(long) will provoke a
 runtime assertion failure, however declaring a wxArray of floats will not (on
 the machines where sizeof(float) <= sizeof(long)), yet it will {\bf not} work,

-please use wxObjArray for storing floats and doubles (NB: a more efficient
-wxArrayDouble class is scheduled for the next release of wxWindows).
+please use wxObjArray for storing floats and doubles.

 
 wxSortedArray is a wxArray variant which should be used when searching in the
 array is a frequently used operation. It requires you to define an additional
 function for comparing two elements of the array element type and always stores
 
 wxSortedArray is a wxArray variant which should be used when searching in the
 array is a frequently used operation. It requires you to define an additional
 function for comparing two elements of the array element type and always stores

-its items in the sorted order (according to this function). Thus, it's 
+its items in the sorted order (according to this function). Thus, it is

  \helpref{Index()}{wxarrayindex} function execution time is $O(log(N))$ instead of
 $O(N)$ for the usual arrays but the \helpref{Add()}{wxarrayadd} method is
 slower: it is $O(log(N))$ instead of constant time (neglecting time spent in
  \helpref{Index()}{wxarrayindex} function execution time is $O(log(N))$ instead of
 $O(N)$ for the usual arrays but the \helpref{Add()}{wxarrayadd} method is
 slower: it is $O(log(N))$ instead of constant time (neglecting time spent in


@@ -75,7 +85,7 @@ example:
 \begin{verbatim}
 #include <wx/dynarray.h>
 
 \begin{verbatim}
 #include <wx/dynarray.h>
 

-// we must forward declare the array because it's used inside the class
+// we must forward declare the array because it is used inside the class

 // declaration
 class MyDirectory;
 class MyFile;
 // declaration
 class MyDirectory;
 class MyFile;


@@ -97,7 +107,7 @@ class MyDirectory
 // now that we have MyDirectory declaration in scope we may finish the
 // definition of ArrayOfDirectories -- note that this expands into some C++
 // code and so should only be compiled once (i.e., don't put this in the
 // now that we have MyDirectory declaration in scope we may finish the
 // definition of ArrayOfDirectories -- note that this expands into some C++
 // code and so should only be compiled once (i.e., don't put this in the

-// header, but into a source file or you will get linkin errors)
+// header, but into a source file or you will get linking errors)

 #include <wx/arrimpl.cpp> // this is a magic incantation which must be done!
 WX_DEFINE_OBJARRAY(ArrayOfDirectories);
 
 #include <wx/arrimpl.cpp> // this is a magic incantation which must be done!
 WX_DEFINE_OBJARRAY(ArrayOfDirectories);
 


@@ -106,7 +116,7 @@ WX_DEFINE_OBJARRAY(ArrayOfDirectories);
 
 It is not as elegant as writing
 
 
 It is not as elegant as writing
 

-\begin{verbatim} 
+\begin{verbatim}

 typedef std::vector<MyDirectory> ArrayOfDirectories;
 \end{verbatim}
 
 typedef std::vector<MyDirectory> ArrayOfDirectories;
 \end{verbatim}
 


@@ -116,23 +126,38 @@ dumb, C++ compiler in the world.
 Things are much simpler for wxArray and wxSortedArray however: it is enough
 just to write
 
 Things are much simpler for wxArray and wxSortedArray however: it is enough
 just to write
 

-\begin{verbatim} 
-WX_DEFINE_ARRAY(MyDirectory *, ArrayOfDirectories);
-WX_DEFINE_SORTED_ARRAY(MyFile *, ArrayOfFiles);
+\begin{verbatim}
+WX_DEFINE_ARRAY_INT(int, ArrayOfInts);
+WX_DEFINE_SORTED_ARRAY_INT(int, ArrayOfSortedInts);

 \end{verbatim}
 
 \end{verbatim}
 

-\wxheading{See also:}
+i.e. there is only one {\tt DEFINE} macro and no need for separate
+{\tt DECLARE} one. For the arrays of the primitive types, the macros 
+{\tt WX\_DEFINE\_ARRAY\_CHAR/SHORT/INT/SIZE\_T/LONG/DOUBLE} should be used
+depending on the sizeof of the values (notice that storing values of smaller
+type, e.g. shorts, in an array of larger one, e.g. {\tt ARRAY\_INT}, does
+\emph{not} work on all architectures!).
+
+
+\wxheading{See also}

 
 \helpref{Container classes overview}{wxcontaineroverview}, \helpref{wxList}{wxlist}
 
 
 \helpref{Container classes overview}{wxcontaineroverview}, \helpref{wxList}{wxlist}
 

-\wxheading{Required headers:}
+\wxheading{Include files}

 
 <wx/dynarray.h> for wxArray and wxSortedArray and additionally <wx/arrimpl.cpp>
 for wxObjArray.
 
 
 <wx/dynarray.h> for wxArray and wxSortedArray and additionally <wx/arrimpl.cpp>
 for wxObjArray.
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
+
+
+

 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 

-\membersection{Macros for template array definition}
+\membersection{Macros for template array definition}\label{arraymacros}

 
 To use an array you must first define the array class. This is done with the
 help of the macros in this section. The class of array elements must be (at
 
 To use an array you must first define the array class. This is done with the
 help of the macros in this section. The class of array elements must be (at


@@ -141,11 +166,51 @@ WX\_DECLARE\_OBJARRAY macros and must be fully declared before you use
 WX\_DEFINE\_OBJARRAY macro.
 
 \helpref{WX\_DEFINE\_ARRAY}{wxdefinearray}\\
 WX\_DEFINE\_OBJARRAY macro.
 
 \helpref{WX\_DEFINE\_ARRAY}{wxdefinearray}\\

+\helpref{WX\_DEFINE\_EXPORTED\_ARRAY}{wxdefinearray}\\
+\helpref{WX\_DEFINE\_USER\_EXPORTED\_ARRAY}{wxdefinearray}\\

 \helpref{WX\_DEFINE\_SORTED\_ARRAY}{wxdefinesortedarray}\\
 \helpref{WX\_DEFINE\_SORTED\_ARRAY}{wxdefinesortedarray}\\

-\helpref{WX\_DECLARE\_OBJARRAY}{wxdeclareobjarray}\\
-\helpref{WX\_DEFINE\_OBJARRAY}{wxdefineobjarray}
+\helpref{WX\_DEFINE\_SORTED\_EXPORTED\_ARRAY}{wxdefinesortedarray}\\
+\helpref{WX\_DEFINE\_SORTED\_USER\_EXPORTED\_ARRAY}{wxdefinesortedarray}\\
+\helpref{WX\_DECLARE\_EXPORTED\_OBJARRAY}{wxdeclareobjarray}\\
+\helpref{WX\_DECLARE\_USER\_EXPORTED\_OBJARRAY}{wxdeclareobjarray}\\
+\helpref{WX\_DEFINE\_OBJARRAY}{wxdefineobjarray}\\
+\helpref{WX\_DEFINE\_EXPORTED\_OBJARRAY}{wxdefineobjarray}\\
+\helpref{WX\_DEFINE\_USER\_EXPORTED\_OBJARRAY}{wxdefineobjarray}
+
+To slightly complicate the matters even further, the operator $->$ defined by
+default for the array iterators by these macros only makes sense if the array
+element type is not a pointer itself and, although it still works, this
+provokes warnings from some compilers and to avoid them you should use the
+{\tt \_PTR} versions of the macros above. For example, to define an array of
+pointers to {\tt double} you should use:

 
 

-\membersection{Constructors and destructors}
+\begin{verbatim}
+WX_DEFINE_ARRAY_PTR(double *, MyArrayOfDoublePointers);
+\end{verbatim}
+
+Note that the above macros are generally only useful for
+wxObject types.  There are separate macros for declaring an array of a simple type,
+such as an int.
+
+The following simple types are supported:\\
+int\\
+long\\
+size\_t\\
+double
+
+To create an array of a simple type, simply append the type you want in CAPS to
+the array definition.
+
+For example, for an integer array, you'd use one of the following variants:
+
+\helpref{WX\_DEFINE\_ARRAY\_INT}{wxdefinearray}\\
+\helpref{WX\_DEFINE\_EXPORTED\_ARRAY\_INT}{wxdefinearray}\\
+\helpref{WX\_DEFINE\_USER\_EXPORTED\_ARRAY\_INT}{wxdefinearray}\\
+\helpref{WX\_DEFINE\_SORTED\_ARRAY\_INT}{wxdefinesortedarray}\\
+\helpref{WX\_DEFINE\_SORTED\_EXPORTED\_ARRAY\_INT}{wxdefinesortedarray}\\
+\helpref{WX\_DEFINE\_SORTED\_USER\_EXPORTED\_ARRAY\_INT}{wxdefinesortedarray}\\
+
+\membersection{Constructors and destructors}\label{arrayconstructorsdestructors}

 
 Array classes are 100\% C++ objects and as such they have the appropriate copy
 constructors and assignment operators. Copying wxArray just copies the elements
 
 Array classes are 100\% C++ objects and as such they have the appropriate copy
 constructors and assignment operators. Copying wxArray just copies the elements


@@ -170,7 +235,7 @@ amount, but no more than some maximal number which is defined by
 ARRAY\_MAXSIZE\_INCREMENT constant. Of course, this may lead to some memory
 being wasted (ARRAY\_MAXSIZE\_INCREMENT in the worst case, i.e. 4Kb in the
 current implementation), so the \helpref{Shrink()}{wxarrayshrink} function is
 ARRAY\_MAXSIZE\_INCREMENT constant. Of course, this may lead to some memory
 being wasted (ARRAY\_MAXSIZE\_INCREMENT in the worst case, i.e. 4Kb in the
 current implementation), so the \helpref{Shrink()}{wxarrayshrink} function is

-provided to unallocate the extra memory. The \helpref{Alloc()}{wxarrayalloc} 
+provided to deallocate the extra memory. The \helpref{Alloc()}{wxarrayalloc}

 function can also be quite useful if you know in advance how many items you are
 going to put in the array and will prevent the array code from reallocating the
 memory more times than needed.
 function can also be quite useful if you know in advance how many items you are
 going to put in the array and will prevent the array code from reallocating the
 memory more times than needed.


@@ -178,25 +243,26 @@ memory more times than needed.
 \helpref{Alloc}{wxarrayalloc}\\
 \helpref{Shrink}{wxarrayshrink}
 
 \helpref{Alloc}{wxarrayalloc}\\
 \helpref{Shrink}{wxarrayshrink}
 

-\membersection{Number of elements and simple item access}
+\membersection{Number of elements and simple item access}\label{arrayelementsaccess}

 
 Functions in this section return the total number of array elements and allow to
 retrieve them - possibly using just the C array indexing $[]$ operator which
 does exactly the same as \helpref{Item()}{wxarrayitem} method.
 
 
 Functions in this section return the total number of array elements and allow to
 retrieve them - possibly using just the C array indexing $[]$ operator which
 does exactly the same as \helpref{Item()}{wxarrayitem} method.
 

-\helpref{Count}{wxarraycount}\\

 \helpref{GetCount}{wxarraygetcount}\\
 \helpref{IsEmpty}{wxarrayisempty}\\
 \helpref{Item}{wxarrayitem}\\
 \helpref{Last}{wxarraylast}
 
 \helpref{GetCount}{wxarraygetcount}\\
 \helpref{IsEmpty}{wxarrayisempty}\\
 \helpref{Item}{wxarrayitem}\\
 \helpref{Last}{wxarraylast}
 

-\membersection{Adding items}
+\membersection{Adding items}\label{arrayadding}

 
 \helpref{Add}{wxarrayadd}\\
 \helpref{Insert}{wxarrayinsert}\\
 
 \helpref{Add}{wxarrayadd}\\
 \helpref{Insert}{wxarrayinsert}\\

-\helpref{WX\_APPEND\_ARRAY}{wxappendarray}
+\helpref{SetCount}{wxarraysetcount}\\
+\helpref{WX\_APPEND\_ARRAY}{wxappendarray}\\
+\helpref{WX\_PREPEND\_ARRAY}{wxprependarray}

 
 

-\membersection{Removing items}
+\membersection{Removing items}\label{arrayremoving}

 
 \helpref{WX\_CLEAR\_ARRAY}{wxcleararray}\\
 \helpref{Empty}{wxarrayempty}\\
 
 \helpref{WX\_CLEAR\_ARRAY}{wxcleararray}\\
 \helpref{Empty}{wxarrayempty}\\


@@ -204,7 +270,7 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method.
 \helpref{RemoveAt}{wxarrayremoveat}\\
 \helpref{Remove}{wxarrayremove}
 
 \helpref{RemoveAt}{wxarrayremoveat}\\
 \helpref{Remove}{wxarrayremove}
 

-\membersection{Searching and sorting}
+\membersection{Searching and sorting}\label{arraysearchingandsorting}

 
 \helpref{Index}{wxarrayindex}\\
 \helpref{Sort}{wxarraysort}
 
 \helpref{Index}{wxarrayindex}\\
 \helpref{Sort}{wxarraysort}


@@ -220,35 +286,53 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method.
 
 \func{}{WX\_DEFINE\_ARRAY}{\param{}{T}, \param{}{name}}
 
 
 \func{}{WX\_DEFINE\_ARRAY}{\param{}{T}, \param{}{name}}
 

+\func{}{WX\_DEFINE\_EXPORTED\_ARRAY}{\param{}{T}, \param{}{name}}
+
+\func{}{WX\_DEFINE\_USER\_EXPORTED\_ARRAY}{\param{}{T}, \param{}{name}, \param{}{exportspec}}
+

 This macro defines a new array class named {\it name} and containing the
 This macro defines a new array class named {\it name} and containing the

-elements of type {\it T}. Example:
+elements of type {\it T}. The second form is used when compiling wxWidgets as
+a DLL under Windows and array needs to be visible outside the DLL.  The third is
+needed for exporting an array from a user DLL.
+
+Example:

 
 \begin{verbatim}
 
 \begin{verbatim}

-WX_DEFINE_ARRAY(int, wxArrayInt);
+WX_DEFINE_ARRAY_INT(int, MyArrayInt);

 
 class MyClass;
 
 class MyClass;

-WX_DEFINE_ARRAY(MyClass *, wxArrayOfMyClass);
+WX_DEFINE_ARRAY(MyClass *, ArrayOfMyClass);

 \end{verbatim}
 
 \end{verbatim}
 

-Note that wxWindows predefines the following standard array classes: wxArrayInt,
-wxArrayLong and wxArrayPtrVoid.
+Note that wxWidgets predefines the following standard array classes: {\bf wxArrayInt},
+{\bf wxArrayLong}, {\bf wxArrayShort}, {\bf wxArrayDouble},  {\bf wxArrayPtrVoid}.
+

 
 \membersection{WX\_DEFINE\_SORTED\_ARRAY}\label{wxdefinesortedarray}
 
 \func{}{WX\_DEFINE\_SORTED\_ARRAY}{\param{}{T}, \param{}{name}}
 
 
 \membersection{WX\_DEFINE\_SORTED\_ARRAY}\label{wxdefinesortedarray}
 
 \func{}{WX\_DEFINE\_SORTED\_ARRAY}{\param{}{T}, \param{}{name}}
 

+\func{}{WX\_DEFINE\_SORTED\_EXPORTED\_ARRAY}{\param{}{T}, \param{}{name}}
+
+\func{}{WX\_DEFINE\_SORTED\_USER\_EXPORTED\_ARRAY}{\param{}{T}, \param{}{name}}
+

 This macro defines a new sorted array class named {\it name} and containing
 This macro defines a new sorted array class named {\it name} and containing

-the elements of type {\it T}. Example:
+the elements of type {\it T}. The second form is used when compiling wxWidgets as
+a DLL under Windows and array needs to be visible outside the DLL.  The third is
+needed for exporting an array from a user DLL.
+
+Example:

 
 \begin{verbatim}
 
 \begin{verbatim}

-WX_DEFINE_SORTED_ARRAY(int, wxSortedArrayInt);
+WX_DEFINE_SORTED_ARRAY_INT(int, MySortedArrayInt);

 
 class MyClass;
 
 class MyClass;

-WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass);
+WX_DEFINE_SORTED_ARRAY(MyClass *, ArrayOfMyClass);

 \end{verbatim}
 
 \end{verbatim}
 

-You will have to initialize the objects of this class by passing a comparaison
+You will have to initialize the objects of this class by passing a comparison

 function to the array object constructor like this:
 function to the array object constructor like this:

+

 \begin{verbatim}
 int CompareInts(int n1, int n2)
 {
 \begin{verbatim}
 int CompareInts(int n1, int n2)
 {


@@ -270,12 +354,20 @@ wxArrayOfMyClass another(CompareMyClassObjects);
 
 \func{}{WX\_DECLARE\_OBJARRAY}{\param{}{T}, \param{}{name}}
 
 
 \func{}{WX\_DECLARE\_OBJARRAY}{\param{}{T}, \param{}{name}}
 

+\func{}{WX\_DECLARE\_EXPORTED\_OBJARRAY}{\param{}{T}, \param{}{name}}
+
+\func{}{WX\_DECLARE\_USER\_EXPORTED\_OBJARRAY}{\param{}{T}, \param{}{name}}
+

 This macro declares a new object array class named {\it name} and containing
 This macro declares a new object array class named {\it name} and containing

-the elements of type {\it T}. Example:
+the elements of type {\it T}. The second form is used when compiling wxWidgets as
+a DLL under Windows and array needs to be visible outside the DLL.  The third is
+needed for exporting an array from a user DLL.
+
+Example:

 
 \begin{verbatim}
 class MyClass;
 
 \begin{verbatim}
 class MyClass;

-WX_DEFINE_OBJARRAY(MyClass, wxArrayOfMyClass); // note: not "MyClass *"!
+WX_DECLARE_OBJARRAY(MyClass, wxArrayOfMyClass); // note: not "MyClass *"!

 \end{verbatim}
 
 You must use \helpref{WX\_DEFINE\_OBJARRAY()}{wxdefineobjarray} macro to define
 \end{verbatim}
 
 You must use \helpref{WX\_DEFINE\_OBJARRAY()}{wxdefineobjarray} macro to define


@@ -285,14 +377,19 @@ the array class - otherwise you would get link errors.
 
 \func{}{WX\_DEFINE\_OBJARRAY}{\param{}{name}}
 
 
 \func{}{WX\_DEFINE\_OBJARRAY}{\param{}{name}}
 

-This macro defines the methods of the array class {\it name} not defined by the 
+\func{}{WX\_DEFINE\_EXPORTED\_OBJARRAY}{\param{}{name}}
+
+\func{}{WX\_DEFINE\_USER\_EXPORTED\_OBJARRAY}{\param{}{name}}
+
+This macro defines the methods of the array class {\it name} not defined by the

 \helpref{WX\_DECLARE\_OBJARRAY()}{wxdeclareobjarray} macro. You must include the
 file <wx/arrimpl.cpp> before using this macro and you must have the full
 \helpref{WX\_DECLARE\_OBJARRAY()}{wxdeclareobjarray} macro. You must include the
 file <wx/arrimpl.cpp> before using this macro and you must have the full

-declaration of the class of array elements in scope! If you forget to do the 
+declaration of the class of array elements in scope! If you forget to do the

 first, the error will be caught by the compiler, but, unfortunately, many
 compilers will not give any warnings if you forget to do the second - but the
 objects of the class will not be copied correctly and their real destructor will
 first, the error will be caught by the compiler, but, unfortunately, many
 compilers will not give any warnings if you forget to do the second - but the
 objects of the class will not be copied correctly and their real destructor will

-not be called.
+not be called.  The latter two forms are merely aliases of the first to satisfy
+some people's sense of symmetry when using the exported declarations.

 
 Example of usage:
 
 
 Example of usage:
 


@@ -316,7 +413,14 @@ WX_DEFINE_OBJARRAY(wxArrayOfMyClass);
 
 \func{void}{WX\_APPEND\_ARRAY}{\param{wxArray\& }{array}, \param{wxArray\& }{other}}
 
 
 \func{void}{WX\_APPEND\_ARRAY}{\param{wxArray\& }{array}, \param{wxArray\& }{other}}
 

-This macro may be used to append all elements of the {\it other} array to the 
+This macro may be used to append all elements of the {\it other} array to the
+{\it array}. The two arrays must be of the same type.
+
+\membersection{WX\_PREPEND\_ARRAY}\label{wxprependarray}
+
+\func{void}{WX\_PREPEND\_ARRAY}{\param{wxArray\& }{array}, \param{wxArray\& }{other}}
+
+This macro may be used to prepend all elements of the {\it other} array to the

 {\it array}. The two arrays must be of the same type.
 
 \membersection{WX\_CLEAR\_ARRAY}\label{wxcleararray}
 {\it array}. The two arrays must be of the same type.
 
 \membersection{WX\_CLEAR\_ARRAY}\label{wxcleararray}


@@ -338,7 +442,7 @@ Default constructor initializes an empty array object.
 \func{}{wxSortedArray}{\param{int (*)(T first, T second)}{compareFunction}}
 
 There is no default constructor for wxSortedArray classes - you must initialize it
 \func{}{wxSortedArray}{\param{int (*)(T first, T second)}{compareFunction}}
 
 There is no default constructor for wxSortedArray classes - you must initialize it

-with a function to use for item comparaison. It is a function which is passed
+with a function to use for item comparison. It is a function which is passed

 two arguments of type {\it T} where {\it T} is the array element type and which
 should return a negative, zero or positive value according to whether the first
 element passed to it is less than, equal to or greater than the second one.
 two arguments of type {\it T} where {\it T} is the array element type and which
 should return a negative, zero or positive value according to whether the first
 element passed to it is less than, equal to or greater than the second one.


@@ -371,19 +475,19 @@ the array element are copied too) for wxObjArray.
 \func{}{\destruct{wxObjArray}}{\void}
 
 The wxObjArray destructor deletes all the items owned by the array. This is not
 \func{}{\destruct{wxObjArray}}{\void}
 
 The wxObjArray destructor deletes all the items owned by the array. This is not

-done by wxArray and wxSortedArray versions - you may use 
+done by wxArray and wxSortedArray versions - you may use

 \helpref{WX\_CLEAR\_ARRAY}{wxcleararray} macro for this.
 
 \membersection{wxArray::Add}\label{wxarrayadd}
 
 \helpref{WX\_CLEAR\_ARRAY}{wxcleararray} macro for this.
 
 \membersection{wxArray::Add}\label{wxarrayadd}
 

-\func{void}{Add}{\param{T }{item}}
+\func{void}{Add}{\param{T }{item}, \param{size\_t}{ copies = $1$}}

 
 \func{void}{Add}{\param{T *}{item}}
 
 
 \func{void}{Add}{\param{T *}{item}}
 

-\func{void}{Add}{\param{T \&}{item}}
+\func{void}{Add}{\param{T \&}{item}, \param{size\_t}{ copies = $1$}}

 
 

-Appends a new element to the array (where {\it T} is the type of the array
-elements.)
+Appends the given number of {\it copies} of the {\it item} to the array
+consisting of the elements of type {\it T}.

 
 The first version is used with wxArray and wxSortedArray. The second and the
 third are used with wxObjArray. There is an important difference between
 
 The first version is used with wxArray and wxSortedArray. The second and the
 third are used with wxObjArray. There is an important difference between


@@ -391,10 +495,14 @@ them: if you give a pointer to the array, it will take ownership of it, i.e.
 will delete it when the item is deleted from the array. If you give a reference
 to the array, however, the array will make a copy of the item and will not take
 ownership of the original item. Once again, it only makes sense for wxObjArrays
 will delete it when the item is deleted from the array. If you give a reference
 to the array, however, the array will make a copy of the item and will not take
 ownership of the original item. Once again, it only makes sense for wxObjArrays

-because the other array types never take ownership of their elements.
+because the other array types never take ownership of their elements. Also note
+that you cannot append more than one pointer as reusing it would lead to
+deleting it twice (or more) and hence to a crash.

 
 You may also use \helpref{WX\_APPEND\_ARRAY}{wxappendarray} macro to append all
 
 You may also use \helpref{WX\_APPEND\_ARRAY}{wxappendarray} macro to append all

-elements of one array to another one.
+elements of one array to another one but it is more efficient to use
+{\it copies} parameter and modify the elements in place later if you plan to
+append a lot of items.

 
 \membersection{wxArray::Alloc}\label{wxarrayalloc}
 
 
 \membersection{wxArray::Alloc}\label{wxarrayalloc}
 


@@ -403,7 +511,8 @@ elements of one array to another one.
 Preallocates memory for a given number of array elements. It is worth calling
 when the number of items which are going to be added to the array is known in
 advance because it will save unneeded memory reallocation. If the array already
 Preallocates memory for a given number of array elements. It is worth calling
 when the number of items which are going to be added to the array is known in
 advance because it will save unneeded memory reallocation. If the array already

-has enough memory for the given number of items, nothing happens.
+has enough memory for the given number of items, nothing happens. In any case,
+the existing contents of the array is not modified.

 
 \membersection{wxArray::Clear}\label{wxarrayclear}
 
 
 \membersection{wxArray::Clear}\label{wxarrayclear}
 


@@ -412,18 +521,11 @@ has enough memory for the given number of items, nothing happens.
 This function does the same as \helpref{Empty()}{wxarrayempty} and additionally
 frees the memory allocated to the array.
 
 This function does the same as \helpref{Empty()}{wxarrayempty} and additionally
 frees the memory allocated to the array.
 

-\membersection{wxArray::Count}\label{wxarraycount}
-
-\constfunc{size\_t}{Count}{\void}
-
-Same as \helpref{GetCount()}{wxarraygetcount}. This function is deprecated -
-it exists only for compatibility.
-

 \membersection{wxObjArray::Detach}\label{wxobjarraydetach}
 
 \func{T *}{Detach}{\param{size\_t }{index}}
 
 \membersection{wxObjArray::Detach}\label{wxobjarraydetach}
 
 \func{T *}{Detach}{\param{size\_t }{index}}
 

-Removes the element from the array, but, unlike, 
+Removes the element from the array, but, unlike,

 \helpref{Remove()}{wxarrayremove} doesn't delete it. The function returns the
 pointer to the removed element.
 
 \helpref{Remove()}{wxarrayremove} doesn't delete it. The function returns the
 pointer to the removed element.
 


@@ -433,7 +535,7 @@ pointer to the removed element.
 
 Empties the array. For wxObjArray classes, this destroys all of the array
 elements. For wxArray and wxSortedArray this does nothing except marking the
 
 Empties the array. For wxObjArray classes, this destroys all of the array
 elements. For wxArray and wxSortedArray this does nothing except marking the

-array of being empty - this function does not free the allocated memory, use 
+array of being empty - this function does not free the allocated memory, use

 \helpref{Clear()}{wxarrayclear} for this.
 
 \membersection{wxArray::GetCount}\label{wxarraygetcount}
 \helpref{Clear()}{wxarrayclear} for this.
 
 \membersection{wxArray::GetCount}\label{wxarraygetcount}


@@ -444,15 +546,15 @@ Return the number of items in the array.
 
 \membersection{wxArray::Index}\label{wxarrayindex}
 
 
 \membersection{wxArray::Index}\label{wxarrayindex}
 

-\func{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = FALSE}}
+\constfunc{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = false}}

 
 

-\func{int}{Index}{\param{T\& }{item}}
+\constfunc{int}{Index}{\param{T\& }{item}}

 
 The first version of the function is for wxArray and wxObjArray, the second is
 for wxSortedArray only.
 
 Searches the element in the array, starting from either beginning or the end
 
 The first version of the function is for wxArray and wxObjArray, the second is
 for wxSortedArray only.
 
 Searches the element in the array, starting from either beginning or the end

-depending on the value of {\it searchFromEnd} parameter. wxNOT\_FOUND is
+depending on the value of {\it searchFromEnd} parameter. {\tt wxNOT\_FOUND} is

 returned if the element is not found, otherwise the index of the element is
 returned.
 
 returned if the element is not found, otherwise the index of the element is
 returned.
 


@@ -460,17 +562,23 @@ Linear search is used for the wxArray and wxObjArray classes but binary search
 in the sorted array is used for wxSortedArray (this is why searchFromEnd
 parameter doesn't make sense for it).
 
 in the sorted array is used for wxSortedArray (this is why searchFromEnd
 parameter doesn't make sense for it).
 

+{\bf NB:} even for wxObjArray classes, the operator==() of the elements in the
+array is {\bf not} used by this function. It searches exactly the given
+element in the array and so will only succeed if this element had been
+previously added to the array, but fail even if another, identical, element is
+in the array.
+

 \membersection{wxArray::Insert}\label{wxarrayinsert}
 
 \membersection{wxArray::Insert}\label{wxarrayinsert}
 

-\func{void}{Insert}{\param{T }{item}, \param{size\_t }{n}}
+\func{void}{Insert}{\param{T }{item}, \param{size\_t }{n}, \param{size\_t }{copies = $1$}}

 
 \func{void}{Insert}{\param{T *}{item}, \param{size\_t }{n}}
 
 
 \func{void}{Insert}{\param{T *}{item}, \param{size\_t }{n}}
 

-\func{void}{Insert}{\param{T \&}{item}, \param{size\_t }{n}}
+\func{void}{Insert}{\param{T \&}{item}, \param{size\_t }{n}, \param{size\_t }{copies = $1$}}

 
 

-Insert a new item into the array before the item {\it n} - thus, {\it Insert(something, 0u)} will
-insert an item in such way that it will become the
-first array element.
+Insert the given number of {\it copies} of the {\it item} into the array before
+the existing item {\it n} - thus, {\it Insert(something, 0u)} will insert an
+item in such way that it will become the first array element.

 
 Please see \helpref{Add()}{wxarrayadd} for explanation of the differences
 between the overloaded versions of this function.
 
 Please see \helpref{Add()}{wxarrayadd} for explanation of the differences
 between the overloaded versions of this function.


@@ -479,7 +587,7 @@ between the overloaded versions of this function.
 
 \constfunc{bool}{IsEmpty}{\void}
 
 
 \constfunc{bool}{IsEmpty}{\void}
 

-Returns TRUE if the array is empty, FALSE otherwise.
+Returns true if the array is empty, false otherwise.

 
 \membersection{wxArray::Item}\label{wxarrayitem}
 
 
 \membersection{wxArray::Item}\label{wxarrayitem}
 


@@ -506,14 +614,14 @@ the array classes.
 
 \func{\void}{Remove}{\param{T }{item}}
 
 
 \func{\void}{Remove}{\param{T }{item}}
 

-Removes the element from the array either by value: the first item of the
+Removes an element from the array by value: the first item of the

 array equal to {\it item} is removed, an assert failure will result from an
 attempt to remove an item which doesn't exist in the array.
 
 array equal to {\it item} is removed, an assert failure will result from an
 attempt to remove an item which doesn't exist in the array.
 

-When an element is removed from wxObjArray it is deleted by the array - use 
+When an element is removed from wxObjArray it is deleted by the array - use

 \helpref{Detach()}{wxobjarraydetach} if you don't want this to happen. On the
 other hand, when an object is removed from a wxArray nothing happens - you
 \helpref{Detach()}{wxobjarraydetach} if you don't want this to happen. On the
 other hand, when an object is removed from a wxArray nothing happens - you

-should delete the it manually if required:
+should delete it manually if required:

 
 \begin{verbatim}
 T *item = array[n];
 
 \begin{verbatim}
 T *item = array[n];


@@ -526,13 +634,13 @@ elements of a wxArray (supposed to contain pointers).
 
 \membersection{wxArray::RemoveAt}\label{wxarrayremoveat}
 
 
 \membersection{wxArray::RemoveAt}\label{wxarrayremoveat}
 

-\func{\void}{RemoveAt}{\param{size\_t }{index}}
+\func{\void}{RemoveAt}{\param{size\_t }{index}, \param{size\_t }{count = $1$}}

 
 

-Removes the element from the array either by index. When an element
-is removed from wxObjArray it is deleted by the array - use 
-\helpref{Detach()}{wxobjarraydetach} if you don't want this to happen. On the
-other hand, when an object is removed from a wxArray nothing happens - you
-should delete the it manually if required:
+Removes {\it count} elements starting at {\it index} from the array. When an
+element is removed from wxObjArray it is deleted by the array - use
+\helpref{Detach()}{wxobjarraydetach} if you don't want this to happen. On
+the other hand, when an object is removed from a wxArray nothing happens -
+you should delete it manually if required:

 
 \begin{verbatim}
 T *item = array[n];
 
 \begin{verbatim}
 T *item = array[n];


@@ -543,6 +651,19 @@ array.RemoveAt(n)
 See also \helpref{WX\_CLEAR\_ARRAY}{wxcleararray} macro which deletes all
 elements of a wxArray (supposed to contain pointers).
 
 See also \helpref{WX\_CLEAR\_ARRAY}{wxcleararray} macro which deletes all
 elements of a wxArray (supposed to contain pointers).
 

+\membersection{wxArray::SetCount}\label{wxarraysetcount}
+
+\func{void}{SetCount}{\param{size\_t }{count}, \param{T }{defval = T($0$)}}
+
+This function ensures that the number of array elements is at least
+{\it count}. If the array has already {\it count} or more items, nothing is
+done. Otherwise, {\tt count - GetCount()} elements are added and initialized to
+the value {\it defval}.
+
+\wxheading{See also}
+
+\helpref{GetCount}{wxarraygetcount}
+

 \membersection{wxArray::Shrink}\label{wxarrayshrink}
 
 \func{void}{Shrink}{\void}
 \membersection{wxArray::Shrink}\label{wxarrayshrink}
 
 \func{void}{Shrink}{\void}


@@ -562,7 +683,7 @@ The notation CMPFUNC<T> should be read as if we had the following declaration:
 template int CMPFUNC(T *first, T *second);
 \end{verbatim}
 
 template int CMPFUNC(T *first, T *second);
 \end{verbatim}
 

-where {\it T} is the type of the array elements. I.e. it is a function returning 
+where {\it T} is the type of the array elements. I.e. it is a function returning

 {\it int} which is passed two arguments of type {\it T *}.
 
 Sorts the array using the specified compare function: this function should
 {\it int} which is passed two arguments of type {\it T *}.
 
 Sorts the array using the specified compare function: this function should