Clarified wxPropertyGrid::HitTest() docs

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

diff --git a/include/wx/object.h b/include/wx/object.h
index a1d021fa9124bed4b9ec81316d3f419dce719b42..b5f34262d63739fc241dd31fb733da926f880de0 100644 (file)
--- a/include/wx/object.h
+++ b/include/wx/object.h
@@ -19,12 +19,44 @@
 
 #include "wx/memory.h"
 
 
 #include "wx/memory.h"
 

-class WXDLLIMPEXP_BASE wxObject;
+class WXDLLIMPEXP_FWD_BASE wxObject;
+class WXDLLIMPEXP_FWD_BASE wxString;

 
 #ifndef wxUSE_EXTENDED_RTTI
 #define wxUSE_EXTENDED_RTTI 0
 #endif
 
 
 #ifndef wxUSE_EXTENDED_RTTI
 #define wxUSE_EXTENDED_RTTI 0
 #endif
 

+#define DECLARE_CLASS_INFO_ITERATORS()                                       \
+    class WXDLLIMPEXP_BASE const_iterator                                    \
+    {                                                                        \
+        typedef wxHashTable_Node Node;                                       \
+    public:                                                                  \
+        typedef const wxClassInfo* value_type;                               \
+        typedef const value_type& const_reference;                           \
+        typedef const_iterator itor;                                         \
+        typedef value_type* ptr_type;                                        \
+                                                                             \
+        Node* m_node;                                                        \
+        wxHashTable* m_table;                                                \
+    public:                                                                  \
+        typedef const_reference reference_type;                              \
+        typedef ptr_type pointer_type;                                       \
+                                                                             \
+        const_iterator(Node* node, wxHashTable* table)                       \
+            : m_node(node), m_table(table) { }                               \
+        const_iterator() : m_node(NULL), m_table(NULL) { }                   \
+        value_type operator*() const;                                        \
+        itor& operator++();                                                  \
+        const itor operator++(int);                                          \
+        bool operator!=(const itor& it) const                                \
+            { return it.m_node != m_node; }                                  \
+        bool operator==(const itor& it) const                                \
+            { return it.m_node == m_node; }                                  \
+    };                                                                       \
+                                                                             \
+    static const_iterator begin_classinfo();                                 \
+    static const_iterator end_classinfo();
+

 #if wxUSE_EXTENDED_RTTI
 #include "wx/xti.h"
 #else
 #if wxUSE_EXTENDED_RTTI
 #include "wx/xti.h"
 #else


@@ -33,9 +65,12 @@ class WXDLLIMPEXP_BASE wxObject;
 // conditional compilation
 // ----------------------------------------------------------------------------
 
 // conditional compilation
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxClassInfo;
-class WXDLLIMPEXP_BASE wxHashTable;
-class WXDLLIMPEXP_BASE wxObjectRefData;
+class WXDLLIMPEXP_FWD_BASE wxClassInfo;
+class WXDLLIMPEXP_FWD_BASE wxHashTable;
+class WXDLLIMPEXP_FWD_BASE wxObject;
+class WXDLLIMPEXP_FWD_BASE wxPluginLibrary;
+class WXDLLIMPEXP_FWD_BASE wxObjectRefData;
+class WXDLLIMPEXP_FWD_BASE wxHashTable_Node;

 
 // ----------------------------------------------------------------------------
 // wxClassInfo
 
 // ----------------------------------------------------------------------------
 // wxClassInfo


@@ -45,6 +80,8 @@ typedef wxObject *(*wxObjectConstructorFn)(void);
 
 class WXDLLIMPEXP_BASE wxClassInfo
 {
 
 class WXDLLIMPEXP_BASE wxClassInfo
 {

+    friend class WXDLLIMPEXP_FWD_BASE wxObject;
+    friend WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name);

 public:
     wxClassInfo( const wxChar *className,
                  const wxClassInfo *baseInfo1,
 public:
     wxClassInfo( const wxChar *className,
                  const wxClassInfo *baseInfo1,


@@ -81,7 +118,7 @@ public:
         { return m_objectConstructor; }
     static const wxClassInfo  *GetFirst() { return sm_first; }
     const wxClassInfo         *GetNext() const { return m_next; }
         { return m_objectConstructor; }
     static const wxClassInfo  *GetFirst() { return sm_first; }
     const wxClassInfo         *GetNext() const { return m_next; }

-    static wxClassInfo        *FindClass(const wxChar *className);
+    static wxClassInfo        *FindClass(const wxString& className);

 
         // Climb upwards through inheritance hierarchy.
         // Dual inheritance is catered for.
 
         // Climb upwards through inheritance hierarchy.
         // Dual inheritance is catered for.


@@ -94,7 +131,8 @@ public:
                  ( m_baseInfo2 && m_baseInfo2->IsKindOf(info) ) );
     }
 
                  ( m_baseInfo2 && m_baseInfo2->IsKindOf(info) ) );
     }
 

