update for bakefile 0.2.6

[wxWidgets.git] / interface / wx / dynarray.h

diff --git a/interface/wx/dynarray.h b/interface/wx/dynarray.h
index dc427b171d093f29ad36933a273f9ad510ea1f06..6001afe7454bd485705d3b8d00ea6d5c6bb21775 100644 (file)
--- a/interface/wx/dynarray.h
+++ b/interface/wx/dynarray.h
@@ -197,11 +197,24 @@
     - WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT()
 
 
     - WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT()
 
 

+    @section array_predef Predefined array types
+
+    wxWidgets defines the following dynamic array types:
+    - ::wxArrayShort
+    - ::wxArrayInt
+    - ::wxArrayDouble
+    - ::wxArrayLong
+    - ::wxArrayPtrVoid
+
+    To use them you don't need any macro; you just need to include @c dynarray.h.
+
+

     @library{wxbase}
     @category{containers}
 
     @see @ref overview_container, wxList<T>, wxVector<T>
 */
     @library{wxbase}
     @category{containers}
 
     @see @ref overview_container, wxList<T>, wxVector<T>
 */

+template <typename T>

 class wxArray<T>
 {
 public:
 class wxArray<T>
 {
 public:


@@ -533,14 +546,16 @@ public:
 
         @code
         T *item = array[n];
 
         @code
         T *item = array[n];

+        array.Remove(item);

         delete item;
         delete item;

-        array.Remove(n);

         @endcode
 
         See also WX_CLEAR_ARRAY() macro which deletes all elements of a wxArray
         (supposed to contain pointers).
         @endcode
 
         See also WX_CLEAR_ARRAY() macro which deletes all elements of a wxArray
         (supposed to contain pointers).

+
+        @see RemoveAt()

     */
     */

-    Remove(T item);
+    void Remove(T item);

 
     /**
         Removes @a count elements starting at @a index from the array. When an
 
     /**
         Removes @a count elements starting at @a index from the array. When an


@@ -558,7 +573,7 @@ public:
         See also WX_CLEAR_ARRAY() macro which deletes all elements of a wxArray
         (supposed to contain pointers).
     */
         See also WX_CLEAR_ARRAY() macro which deletes all elements of a wxArray
         (supposed to contain pointers).
     */

-    RemoveAt(size_t index, size_t count = 1);
+    void RemoveAt(size_t index, size_t count = 1);

 
     //@}
 
 
     //@}
 


@@ -583,6 +598,7 @@ public:
               another, identical, element is in the array.
     */
     int Index(T& item, bool searchFromEnd = false) const;
               another, identical, element is in the array.
     */
     int Index(T& item, bool searchFromEnd = false) const;

+

     /**
         This version of Index() is for wxSortedArray only.
 
     /**
         This version of Index() is for wxSortedArray only.
 


@@ -591,7 +607,7 @@ public:
         @c wxNOT_FOUND is returned if the element is not found, otherwise the
         index of the element is returned.
     */
         @c wxNOT_FOUND is returned if the element is not found, otherwise the
         index of the element is returned.
     */

-    const int Index(T& item) const;
+    int Index(T& item) const;

 
     /**
         Search for a place to insert @a item into the sorted array (binary
 
     /**
         Search for a place to insert @a item into the sorted array (binary


@@ -632,17 +648,17 @@ public:
 
 
 /**
 
 
 /**

-    This macro may be used to append all elements of the @a other array to the
-    @a array. The two arrays must be of the same type.
+    This macro may be used to append all elements of the @a wxArray_arrayToBeAppended
+    array to the @a wxArray_arrayToModify. The two arrays must be of the same type.

 */
 */

-#define WX_APPEND_ARRAY(wxArray& array, wxArray& other)
+#define WX_APPEND_ARRAY(wxArray_arrayToModify, wxArray_arrayToBeAppended)

 
 /**
     This macro may be used to delete all elements of the array before emptying
     it. It can not be used with wxObjArrays - but they will delete their
     elements anyway when you call Empty().
 */
 
 /**
     This macro may be used to delete all elements of the array before emptying
     it. It can not be used with wxObjArrays - but they will delete their
     elements anyway when you call Empty().
 */

-#define WX_CLEAR_ARRAY(wxArray& array)
+#define WX_CLEAR_ARRAY(wxArray_arrayToBeCleared)

 
 //@{
 /**
 
 //@{
 /**


@@ -777,8 +793,18 @@ public:
 //@}
 
 /**
 //@}
 
 /**

-    This macro may be used to prepend all elements of the @a other array to the
-    @a array. The two arrays must be of the same type.
+    This macro may be used to prepend all elements of the @a wxArray_arrayToBePrepended
+    array to the @a wxArray_arrayToModify. The two arrays must be of the same type.

 */
 */

-#define WX_PREPEND_ARRAY(wxArray& array, wxArray& other)
+#define WX_PREPEND_ARRAY(wxArray_arrayToModify, wxArray_arrayToBePrepended)

 
 

+//@{
+/**
+    Predefined specialization of wxArray<T> for standard types.
+*/
+typedef wxArray<int> wxArrayInt;
+typedef wxArray<long> wxArrayLong;
+typedef wxArray<short> wxArrayShort;
+typedef wxArray<double> wxArrayDouble;
+typedef wxArray<void*> wxArrayPtrVoid;
+//@}