added interface headers with latest discussed changes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/ptr_shrd.h

@@ -0,0 +1,85 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        ptr_shrd.h
+// Purpose:     documentation for wxSharedPtr<T> class
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxSharedPtrT
+    @wxheader{ptr_shrd.h}
+    
+    A smart pointer with non-intrusive reference counting. It is modeled
+    after @b boost::shared_ptr and can be used with STL containers 
+    and wxVector - unlike @b std::auto_ptr
+    and wxScopedPtr.
+    
+    @library{wxbase}
+    @category{FIXME}
+    
+    @seealso
+    wxScopedPtr, wxWeakRef, wxObjectDataPtr
+*/
+class wxSharedPtr<T> 
+{
+public:
+    //@{
+    /**
+        Constructors.
+    */
+    wxSharedPtrT(T* ptr = @NULL);
+        wxSharedPtrT(const wxSharedPtr<T>& tocopy);
+    //@}
+
+    /**
+        Destructor.
+    */
+    ~wxSharedPtrT();
+
+    /**
+        Returns pointer to its object or @NULL.
+    */
+    T* get();
+
+    /**
+        Conversion to a boolean expression (in a variant which is not 
+        convertable to anything but a boolean expression). If this class
+        contains a valid pointer it will return @e @true, if it contains
+        a @NULL pointer it will return @e @false.
+    */
+     operator unspecified_bool_type();
+
+    /**
+        Returns a reference to the object. If the internal pointer is @NULL this
+        method will cause an assert in debug mode.
+    */
+    T operator*();
+
+    /**
+        Returns pointer to its object or @NULL.
+    */
+    T* operator-();
+
+    /**
+        Assignment operator. Releases any previously held pointer
+        and creates a reference to @e ptr.
+    */
+    wxSharedPtrT& operator operator=(T * ptr);
+
+    /**
+        Reset pointer to @e ptr. If the reference count of the
+        previously owned pointer was 1 it will be deleted.
+    */
+    void reset(T * ptr = @NULL);
+
+    /**
+        Returns @true if this is the only pointer pointing to its object.
+    */
+    bool unique();
+
+    /**
+        Returns the number of pointers pointing to its object.
+    */
+    long use_count();
+};