added support for wxDP_ALLOWNONE in wxMSW; documented it; added test for it in the...

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

diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex
index c576f7c0d0671c075fdaf9d723669d62639e5b99..3e806ad938763453284c2f38c7ea96b2523da548 100644 (file)
--- a/docs/latex/wx/array.tex
+++ b/docs/latex/wx/array.tex
@@ -161,7 +161,29 @@ 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
 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
+pointers to {\tt double} you should use.
+
+Note that the above macros are generally only useful for 
+wxObject types.  There are seperate 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}\\

 
 \begin{verbatim} 
 WX_DEFINE_ARRAY_PTR(double *, MyArrayOfDoublePointers);
 
 \begin{verbatim} 
 WX_DEFINE_ARRAY_PTR(double *, MyArrayOfDoublePointers);


@@ -255,7 +277,7 @@ needed for exporting an array from a user DLL.
 Example:
 
 \begin{verbatim}
 Example:
 
 \begin{verbatim}

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

 
 class MyClass;
 WX_DEFINE_ARRAY(MyClass *, wxArrayOfMyClass);
 
 class MyClass;
 WX_DEFINE_ARRAY(MyClass *, wxArrayOfMyClass);


@@ -280,7 +302,7 @@ 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(wxSortedArrayInt);

 
 class MyClass;
 WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass);
 
 class MyClass;
 WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass);


@@ -509,7 +531,7 @@ 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
 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.
 


@@ -611,7 +633,7 @@ elements of a wxArray (supposed to contain pointers).
 \func{void}{SetCount}{\param{size\_t }{count}, \param{T }{defval = T($0$)}}
 
 This function ensures that the number of array elements is at least 
 \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
+{\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}.
 
 done. Otherwise, {\tt count - GetCount()} elements are added and initialized to
 the value {\it defval}.