Added EVT_GRID_EDITOR_CREATED and wxGridEditorCreatedEvent so the user

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

diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex
index e449ca6ad829b3b7eb4ad1f505447ae249c72ed8..733e548d5df415a5f3c627651a900fc51dd9e4fc 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;


@@ -125,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.


@@ -141,8 +141,10 @@ 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\_SORTED\_ARRAY}{wxdefinesortedarray}\\
 \helpref{WX\_DEFINE\_SORTED\_ARRAY}{wxdefinesortedarray}\\

-\helpref{WX\_DECLARE\_OBJARRAY}{wxdeclareobjarray}\\
+\helpref{WX\_DEFINE\_SORTED\_EXPORTED\_ARRAY}{wxdefinesortedarray}\\
+\helpref{WX\_DECLARE\_EXPORTED\_OBJARRAY}{wxdeclareobjarray}\\

 \helpref{WX\_DEFINE\_OBJARRAY}{wxdefineobjarray}
 
 \membersection{Constructors and destructors}
 \helpref{WX\_DEFINE\_OBJARRAY}{wxdefineobjarray}
 
 \membersection{Constructors and destructors}


@@ -220,8 +222,12 @@ 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}}
+

 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 DLL
+under Windows and array needs to be visible outside the DLL.
+Example:

 
 \begin{verbatim}
 WX_DEFINE_ARRAY(int, wxArrayInt);
 
 \begin{verbatim}
 WX_DEFINE_ARRAY(int, wxArrayInt);


@@ -237,8 +243,13 @@ 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}}
+

 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 DLL
+under Windows and array needs to be visible outside the DLL.
+
+Example:

 
 \begin{verbatim}
 WX_DEFINE_SORTED_ARRAY(int, wxSortedArrayInt);
 
 \begin{verbatim}
 WX_DEFINE_SORTED_ARRAY(int, wxSortedArrayInt);


@@ -247,8 +258,9 @@ class MyClass;
 WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass);
 \end{verbatim}
 
 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)
 {
 \begin{verbatim}
 int CompareInts(int n1, int n2)
 {


@@ -270,8 +282,13 @@ 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}}
+

 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 DLL
+under Windows and array needs to be visible outside the DLL.
+
+Example:

 
 \begin{verbatim}
 class MyClass;
 
 \begin{verbatim}
 class MyClass;


@@ -338,7 +355,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.


@@ -460,6 +477,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}}


@@ -506,14 +529,14 @@ the array classes.
 
 \func{\void}{Remove}{\param{T }{item}}
 
 
 \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
 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];
 
 \begin{verbatim}
 T *item = array[n];


@@ -528,11 +551,11 @@ elements of a wxArray (supposed to contain pointers).
 
 \func{\void}{RemoveAt}{\param{size\_t }{index}}
 
 
 \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
 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];
 
 \begin{verbatim}
 T *item = array[n];