include/wx/clntdata.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/clntdata.h
   3 // Purpose:     A mixin class for holding a wxClientData or void pointer
   4 // Author:      Robin Dunn
   5 // Modified by:
   6 // Created:     9-Oct-2001
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWidgets team
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CLNTDATAH__
  13 #define _WX_CLNTDATAH__
  14
  15 #include "wx/defs.h"
  16 #include "wx/string.h"
  17 #include "wx/hashmap.h"
  18
  19 typedef int (*wxShadowObjectMethod)(void*, void*);
  20 WX_DECLARE_STRING_HASH_MAP_WITH_DECL(
  21     wxShadowObjectMethod,
  22     wxShadowObjectMethods,
  23     class WXDLLIMPEXP_BASE
  24 );
  25 WX_DECLARE_STRING_HASH_MAP_WITH_DECL(
  26     void *,
  27     wxShadowObjectFields,
  28     class WXDLLIMPEXP_BASE
  29 );
  30
  31 class WXDLLIMPEXP_BASE wxShadowObject
  32 {
  33 public:
  34     wxShadowObject() { }
  35
  36     void AddMethod( const wxString &name, wxShadowObjectMethod method )
  37     {
  38         wxShadowObjectMethods::iterator it = m_methods.find( name );
  39         if (it == m_methods.end())
  40             m_methods[ name ] = method;
  41         else
  42             it->second = method;
  43     }
  44
  45     bool InvokeMethod( const wxString &name, void* window, void* param, int* returnValue )
  46     {
  47         wxShadowObjectMethods::iterator it = m_methods.find( name );
  48         if (it == m_methods.end())
  49             return false;
  50         wxShadowObjectMethod method = it->second;
  51         int ret = (*method)(window, param);
  52         if (returnValue)
  53             *returnValue = ret;
  54         return true;
  55     }
  56
  57     void AddField( const wxString &name, void* initialValue = NULL )
  58     {
  59         wxShadowObjectFields::iterator it = m_fields.find( name );
  60         if (it == m_fields.end())
  61             m_fields[ name ] = initialValue;
  62         else
  63             it->second = initialValue;
  64     }
  65
  66     void SetField( const wxString &name, void* value )
  67     {
  68         wxShadowObjectFields::iterator it = m_fields.find( name );
  69         if (it == m_fields.end())
  70             return;
  71         it->second = value;
  72     }
  73
  74     void* GetField( const wxString &name, void *defaultValue = NULL )
  75     {
  76         wxShadowObjectFields::iterator it = m_fields.find( name );
  77         if (it == m_fields.end())
  78             return defaultValue;
  79         return it->second;
  80     }
  81
  82 private:
  83     wxShadowObjectMethods   m_methods;
  84     wxShadowObjectFields    m_fields;
  85 };
  86
  87
  88 // ----------------------------------------------------------------------------
  89
  90 // what kind of client data do we have?
  91 enum wxClientDataType
  92 {
  93     wxClientData_None,    // we don't know yet because we don't have it at all
  94     wxClientData_Object,  // our client data is typed and we own it
  95     wxClientData_Void     // client data is untyped and we don't own it
  96 };
  97
  98 class WXDLLIMPEXP_BASE wxClientData
  99 {
 100 public:
 101     wxClientData() { }
 102     virtual ~wxClientData() { }
 103 };
 104
 105 class WXDLLIMPEXP_BASE wxStringClientData : public wxClientData
 106 {
 107 public:
 108     wxStringClientData() : m_data() { }
 109     wxStringClientData( const wxString &data ) : m_data(data) { }
 110     void SetData( const wxString &data ) { m_data = data; }
 111     const wxString& GetData() const { return m_data; }
 112
 113 private:
 114     wxString  m_data;
 115 };
 116
 117 // This class is a mixin that provides storage and management of "client
 118 // data."  The client data stored can either be a pointer to a wxClientData
 119 // object in which case it is managed by the container (i.e. it will delete
 120 // the data when it's destroyed) or an untyped pointer which won't be deleted
 121 // by the container - but not both of them
 122 //
 123 // NOTE:  This functionality is currently duplicated in wxEvtHandler in order
 124 //        to avoid having more than one vtable in that class hierarchy.
 125
 126 class WXDLLIMPEXP_BASE wxClientDataContainer
 127 {
 128 public:
 129     wxClientDataContainer();
 130     virtual ~wxClientDataContainer();
 131
 132     void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
 133     wxClientData *GetClientObject() const { return DoGetClientObject(); }
 134
 135     void SetClientData( void *data ) { DoSetClientData(data); }
 136     void *GetClientData() const { return DoGetClientData(); }
 137
 138 protected:
 139     // The user data: either an object which will be deleted by the container
 140     // when it's deleted or some raw pointer which we do nothing with. Only
 141     // one type of data can be used with the given window, i.e. you cannot set
 142     // the void data and then associate the container with wxClientData or vice
 143     // versa.
 144     union
 145     {
 146         wxClientData *m_clientObject;
 147         void         *m_clientData;
 148     };
 149
 150     // client data accessors
 151     virtual void DoSetClientObject( wxClientData *data );
 152     virtual wxClientData *DoGetClientObject() const;
 153
 154     virtual void DoSetClientData( void *data );
 155     virtual void *DoGetClientData() const;
 156
 157     // what kind of data do we have?
 158     wxClientDataType m_clientDataType;
 159
 160 };
 161
 162 #endif // _WX_CLNTDATAH__
 163