refresh cache on size/margins change; expanded cache to contain N elements, not just one

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

diff --git a/include/wx/clntdata.h b/include/wx/clntdata.h
index e91f2391b21037cb714310d79ecff9823cb9f568..f756dcc2a1c8ea23e3e7d28c1c270b7d9f972061 100644 (file)
--- a/include/wx/clntdata.h
+++ b/include/wx/clntdata.h
@@ -12,11 +12,12 @@
 #ifndef _WX_CLNTDATAH__
 #define _WX_CLNTDATAH__
 
 #ifndef _WX_CLNTDATAH__
 #define _WX_CLNTDATAH__
 

-#ifdef __GNUG__
-    #pragma interface "event.h"
+#if defined(__GNUG__) && !defined(__APPLE__)
+    #pragma interface "clntdata.h"

 #endif
 
 #include "wx/defs.h"
 #endif
 
 #include "wx/defs.h"

+#include "wx/string.h"

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


@@ -38,7 +39,7 @@ public:
 class WXDLLEXPORT wxStringClientData : public wxClientData
 {
 public:
 class WXDLLEXPORT wxStringClientData : public wxClientData
 {
 public:

-    wxStringClientData() { }
+    wxStringClientData() : m_data() { }

     wxStringClientData( const wxString &data ) : m_data(data) { }
     void SetData( const wxString &data ) { m_data = data; }
     const wxString& GetData() const { return m_data; }
     wxStringClientData( const wxString &data ) : m_data(data) { }
     void SetData( const wxString &data ) { m_data = data; }
     const wxString& GetData() const { return m_data; }


@@ -48,16 +49,22 @@ private:
 };
 
 
 };
 
 

+
+// This class is a mixin that provides storage and management of "client
+// data."  The client data stored can either be a pointer to a wxClientData
+// object in which case it is managed by the container (i.e.  it will delete
+// the data when it's destroyed) or an untyped pointer which won't be deleted
+// by the container - but not both of them
+//
+// NOTE:  This functionality is currently duplicated in wxEvtHandler in order
+//        to avoid having more than one vtable in that class heirachy.
+

 class WXDLLEXPORT wxClientDataContainer
 {
 public:
     wxClientDataContainer();
 class WXDLLEXPORT wxClientDataContainer
 {
 public:
     wxClientDataContainer();

-    ~wxClientDataContainer();
+    virtual ~wxClientDataContainer();

 
 

-        // each window may have associated client data: either a pointer to
-        // wxClientData object in which case it is managed by the window (i.e.
-        // it will delete the data when it's destroyed) or an untyped pointer
-        // which won't be deleted by the window - but not both of them

     void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
     wxClientData *GetClientObject() const { return DoGetClientObject(); }
 
     void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
     wxClientData *GetClientObject() const { return DoGetClientObject(); }
 


@@ -65,11 +72,11 @@ public:
     void *GetClientData() const { return DoGetClientData(); }
 
 protected:
     void *GetClientData() const { return DoGetClientData(); }
 
 protected:

-    // user data associated with the window: either an object which will be
-    // deleted by the window when it's deleted or some raw pointer which we do
-    // nothing with - only one type of data can be used with the given window
-    // (i.e. you cannot set the void data and then associate the window with
-    // wxClientData or vice versa)
+    // The user data: either an object which will be deleted by the container
+    // when it's deleted or some raw pointer which we do nothing with - only
+    // one type of data can be used with the given window (i.e. you cannot set
+    // the void data and then associate the container with wxClientData or vice
+    // versa)

     union
     {
         wxClientData *m_clientObject;
     union
     {
         wxClientData *m_clientObject;


@@ -88,6 +95,117 @@ protected:
 
 };
 
 
 };
 

+// not Motif-specific, but currently used only under Motif
+#ifdef __WXMOTIF__
+
+#include <wx/vector.h>
+
+struct WXDLLEXPORT wxClientDataDictionaryPair
+{
+    wxClientDataDictionaryPair( size_t idx ) : index( idx ), data( 0 ) { }
+
+    size_t index;
+    wxClientData* data;
+};
+
+WX_DECLARE_VECTOR(wxClientDataDictionaryPair,wxClientDataDictionaryPairVector);
+
+// this class is used internally to maintain the association between items
+// of (some subclasses of) wxControlWithItems and their client data
+// NOTE: this class does not keep track if it contains
+// wxClientData or void*, the client must ensure that
+// it does not contain a mix of the two, and that
+// DestroyData is called if it contains wxClientData
+class WXDLLEXPORT wxClientDataDictionary
+{
+public:
+    wxClientDataDictionary() {};
+
+    // deletes all the data
+    void DestroyData()
+    {
+        for( size_t i = 0, end = m_vec.size(); i != end; ++i )
+            delete m_vec[i].data;
+        m_vec.clear();
+    }
+
+    // if data for the given index is not present, add it,
+    // if it is present, delete the old data and replace it with
+    // the new one
+    void Set( size_t index, wxClientData* data, bool doDelete )
+    {
+        size_t ptr = Find( index );
+
+        if( !data )
+        {
+            if( ptr == m_vec.size() ) return;
+            if( doDelete )
+                delete m_vec[ptr].data;
+            m_vec.erase( ptr );
+        }
+        else
+        {
+            if( ptr == m_vec.size() )
+            {
+                m_vec.push_back( wxClientDataDictionaryPair( index ) );
+                ptr = m_vec.size() - 1;
+            }
+
+            if( doDelete )
+                delete m_vec[ptr].data;
+            m_vec[ptr].data = data;
+        }
+    }
+
+    // get the data associated with the given index,
+    // return 0 if not found
+    wxClientData* Get( size_t index ) const
+    {
+        size_t it = Find( index );
+        if( it == m_vec.size() ) return 0;
+        return (wxClientData*)m_vec[it].data; // const cast
+    }
+
+    // delete the data associated with the given index
+    // it also decreases by one the indices of all the elements
+    // with an index greater than the given index
+    void Delete( size_t index, bool doDelete )
+    {
+        size_t todel = m_vec.size();
+
+        for( size_t i = 0, end = m_vec.size(); i != end; ++i )
+        {
+            if( m_vec[i].index == index )
+                todel = i;
+            else if( m_vec[i].index > index )
+                --(m_vec[i].index);
+        }
+
+        if( todel != m_vec.size() )
+        {
+            if( doDelete )
+                delete m_vec[todel].data;
+            m_vec.erase( todel );
+        }
+    }
+private:
+    // returns MyVec.size() if not found
+    size_t Find( size_t index ) const
+    {
+        for( size_t i = 0, end = m_vec.size(); i != end; ++i )
+        {
+            if( m_vec[i].index == index )
+                return i;
+        }
+
+        return m_vec.size();
+    }
+
+    wxClientDataDictionaryPairVector m_vec;
+};
+
+#endif // __WXMOTIF__
+

 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------
 #endif