implemented radio menu items for wxMSW

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

diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex
index 7f16a2a273c4474f6942beb218b4077f8acb2930..b8e51c3a5bf23e8ac19e60c8369374884c5d68c9 100644 (file)
--- 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
 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 +75,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;


@@ -95,7 +95,9 @@ class MyDirectory
 ...
 
 // now that we have MyDirectory declaration in scope we may finish the
 ...
 
 // now that we have MyDirectory declaration in scope we may finish the

-// definition of ArrayOfDirectories
+// 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)

 #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);
 


@@ -123,7 +125,7 @@ WX_DEFINE_SORTED_ARRAY(MyFile *, ArrayOfFiles);
 
 \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.


@@ -139,9 +141,16 @@ 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}

 
 \membersection{Constructors and destructors}
 
 
 \membersection{Constructors and destructors}
 


@@ -191,13 +200,15 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method.
 \membersection{Adding items}
 
 \helpref{Add}{wxarrayadd}\\
 \membersection{Adding items}
 
 \helpref{Add}{wxarrayadd}\\

-\helpref{Insert}{wxarrayinsert}
+\helpref{Insert}{wxarrayinsert}\\
+\helpref{WX\_APPEND\_ARRAY}{wxappendarray}

 
 \membersection{Removing items}
 
 \helpref{WX\_CLEAR\_ARRAY}{wxcleararray}\\
 \helpref{Empty}{wxarrayempty}\\
 \helpref{Clear}{wxarrayclear}\\
 
 \membersection{Removing items}
 
 \helpref{WX\_CLEAR\_ARRAY}{wxcleararray}\\
 \helpref{Empty}{wxarrayempty}\\
 \helpref{Clear}{wxarrayclear}\\

+\helpref{RemoveAt}{wxarrayremoveat}\\

 \helpref{Remove}{wxarrayremove}
 
 \membersection{Searching and sorting}
 \helpref{Remove}{wxarrayremove}
 
 \membersection{Searching and sorting}


@@ -216,8 +227,16 @@ 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 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);
 
 \begin{verbatim}
 WX_DEFINE_ARRAY(int, wxArrayInt);


@@ -233,25 +252,34 @@ wxArrayLong and wxArrayPtrVoid.
 
 \func{}{WX\_DEFINE\_SORTED\_ARRAY}{\param{}{T}, \param{}{name}}
 
 
 \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 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}
 
 \begin{verbatim}

-WX_DEFINE_SORTED_ARRAY(int, wxArrayInt);
+WX_DEFINE_SORTED_ARRAY(int, wxSortedArrayInt);

 
 class MyClass;
 WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass);
 \end{verbatim}
 
 
 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:
 function to the array object constructor like this:

+

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

-wxArrayInt sorted(CompareInts);
+wxSortedArrayInt sorted(CompareInts);

 
 int CompareMyClassObjects(MyClass *item1, MyClass *item2)
 {
 
 int CompareMyClassObjects(MyClass *item1, MyClass *item2)
 {


@@ -266,8 +294,16 @@ 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 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;
 
 \begin{verbatim}
 class MyClass;


@@ -281,6 +317,10 @@ the array class - otherwise you would get link errors.
 
 \func{}{WX\_DEFINE\_OBJARRAY}{\param{}{name}}
 
 
 \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
 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


@@ -288,7 +328,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
 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:
 


@@ -308,6 +349,13 @@ public:
 WX_DEFINE_OBJARRAY(wxArrayOfMyClass);
 \end{verbatim}
 
 WX_DEFINE_OBJARRAY(wxArrayOfMyClass);
 \end{verbatim}
 

+\membersection{WX\_APPEND\_ARRAY}\label{wxappendarray}
+
+\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 
+{\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}}


@@ -327,7 +375,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.


@@ -382,6 +430,9 @@ 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.
 
 ownership of the original item. Once again, it only makes sense for wxObjArrays
 because the other array types never take ownership of their elements.
 

+You may also use \helpref{WX\_APPEND\_ARRAY}{wxappendarray} macro to append all
+elements of one array to another one.
+

 \membersection{wxArray::Alloc}\label{wxarrayalloc}
 
 \func{void}{Alloc}{\param{size\_t }{count}}
 \membersection{wxArray::Alloc}\label{wxarrayalloc}
 
 \func{void}{Alloc}{\param{size\_t }{count}}


@@ -410,7 +461,6 @@ it exists only for compatibility.
 \func{T *}{Detach}{\param{size\_t }{index}}
 
 Removes the element from the array, but, unlike, 
 \func{T *}{Detach}{\param{size\_t }{index}}
 
 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.
 


@@ -447,6 +497,12 @@ 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}
 
 \func{void}{Insert}{\param{T }{item}, \param{size\_t }{n}}
 \membersection{wxArray::Insert}\label{wxarrayinsert}
 
 \func{void}{Insert}{\param{T }{item}, \param{size\_t }{n}}


@@ -491,15 +547,16 @@ the array classes.
 
 \membersection{wxArray::Remove}\label{wxarrayremove}
 
 
 \membersection{wxArray::Remove}\label{wxarrayremove}
 

-\func{\void}{Remove}{\param{size\_t }{index}}
-

 \func{\void}{Remove}{\param{T }{item}}
 
 \func{\void}{Remove}{\param{T }{item}}
 

-Removes the element from the array either by index or by value. When an element
-is removed from wxObjArray it is deleted by the array - use 
+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
 \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];


@@ -510,6 +567,25 @@ array.Remove(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::RemoveAt}\label{wxarrayremoveat}
+
+\func{\void}{RemoveAt}{\param{size\_t }{index}}
+
+Removes an element from the array 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 it manually if required:
+
+\begin{verbatim}
+T *item = array[n];
+delete item;
+array.RemoveAt(n)
+\end{verbatim}
+
+See also \helpref{WX\_CLEAR\_ARRAY}{wxcleararray} macro which deletes all
+elements of a wxArray (supposed to contain pointers).
+

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