added null pointer check and assert

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

diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex
index e4415b39c6624bfa336c3818d308c022abde7c67..e73da13ebd110bc4bf25edb2b8d6b676d2935d44 100644 (file)
--- a/docs/latex/wx/array.tex
+++ b/docs/latex/wx/array.tex
@@ -9,10 +9,10 @@
 %% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-\section{\class{wxArray}}\label{wxarray}
+\section{\class{wxArray<T>}}\label{wxarray}
 
 This section describes the so called {\it dynamic arrays}. This is a C
-array-like data structure i.e. the member access time is constant (and not
+array-like type safe data structure i.e. the member access time is constant (and not
 linear according to the number of container elements as for linked lists). However, these
 arrays are dynamic in the sense that they will automatically allocate more
 memory if there is not enough of it for adding a new element. They also perform
@@ -56,8 +56,7 @@ 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 wxWidgets).
+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
@@ -133,18 +132,31 @@ WX_DEFINE_SORTED_ARRAY_INT(int, ArrayOfSortedInts);
 \end{verbatim}
 
 i.e. there is only one {\tt DEFINE} macro and no need for separate
-{\tt DECLARE} one.
+{\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:}
+\wxheading{See also}
 
-\helpref{Container classes overview}{wxcontaineroverview}, \helpref{wxList}{wxlist}
+\helpref{Container classes overview}{wxcontaineroverview}, 
+\helpref{wxList<T>}{wxlist},
+\helpref{wxVector<T>}{wxvector}
 
 \wxheading{Include files}
 
 <wx/dynarray.h> for wxArray and wxSortedArray and additionally <wx/arrimpl.cpp>
 for wxObjArray.
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
+
+
+
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 \membersection{Macros for template array definition}\label{arraymacros}
@@ -239,7 +251,6 @@ 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}\\
@@ -250,7 +261,8 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method.
 \helpref{Add}{wxarrayadd}\\
 \helpref{Insert}{wxarrayinsert}\\
 \helpref{SetCount}{wxarraysetcount}\\
-\helpref{WX\_APPEND\_ARRAY}{wxappendarray}
+\helpref{WX\_APPEND\_ARRAY}{wxappendarray}\\
+\helpref{WX\_PREPEND\_ARRAY}{wxprependarray}
 
 \membersection{Removing items}\label{arrayremoving}
 
@@ -294,8 +306,9 @@ class MyClass;
 WX_DEFINE_ARRAY(MyClass *, ArrayOfMyClass);
 \end{verbatim}
 
-Note that wxWidgets 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}
 
@@ -405,6 +418,13 @@ WX_DEFINE_OBJARRAY(wxArrayOfMyClass);
 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}
 
 \func{void}{WX\_CLEAR\_ARRAY}{\param{wxArray\& }{array}}
@@ -493,7 +513,8 @@ append a lot of items.
 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}
 
@@ -502,13 +523,6 @@ 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.
 
-\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}}