Changed wxImage::ConvertAlphaToMask() return type to bool.

[wxWidgets.git] / interface / wx / msw / ole / automtn.h

diff --git a/interface/wx/msw/ole/automtn.h b/interface/wx/msw/ole/automtn.h
index e8fe35671bfa5419693468e2a43b7781fc601544..9e0359177b0cb65275eef42a180146745aa7850f 100644 (file)
--- a/interface/wx/msw/ole/automtn.h
+++ b/interface/wx/msw/ole/automtn.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxAutomationObject
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxAutomationObject
-    @headerfile ole/automtn.h wx/msw/ole/automtn.h
 
     The @b wxAutomationObject class represents an OLE automation object containing
     a single data member,
@@ -34,7 +33,7 @@
     @onlyfor{wxmsw}
 
     @library{wxcore}
-    @category{misc}
+    @category{data}
 
     @see wxVariant
 */
@@ -82,10 +81,23 @@ public:
     */
     bool CreateInstance(const wxString& classId) const;
 
+    /**
+        Checks if the object is in a valid state.
+
+        Returns @true if the object was successfully initialized or @false if
+        it has no valid IDispatch pointer.
+
+        @see GetDispatchPtr()
+     */
+    bool IsOk() const;
+
     /**
         Gets the IDispatch pointer.
+
+        Notice that the return value of this function is an untyped pointer but
+        it can be safely cast to @c IDispatch.
     */
-    IDispatch* GetDispatchPtr() const;
+    void* GetDispatchPtr() const;
 
     /**
         Retrieves the current object associated with a class id, and attaches the