1. added wxGTK::wxToolBar::SetToolShortHelp() and test for it in sample

[wxWidgets.git] / include / wx / list.h

diff --git a/include/wx/list.h b/include/wx/list.h
index dc28a480fe958376c33b80d0b043428cbc0ee15d..d475c569b44f4822fae39bf18e9b7f3aaa296a8a 100644 (file)
--- a/include/wx/list.h
+++ b/include/wx/list.h
@@ -34,7 +34,6 @@
 // -----------------------------------------------------------------------------
 
 #include "wx/defs.h"
 // -----------------------------------------------------------------------------
 
 #include "wx/defs.h"

-#include "wx/debug.h"

 #include "wx/object.h"
 #include "wx/string.h"
 
 #include "wx/object.h"
 #include "wx/string.h"
 


@@ -65,10 +64,10 @@ enum wxKeyType
 // type of compare function for list sort operation (as in 'qsort'): it should
 // return a negative value, 0 or positive value if the first element is less
 // than, equal or greater than the second
 // type of compare function for list sort operation (as in 'qsort'): it should
 // return a negative value, 0 or positive value if the first element is less
 // than, equal or greater than the second

-typedef int (*wxSortCompareFunction)(const void *elem1, const void *elem2);
+typedef int (* LINKAGEMODE wxSortCompareFunction)(const void *elem1, const void *elem2);

 
 //
 
 //

-typedef int (*wxListIterateFunction)(void *current);
+typedef int (* LINKAGEMODE wxListIterateFunction)(void *current);

 
 // -----------------------------------------------------------------------------
 // key stuff: a list may be optionally keyed on integer or string key
 
 // -----------------------------------------------------------------------------
 // key stuff: a list may be optionally keyed on integer or string key


@@ -142,7 +141,7 @@ public:
 
     virtual ~wxNodeBase();
 
 
     virtual ~wxNodeBase();
 

-    // @@ no check is done that the list is really keyed on strings
+    // FIXME no check is done that the list is really keyed on strings

     const wxChar *GetKeyString() const { return m_key.string; }
     long GetKeyInteger() const { return m_key.integer; }
 
     const wxChar *GetKeyString() const { return m_key.string; }
     long GetKeyInteger() const { return m_key.integer; }
 