-public:
+    DECLARE_CLASS_INFO_ITERATORS()
+private:

     const wxChar            *m_className;
     int                      m_objectSize;
     wxObjectConstructorFn    m_objectConstructor;
     const wxChar            *m_className;
     int                      m_objectSize;
     wxObjectConstructorFn    m_objectConstructor;


@@ -110,8 +148,6 @@ public:
     static wxClassInfo      *sm_first;
     wxClassInfo             *m_next;
 
     static wxClassInfo      *sm_first;
     wxClassInfo             *m_next;
 

-    // FIXME: this should be private (currently used directly by way too
-    //        many clients)

     static wxHashTable      *sm_classTable;
 
 protected:
     static wxHashTable      *sm_classTable;
 
 protected:


@@ -119,10 +155,10 @@ protected:
     void Register();
     void Unregister();
 
     void Register();
     void Unregister();
 

-    DECLARE_NO_COPY_CLASS(wxClassInfo)
+    wxDECLARE_NO_COPY_CLASS(wxClassInfo);

 };
 
 };
 

-WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxChar *name);
+WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name);

 
 // ----------------------------------------------------------------------------
 // Dynamic class macros
 
 // ----------------------------------------------------------------------------
 // Dynamic class macros


@@ -242,9 +278,9 @@ name##PluginSentinel  m_pluginsentinel;
 #endif  // wxUSE_NESTED_CLASSES
 
 #define DECLARE_PLUGGABLE_CLASS(name) \
 #endif  // wxUSE_NESTED_CLASSES
 
 #define DECLARE_PLUGGABLE_CLASS(name) \

- DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
+ DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE)

 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)  \
 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)  \

- DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
+ DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE)

 
 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
  DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
 
 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
  DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)


@@ -283,8 +319,8 @@ name##PluginSentinel  m_pluginsentinel;
 // be replaced by it as long as there are any compilers not supporting it
 #define wxDynamicCast(obj, className) \
     ((className *) wxCheckDynamicCast( \
 // be replaced by it as long as there are any compilers not supporting it
 #define wxDynamicCast(obj, className) \
     ((className *) wxCheckDynamicCast( \

-        wx_const_cast(wxObject *, wx_static_cast(const wxObject *, \
-          wx_const_cast(className *, wx_static_cast(const className *, obj)))), \
+        const_cast<wxObject *>(static_cast<const wxObject *>(\
+          const_cast<className *>(static_cast<const className *>(obj)))), \

         &className::ms_classInfo))
 
 // The 'this' pointer is always true, so use this version
         &className::ms_classInfo))
 
 // The 'this' pointer is always true, so use this version


@@ -303,7 +339,7 @@ inline void* wxCheckCast(void *ptr)
 
 #else  // !__WXDEBUG__
 #define wxStaticCast(obj, className) \
 
 #else  // !__WXDEBUG__
 #define wxStaticCast(obj, className) \

-    wx_const_cast(className *, wx_static_cast(const className *, obj))
+    const_cast<className *>(static_cast<const className *>(obj))

 
 #endif  // __WXDEBUG__
 
 
 #endif  // __WXDEBUG__
 


