Doc fixes A-M edition. Thanks to Arnout for pointing these out. Also I fixed some...

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

diff --git a/include/wx/clntdata.h b/include/wx/clntdata.h
index 1b0f1792aac61d2f8af1d2f0d7142b41cd51c12b..83cdd0cf4b524dc0d3fd03272f4994fb05e91c54 100644 (file)
--- a/include/wx/clntdata.h
+++ b/include/wx/clntdata.h
@@ -5,14 +5,14 @@
 // Modified by:
 // Created:     9-Oct-2001
 // RCS-ID:      $Id$
 // 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__
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CLNTDATAH__
 #define _WX_CLNTDATAH__
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "clntdata.h"
 #endif
 
     #pragma interface "clntdata.h"
 #endif
 


@@ -29,14 +29,14 @@ enum wxClientDataType
     wxClientData_Void     // client data is untyped and we don't own it
 };
 
     wxClientData_Void     // client data is untyped and we don't own it
 };
 

-class WXDLLEXPORT wxClientData
+class WXDLLIMPEXP_BASE wxClientData

 {
 public:
     wxClientData() { }
     virtual ~wxClientData() { }
 };
 
 {
 public:
     wxClientData() { }
     virtual ~wxClientData() { }
 };
 

-class WXDLLEXPORT wxStringClientData : public wxClientData
+class WXDLLIMPEXP_BASE wxStringClientData : public wxClientData

 {
 public:
     wxStringClientData() : m_data() { }
 {
 public:
     wxStringClientData() : m_data() { }


@@ -48,18 +48,16 @@ private:
     wxString  m_data;
 };
 
     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
 // 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
+// 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
 // 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.
+//        to avoid having more than one vtable in that class hierarchy.

 
 

-class WXDLLEXPORT wxClientDataContainer
+class WXDLLIMPEXP_BASE wxClientDataContainer

 {
 public:
     wxClientDataContainer();
 {
 public:
     wxClientDataContainer();


@@ -73,10 +71,10 @@ public:
 
 protected:
     // The user data: either an object which will be deleted by the container
 
 protected:
     // 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
+    // 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
     // the void data and then associate the container with wxClientData or vice

-    // versa)
+    // versa.

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


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

+// not Motif-specific, but currently used only under Motif
+#ifdef __WXMOTIF__
+
+#include <wx/vector.h>
+
+struct WXDLLIMPEXP_BASE 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 of whether 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 WXDLLIMPEXP_BASE 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