@@ -186,7 +185,8 @@ private:
 // -----------------------------------------------------------------------------
 class WXDLLEXPORT wxListBase : public wxObject
 {
 // -----------------------------------------------------------------------------
 class WXDLLEXPORT wxListBase : public wxObject
 {

-friend class wxNodeBase; // should be able to call DetachNode()
+friend class wxNodeBase;        // should be able to call DetachNode()
+friend class wxHashTableBase;   // should be able to call untyped Find()

 public:
     // default ctor & dtor
     wxListBase(wxKeyType keyType = wxKEY_NONE) { Init(keyType); }
 public:
     // default ctor & dtor
     wxListBase(wxKeyType keyType = wxKEY_NONE) { Init(keyType); }


@@ -267,6 +267,10 @@ protected:
     wxNodeBase *Append(void *object);
         // insert a new item at the beginning of the list
     wxNodeBase *Insert(void *object) { return Insert( (wxNodeBase*)NULL, object); }
     wxNodeBase *Append(void *object);
         // insert a new item at the beginning of the list
     wxNodeBase *Insert(void *object) { return Insert( (wxNodeBase*)NULL, object); }

+        // insert a new item at the given position
+    wxNodeBase *Insert(size_t pos, void *object)
+        { return pos == GetCount() ? Append(object)
+                                   : Insert(Item(pos), object); }

         // insert before given node or at front of list if prev == NULL
     wxNodeBase *Insert(wxNodeBase *prev, void *object);
 
         // insert before given node or at front of list if prev == NULL
     wxNodeBase *Insert(wxNodeBase *prev, void *object);
 


@@ -339,11 +343,19 @@ private:
 //  2. We redefine all non-type-safe wxList functions with type-safe versions
 //     which don't take any space (everything is inline), but bring compile
 //     time error checking.
 //  2. We redefine all non-type-safe wxList functions with type-safe versions
 //     which don't take any space (everything is inline), but bring compile
 //     time error checking.

-
-#define WX_DECLARE_LIST_2(T, name, nodetype)                                \
-    typedef int (*wxSortFuncFor_##name)(const T *, const T *);              \
+//
+//  3. The macro which is usually used (WX_DECLARE_LIST) is defined in terms of
+//     a more generic WX_DECLARE_LIST_2 macro which, in turn, uses the most
+//     generic WX_DECLARE_LIST_3 one. The last macro adds a sometimes
+//     interesting capability to store polymorphic objects in the list and is
+//     particularly useful with, for example, "wxWindow *" list where the
+//     wxWindowBase pointers are put into the list, but wxWindow pointers are
+//     retrieved from it.
+
+#define WX_DECLARE_LIST_3(T, Tbase, name, nodetype, classexp)               \
+    typedef int (*wxSortFuncFor_##name)(const T **, const T **);            \

                                                                             \
                                                                             \

-    class WXDLLEXPORT nodetype : public wxNodeBase                          \
+    classexp nodetype : public wxNodeBase                                   \

     {                                                                       \
     public:                                                                 \
         nodetype(wxListBase *list = (wxListBase *)NULL,                     \
     {                                                                       \
     public:                                                                 \
         nodetype(wxListBase *list = (wxListBase *)NULL,                     \


@@ -366,7 +378,7 @@ private:
         virtual void DeleteData();                                          \
     };                                                                      \
                                                                             \
         virtual void DeleteData();                                          \
     };                                                                      \
                                                                             \

-    class WXDLLEXPORT name : public wxListBase                              \
+    classexp name : public wxListBase                                       \

     {                                                                       \
     public:                                                                 \
         typedef nodetype Node;                                              \
     {                                                                       \
     public:                                                                 \
         typedef nodetype Node;                                              \


@@ -376,6 +388,9 @@ private:
         name(size_t count, T *elements[])                                   \
             : wxListBase(count, (void **)elements) { }                      \
                                                                             \
         name(size_t count, T *elements[])                                   \
             : wxListBase(count, (void **)elements) { }                      \
                                                                             \

+        name& operator=(const name& list)                                   \
+            { return (name&)wxListBase::operator=(list); }                  \
+                                                                            \

         nodetype *GetFirst() const                                          \
             { return (nodetype *)wxListBase::GetFirst(); }                  \
         nodetype *GetLast() const                                           \
         nodetype *GetFirst() const                                          \
             { return (nodetype *)wxListBase::GetFirst(); }                  \
         nodetype *GetLast() const                                           \


@@ -390,11 +405,13 @@ private:
             return node ? (T*)(node->GetData()) : (T*)NULL;                 \
         }                                                                   \
                                                                             \
             return node ? (T*)(node->GetData()) : (T*)NULL;                 \
         }                                                                   \
                                                                             \

-        nodetype *Append(T *object)                                         \
+        nodetype *Append(Tbase *object)                                     \

             { return (nodetype *)wxListBase::Append(object); }              \
             { return (nodetype *)wxListBase::Append(object); }              \

-        nodetype *Insert(T *object)                                         \
+        nodetype *Insert(Tbase *object)                                     \

             { return (nodetype *)Insert((nodetype*)NULL, object); }         \
             { return (nodetype *)Insert((nodetype*)NULL, object); }         \

-        nodetype *Insert(nodetype *prev, T *object)                         \
+        nodetype *Insert(size_t pos, Tbase *object)                         \
+            { return (nodetype *)wxListBase::Insert(pos, object); }         \
+        nodetype *Insert(nodetype *prev, Tbase *object)                     \

             { return (nodetype *)wxListBase::Insert(prev, object); }        \
                                                                             \
         nodetype *Append(long key, void *object)                            \
             { return (nodetype *)wxListBase::Insert(prev, object); }        \
                                                                             \
         nodetype *Append(long key, void *object)                            \


@@ -406,16 +423,16 @@ private:
             { return (nodetype *)wxListBase::DetachNode(node); }            \
         bool DeleteNode(nodetype *node)                                     \
             { return wxListBase::DeleteNode(node); }                        \
             { return (nodetype *)wxListBase::DetachNode(node); }            \
         bool DeleteNode(nodetype *node)                                     \
             { return wxListBase::DeleteNode(node); }                        \

-        bool DeleteObject(T *object)                                        \
+        bool DeleteObject(Tbase *object)                                    \

             { return wxListBase::DeleteObject(object); }                    \
                                                                             \
             { return wxListBase::DeleteObject(object); }                    \
                                                                             \

-        nodetype *Find(T *object) const                                     \
+        nodetype *Find(Tbase *object) const                                 \

             { return (nodetype *)wxListBase::Find(object); }                \
                                                                             \
         virtual nodetype *Find(const wxListKey& key) const                  \
             { return (nodetype *)wxListBase::Find(key); }                   \
                                                                             \
             { return (nodetype *)wxListBase::Find(object); }                \
                                                                             \
         virtual nodetype *Find(const wxListKey& key) const                  \
             { return (nodetype *)wxListBase::Find(key); }                   \
                                                                             \

-        int IndexOf( T *object ) const                                      \
+        int IndexOf(Tbase *object) const                                    \

             { return wxListBase::IndexOf(object); }                         \
                                                                             \
         void Sort(wxSortFuncFor_##name func)                                \
             { return wxListBase::IndexOf(object); }                         \
                                                                             \
         void Sort(wxSortFuncFor_##name func)                                \


@@ -432,9 +449,16 @@ private:
             }                                                               \
     }
 
             }                                                               \
     }
 

+#define WX_DECLARE_LIST_2(elementtype, listname, nodename, classexp)        \
+    WX_DECLARE_LIST_3(elementtype, elementtype, listname, nodename, classexp)
+

 #define WX_DECLARE_LIST(elementtype, listname)                              \
     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
 #define WX_DECLARE_LIST(elementtype, listname)                              \
     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \

-    WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node)
+    WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class)
+
+#define WX_DECLARE_EXPORTED_LIST(elementtype, listname)                     \
+    typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
+    WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class WXDLLEXPORT)

 
 // this macro must be inserted in your program after
 //      #include <wx/listimpl.cpp>
 
 // this macro must be inserted in your program after
 //      #include <wx/listimpl.cpp>


@@ -445,25 +469,25 @@ private:
 // =============================================================================
 
 // ----------------------------------------------------------------------------
 // =============================================================================
 
 // ----------------------------------------------------------------------------

-// commonly used string classes
+// commonly used list classes

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class wxWindow;
-WX_DECLARE_LIST(wxWindow, wxWindowList);
-

 #ifdef wxLIST_COMPATIBILITY
 
 // -----------------------------------------------------------------------------
 // wxList compatibility class: in fact, it's a list of wxObjects
 // -----------------------------------------------------------------------------
 
 #ifdef wxLIST_COMPATIBILITY
 
 // -----------------------------------------------------------------------------
 // wxList compatibility class: in fact, it's a list of wxObjects
 // -----------------------------------------------------------------------------
 

-WX_DECLARE_LIST_2(wxObject, wxObjectList, wxObjectListNode);
+WX_DECLARE_LIST_2(wxObject, wxObjectList, wxObjectListNode, class WXDLLEXPORT);

 
 class WXDLLEXPORT wxList : public wxObjectList
 {
 public:
     wxList(int key_type = wxKEY_NONE) : wxObjectList((wxKeyType)key_type) { }
 
 
 class WXDLLEXPORT wxList : public wxObjectList
 {
 public:
     wxList(int key_type = wxKEY_NONE) : wxObjectList((wxKeyType)key_type) { }
 

+    wxList& operator=(const wxList& list)
+        { return (wxList&)wxListBase::operator=(list); }
+

     // compatibility methods
     void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }
 
     // compatibility methods
     void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }
 


@@ -474,7 +498,7 @@ public:
 // wxStringList class for compatibility with the old code
 // -----------------------------------------------------------------------------
 
 // wxStringList class for compatibility with the old code
 // -----------------------------------------------------------------------------
 

-WX_DECLARE_LIST_2(wxChar, wxStringListBase, wxStringListNode);
+WX_DECLARE_LIST_2(wxChar, wxStringListBase, wxStringListNode, class WXDLLEXPORT);

 
 class WXDLLEXPORT wxStringList : public wxStringListBase
 {
 
 class WXDLLEXPORT wxStringList : public wxStringListBase
 {


@@ -486,7 +510,7 @@ public:
 
         // copying the string list: the strings are copied, too (extremely
         // inefficient!)
 
         // copying the string list: the strings are copied, too (extremely
         // inefficient!)

-    wxStringList(const wxStringList& other) { DoCopy(other); }
+    wxStringList(const wxStringList& other) { DeleteContents(TRUE); DoCopy(other); }

     wxStringList& operator=(const wxStringList& other)
         { Clear(); DoCopy(other); return *this; }
 
     wxStringList& operator=(const wxStringList& other)
         { Clear(); DoCopy(other); return *this; }