Documented new menu label functions

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

diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex
index 5ed809ade276564479ad84e75ad7307a8595ad43..fd3065b1411548ea3f4d55c3f1dbe88adb643867 100644 (file)
--- a/docs/latex/wx/array.tex
+++ b/docs/latex/wx/array.tex
@@ -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,
 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
 
 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


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

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

 // we must forward declare the array because it is used inside the class
 // declaration
 class MyDirectory;
 // we must forward declare the array because it is used inside the class
 // declaration
 class MyDirectory;


@@ -128,12 +131,16 @@ Things are much simpler for wxArray and wxSortedArray however: it is enough
 just to write
 
 \begin{verbatim}
 just to write
 
 \begin{verbatim}

-WX_DEFINE_ARRAY(int, ArrayOfDirectories);
-WX_DEFINE_SORTED_ARRAY(int, ArrayOfFiles);
+WX_DEFINE_ARRAY_INT(int, ArrayOfInts);
+WX_DEFINE_SORTED_ARRAY_INT(int, ArrayOfSortedInts);

 \end{verbatim}
 
 i.e. there is only one {\tt DEFINE} macro and no need for separate
 \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:}


@@ -239,7 +246,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.
 
 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{GetCount}{wxarraygetcount}\\
 \helpref{IsEmpty}{wxarrayisempty}\\
 \helpref{Item}{wxarrayitem}\\


@@ -250,7 +256,8 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method.
 \helpref{Add}{wxarrayadd}\\
 \helpref{Insert}{wxarrayinsert}\\
 \helpref{SetCount}{wxarraysetcount}\\
 \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}
 
 
 \membersection{Removing items}\label{arrayremoving}
 


@@ -288,14 +295,15 @@ needed for exporting an array from a user DLL.
 Example:
 
 \begin{verbatim}
 Example:
 
 \begin{verbatim}

-WX_DEFINE_ARRAY_INT(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 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}
 
 
 \membersection{WX\_DEFINE\_SORTED\_ARRAY}\label{wxdefinesortedarray}
 


@@ -313,10 +321,10 @@ needed for exporting an array from a user DLL.
 Example:
 
 \begin{verbatim}
 Example:
 
 \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}
 
 You will have to initialize the objects of this class by passing a comparison
 \end{verbatim}
 
 You will have to initialize the objects of this class by passing a comparison


@@ -405,6 +413,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.
 
 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}}
 \membersection{WX\_CLEAR\_ARRAY}\label{wxcleararray}
 
 \func{void}{WX\_CLEAR\_ARRAY}{\param{wxArray\& }{array}}


@@ -493,7 +508,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
 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}
 


@@ -502,13 +518,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.
 
 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}}


@@ -534,9 +543,9 @@ 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.
 
 The first version of the function is for wxArray and wxObjArray, the second is
 for wxSortedArray only.


@@ -679,3 +688,4 @@ 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.
 
 wxSortedArray doesn't have this function because it is always sorted.
 passed to it is less than, equal to or greater than the second one.
 
 wxSortedArray doesn't have this function because it is always sorted.

+