X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4f6aed9c6a21d4bc732579aa564adf4cdb2c9aab..e2478fde622a16d25c66690af353dfdc37e7b582:/docs/latex/wx/array.tex?ds=sidebyside

diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex
index e449ca6ad8..0c4a97fdc0 100644
--- a/docs/latex/wx/array.tex
+++ b/docs/latex/wx/array.tex
@@ -51,7 +51,7 @@ wxArrayDouble class is scheduled for the next release of wxWindows).
 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
@@ -75,7 +75,7 @@ example:
 \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;
@@ -97,7 +97,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
-// 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);
 
@@ -125,7 +125,7 @@ WX_DEFINE_SORTED_ARRAY(MyFile *, ArrayOfFiles);
 
 \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.
@@ -141,9 +141,16 @@ WX\_DECLARE\_OBJARRAY macros and must be fully declared before you use
 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\_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}
 
 \membersection{Constructors and destructors}
 
@@ -170,7 +177,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
-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.
@@ -194,6 +201,7 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method.
 
 \helpref{Add}{wxarrayadd}\\
 \helpref{Insert}{wxarrayinsert}\\
+\helpref{SetCount}{wxarraysetcount}\\
 \helpref{WX\_APPEND\_ARRAY}{wxappendarray}
 
 \membersection{Removing items}
@@ -220,8 +228,16 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method.
 
 \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
-elements of type {\it T}. Example:
+elements of type {\it T}. The second form is used when compiling wxWindows 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}
 WX_DEFINE_ARRAY(int, wxArrayInt);
@@ -237,8 +253,16 @@ wxArrayLong and wxArrayPtrVoid.
 
 \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
-the elements of type {\it T}. Example:
+the elements of type {\it T}. The second form is used when compiling wxWindows 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}
 WX_DEFINE_SORTED_ARRAY(int, wxSortedArrayInt);
@@ -247,8 +271,9 @@ class MyClass;
 WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass);
 \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:
+
 \begin{verbatim}
 int CompareInts(int n1, int n2)
 {
@@ -270,12 +295,20 @@ wxArrayOfMyClass another(CompareMyClassObjects);
 
 \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
-the elements of type {\it T}. Example:
+the elements of type {\it T}. The second form is used when compiling wxWindows 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;
-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
@@ -285,6 +318,10 @@ the array class - otherwise you would get link errors.
 
 \func{}{WX\_DEFINE\_OBJARRAY}{\param{}{name}}
 
+\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
@@ -292,7 +329,8 @@ 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
-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:
 
@@ -338,7 +376,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
-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.
@@ -376,14 +414,14 @@ done by wxArray and wxSortedArray versions - you may use
 
 \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}, \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
@@ -391,10 +429,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
-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
-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}
 
@@ -444,7 +486,7 @@ Return the number of items in the array.
 
 \membersection{wxArray::Index}\label{wxarrayindex}
 
-\func{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = FALSE}}
+\func{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = false}}
 
 \func{int}{Index}{\param{T\& }{item}}
 
@@ -460,17 +502,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).
 
+{\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}
 
-\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}, \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.
@@ -479,7 +527,7 @@ between the overloaded versions of this function.
 
 \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}
 
@@ -506,14 +554,14 @@ the array classes.
 
 \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.
 
 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:
+should delete it manually if required:
 
 \begin{verbatim}
 T *item = array[n];
@@ -526,13 +574,13 @@ elements of a wxArray (supposed to contain pointers).
 
 \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];
@@ -543,6 +591,19 @@ array.RemoveAt(n)
 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 mroe 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}
