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
\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;
\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.
\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\_EXPORTED\_ARRAY}{wxdefinesortedarray}\\
+\helpref{WX\_DEFINE\_SORTED\_USER\_EXPORTED\_ARRAY}{wxdefinesortedarray}\\
\helpref{WX\_DECLARE\_EXPORTED\_OBJARRAY}{wxdeclareobjarray}\\
-\helpref{WX\_DEFINE\_OBJARRAY}{wxdefineobjarray}
+\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}
\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}. The second form is used when compiling DLL
-under Windows and array needs to be visible outside the DLL.
+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}
\func{}{WX\_DEFINE\_SORTED\_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}. The second form is used when compiling DLL
-under Windows and array needs to be visible outside the DLL.
+\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}. 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:
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)
{
\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}. The second form is used when compiling DLL
-under Windows and array needs to be visible outside the DLL.
+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:
\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
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:
\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.
\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];
\func{\void}{RemoveAt}{\param{size\_t }{index}}
-Removes the element from the array either by index. When an element
+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 the it manually if required:
+should delete it manually if required:
\begin{verbatim}
T *item = array[n];
projects / wxWidgets.git / blobdiff