@@ -372,7 +408,7 @@ inline void* wxCheckCast(void *ptr)
 
 class WXDLLIMPEXP_BASE wxObjectRefData
 {
 
 class WXDLLIMPEXP_BASE wxObjectRefData
 {

-    friend class WXDLLIMPEXP_BASE wxObject;
+    friend class WXDLLIMPEXP_FWD_BASE wxObject;

 
 public:
     wxObjectRefData() : m_count(1) { }
 
 public:
     wxObjectRefData() : m_count(1) { }


@@ -406,21 +442,40 @@ public:
     wxEXPLICIT wxObjectDataPtr(T *ptr = NULL) : m_ptr(ptr) {}
 
     // copy ctor
     wxEXPLICIT wxObjectDataPtr(T *ptr = NULL) : m_ptr(ptr) {}
 
     // copy ctor

-    wxObjectDataPtr(const wxObjectDataPtr<T> &tocopy) 
+    wxObjectDataPtr(const wxObjectDataPtr<T> &tocopy)

         : m_ptr(tocopy.m_ptr)
         : m_ptr(tocopy.m_ptr)

-    { 
+    {

         if (m_ptr)
         if (m_ptr)

-            m_ptr->IncRef(); 
+            m_ptr->IncRef();

     }
 
     }
 

-    ~wxObjectDataPtr() 
-    { 
-        if (m_ptr) 
-            m_ptr->DecRef(); 
+    ~wxObjectDataPtr()
+    {
+        if (m_ptr)
+            m_ptr->DecRef();

     }
 
     T *get() const { return m_ptr; }
     }
 
     T *get() const { return m_ptr; }

-    T *operator->() const { return get(); }
+
+    // test for pointer validity: defining conversion to unspecified_bool_type
+    // and not more obvious bool to avoid implicit conversions to integer types
+    typedef T *(wxObjectDataPtr<T>::*unspecified_bool_type)() const;
+    operator unspecified_bool_type() const
+    {
+        return m_ptr ? &wxObjectDataPtr<T>::get : NULL;
+    }
+
+    T& operator*() const
+    {
+        wxASSERT(m_ptr != NULL);
+        return *(m_ptr);
+    }
+
+    T *operator->() const
+    {
+        wxASSERT(m_ptr != NULL);
+        return get();
+    }

 
     void reset(T *ptr)
     {
 
     void reset(T *ptr)
     {


@@ -430,22 +485,20 @@ public:
     }
 
     wxObjectDataPtr& operator=(const wxObjectDataPtr &tocopy)
     }
 
     wxObjectDataPtr& operator=(const wxObjectDataPtr &tocopy)

-    { 
-        if (m_ptr) 
-            m_ptr->DecRef(); 
-        m_ptr = tocopy.m_ptr; 
+    {

         if (m_ptr)
         if (m_ptr)

-            m_ptr->IncRef(); 
+            m_ptr->DecRef();
+        m_ptr = tocopy.m_ptr;
+        if (m_ptr)
+            m_ptr->IncRef();

         return *this;
     }
 
     wxObjectDataPtr& operator=(T *ptr)
         return *this;
     }
 
     wxObjectDataPtr& operator=(T *ptr)

-    { 
-        if (m_ptr) 
-            m_ptr->DecRef(); 
-        m_ptr = ptr; 
+    {

         if (m_ptr)
         if (m_ptr)

-            m_ptr->IncRef(); 
+            m_ptr->DecRef();
+        m_ptr = ptr;

         return *this;
     }
 
         return *this;
     }
 


@@ -481,7 +534,7 @@ public:
         return *this;
     }
 
         return *this;
     }
 

-    bool IsKindOf(wxClassInfo *info) const;
+    bool IsKindOf(const wxClassInfo *info) const;

 
 
     // Turn on the correct set of new and delete operators
 
 
     // Turn on the correct set of new and delete operators


@@ -558,7 +611,7 @@ inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
 #if wxUSE_EXTENDED_RTTI
 class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject
 {
 #if wxUSE_EXTENDED_RTTI
 class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject
 {

-    friend class WXDLLIMPEXP_BASE wxDynamicClassInfo ;
+    friend class WXDLLIMPEXP_FWD_BASE wxDynamicClassInfo ;

 public:
     // instantiates this object with an instance of its superclass
     wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ;
 public:
     // instantiates this object with an instance of its superclass
     wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ;


@@ -573,8 +626,8 @@ public:
 #ifdef _MSC_VER
         return (wxClassInfo*) m_classInfo;
 #else
 #ifdef _MSC_VER
         return (wxClassInfo*) m_classInfo;
 #else

-        wxDynamicClassInfo *nonconst = wx_const_cast(wxDynamicClassInfo *, m_classInfo);
-        return wx_static_cast(wxClassInfo *, nonconst);
+        wxDynamicClassInfo *nonconst = const_cast<wxDynamicClassInfo *>(m_classInfo);
+        return static_cast<wxClassInfo *>(nonconst);

 #endif
     }
 
 #endif
     }