using Run of base class

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

diff --git a/include/wx/clntdata.h b/include/wx/clntdata.h
index e91f2391b21037cb714310d79ecff9823cb9f568..a41ccc0ea92663179dc3bf9dffe3e03c3422f91b 100644 (file)
--- a/include/wx/clntdata.h
+++ b/include/wx/clntdata.h
@@ -4,19 +4,85 @@
 // Author:      Robin Dunn
 // Modified by:
 // Created:     9-Oct-2001
-// RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CLNTDATAH__
 #define _WX_CLNTDATAH__
 
-#ifdef __GNUG__
-    #pragma interface "event.h"
-#endif
-
 #include "wx/defs.h"
+#include "wx/string.h"
+#include "wx/hashmap.h"
+
+typedef int (*wxShadowObjectMethod)(void*, void*);
+WX_DECLARE_STRING_HASH_MAP_WITH_DECL(
+    wxShadowObjectMethod,
+    wxShadowObjectMethods,
+    class WXDLLIMPEXP_BASE
+);
+WX_DECLARE_STRING_HASH_MAP_WITH_DECL(
+    void *,
+    wxShadowObjectFields,
+    class WXDLLIMPEXP_BASE
+);
+
+class WXDLLIMPEXP_BASE wxShadowObject
+{
+public:
+    wxShadowObject() { }
+
+    void AddMethod( const wxString &name, wxShadowObjectMethod method )
+    {
+        wxShadowObjectMethods::iterator it = m_methods.find( name );
+        if (it == m_methods.end())
+            m_methods[ name ] = method;
+        else
+            it->second = method;
+    }
+
+    bool InvokeMethod( const wxString &name, void* window, void* param, int* returnValue )
+    {
+        wxShadowObjectMethods::iterator it = m_methods.find( name );
+        if (it == m_methods.end())
+            return false;
+        wxShadowObjectMethod method = it->second;
+        int ret = (*method)(window, param);
+        if (returnValue)
+            *returnValue = ret;
+        return true;
+    }
+
+    void AddField( const wxString &name, void* initialValue = NULL )
+    {
+        wxShadowObjectFields::iterator it = m_fields.find( name );
+        if (it == m_fields.end())
+            m_fields[ name ] = initialValue;
+        else
+            it->second = initialValue;
+    }
+
+    void SetField( const wxString &name, void* value )
+    {
+        wxShadowObjectFields::iterator it = m_fields.find( name );
+        if (it == m_fields.end())
+            return;
+        it->second = value;
+    }
+
+    void* GetField( const wxString &name, void *defaultValue = NULL )
+    {
+        wxShadowObjectFields::iterator it = m_fields.find( name );
+        if (it == m_fields.end())
+            return defaultValue;
+        return it->second;
+    }
+
+private:
+    wxShadowObjectMethods   m_methods;
+    wxShadowObjectFields    m_fields;
+};
+
 
 // ----------------------------------------------------------------------------
 
@@ -28,17 +94,17 @@ enum wxClientDataType
     wxClientData_Void     // client data is untyped and we don't own it
 };
 
-class WXDLLEXPORT wxClientData
+class WXDLLIMPEXP_BASE wxClientData
 {
 public:
     wxClientData() { }
     virtual ~wxClientData() { }
 };
 
-class WXDLLEXPORT wxStringClientData : public wxClientData
+class WXDLLIMPEXP_BASE 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; }
@@ -47,17 +113,21 @@ private:
     wxString  m_data;
 };
 
+// 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 hierarchy.
 
-class WXDLLEXPORT wxClientDataContainer
+class WXDLLIMPEXP_BASE 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(); }
 
@@ -65,11 +135,11 @@ public:
     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;
@@ -88,6 +158,5 @@ protected:
 
 };
 
-// ----------------------------------------------------------------------------
-#endif
+#endif // _WX_CLNTDATAH__