Better document wxAutomationObject::GetDispatchPtr() return value.

[wxWidgets.git] / interface / wx / variant.h

diff --git a/interface/wx/variant.h b/interface/wx/variant.h
index 3d2efeb4d3fd40b79e48b3fdf4cc7a4ebd26f11e..6fe96be13dff115a3d68ec8f26668948ca8494e2 100644 (file)
--- a/interface/wx/variant.h
+++ b/interface/wx/variant.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxVariant
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxVariant
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -12,6 +12,11 @@
     The wxVariant class represents a container for any type. A variant's value
     can be changed at run time, possibly to a different type of value.
 
     The wxVariant class represents a container for any type. A variant's value
     can be changed at run time, possibly to a different type of value.
 

+    @note As of wxWidgets 2.9.1, wxAny has become the preferred variant class.
+          While most controls still use wxVariant in their interface, you
+          can start using wxAny in your code because of an implicit conversion
+          layer. See below for more information.
+

     As standard, wxVariant can store values of type bool, wxChar, double, long,
     string, string list, time, date, void pointer, list of strings, and list of
     variants. However, an application can extend wxVariant's capabilities by
     As standard, wxVariant can store values of type bool, wxChar, double, long,
     string, string list, time, date, void pointer, list of strings, and list of
     variants. However, an application can extend wxVariant's capabilities by


@@ -85,10 +90,71 @@
     wxDynamicCast(), to use C++ RTTI type information instead of wxWidgets
     RTTI.
 
     wxDynamicCast(), to use C++ RTTI type information instead of wxWidgets
     RTTI.
 

+    @section variant_wxanyconversion wxVariant to wxAny Conversion Layer
+
+    wxAny is a more modern, template-based variant class. It is not
+    directly compatible with wxVariant, but there is a transparent conversion
+    layer.
+
+    Following is an example how to use these conversions with wxPropertyGrid's
+    property class wxPGProperty (which currently uses wxVariants both
+    internally and in the public API):
+
+    @code
+        // Get property value as wxAny instead of wxVariant
+        wxAny value = property->GetValue();
+
+        // Do something with it
+        DoSomethingWithString(value.As<wxString>());
+
+        // Write back new value to property
+        value = "New Value";
+        property->SetValue(value);
+
+    @endcode
+
+    Some caveats:
+    @li In wxAny, there are no separate types for handling integers of
+        different sizes, so converting wxAny with 'long long' value
+        will yield wxVariant of "long" type when the value is small
+        enough to fit in without overflow. Otherwise, variant type
+        "longlong" is used. Also note that wxAny holding unsigned integer
+        will always be converted to "ulonglong" wxVariant type.
+
+    @li Unlike wxVariant, wxAny does not store a (rarely needed) name string.
+
+    @li Because of implicit conversion of wxVariant to wxAny, wxAny cannot
+        usually contain value of type wxVariant. In other words,
+        any.CheckType<wxVariant>() can never return @true.
+
+    Supplied conversion functions will automatically work with all
+    built-in wxVariant types, and also with all user-specified types generated
+    using IMPLEMENT_VARIANT_OBJECT(). For hand-built wxVariantData classes,
+    you will need to use supplied macros in a following manner:
+
+    @code
+
+    // Declare wxVariantData for data type Foo
+    class wxVariantDataFoo: public wxVariantData
+    {
+    public:
+        // interface
+        // ...
+
+        DECLARE_WXANY_CONVERSION()
+    protected:
+        // data storage etc
+        // ...
+    };
+
+    IMPLEMENT_TRIVIAL_WXANY_CONVERSION(Foo, wxVariantDataFoo)
+
+    @endcode
+

     @library{wxbase}
     @category{data}
 
     @library{wxbase}
     @category{data}
 

-    @see wxVariantData
+    @see wxVariantData, wxAny

 */
 class wxVariant : public wxObject
 {
 */
 class wxVariant : public wxObject
 {


@@ -111,6 +177,11 @@ public:
     */
     wxVariant(const wxVariant& variant);
 
     */
     wxVariant(const wxVariant& variant);
 

+    /**
+        Constructs a variant by converting it from wxAny.
+    */
+    wxVariant(const wxAny& any);
+

     /**
         Constructs a variant from a wide string literal.
     */
     /**
         Constructs a variant from a wide string literal.
     */


@@ -141,6 +212,16 @@ public:
     */
     wxVariant(double value, const wxString& name = wxEmptyString);
 
     */
     wxVariant(double value, const wxString& name = wxEmptyString);
 

+    /**
+        Constructs a variant from a wxLongLong.
+    */
+    wxVariant(wxLongLong value, const wxString& name = wxEmptyString);
+
+    /**
+        Constructs a variant from a wxULongLong.
+    */
+    wxVariant(wxULongLong value, const wxString& name = wxEmptyString);
+

     /**
         Constructs a variant from a list of variants
     */
     /**
         Constructs a variant from a list of variants
     */


@@ -250,9 +331,16 @@ public:
     bool Convert(double* value) const;
     bool Convert(wxString* value) const;
     bool Convert(wxChar* value) const;
     bool Convert(double* value) const;
     bool Convert(wxString* value) const;
     bool Convert(wxChar* value) const;

+    bool Convert(wxLongLong* value) const;
+    bool Convert(wxULongLong* value) const;

     bool Convert(wxDateTime* value) const;
     //@}
 
     bool Convert(wxDateTime* value) const;
     //@}
 

+    /**
+        Converts wxVariant into wxAny.
+    */
+    wxAny GetAny() const;
+

     /**
         Returns the string array value.
     */
     /**
         Returns the string array value.
     */


@@ -290,6 +378,11 @@ public:
     */
     long GetLong() const;
 
     */
     long GetLong() const;
 

+    /**
+        Returns the signed 64-bit integer value.
+    */
+    wxLongLong GetLongLong() const;
+

     /**
         Returns a constant reference to the variant name.
     */
     /**
         Returns a constant reference to the variant name.
     */


@@ -310,7 +403,9 @@ public:
         - "double"
         - "list"
         - "long"
         - "double"
         - "list"
         - "long"

+        - "longlong"

         - "string"
         - "string"

+        - "ulonglong"

         - "arrstring"
         - "void*"
 
         - "arrstring"
         - "void*"
 


@@ -319,8 +414,16 @@ public:
     */
     wxString GetType() const;
 
     */
     wxString GetType() const;
 

+    /**
+        Returns the unsigned 64-bit integer value.
+    */
+    wxULongLong GetULongLong() const;
+

     /**
         Gets the void pointer value.
     /**
         Gets the void pointer value.

+
+        Notice that this method can be used for null objects (i.e. those for
+        which IsNull() returns @true) and will return @NULL for them.

     */
     void* GetVoidPtr() const;
 
     */
     void* GetVoidPtr() const;
 


@@ -387,6 +490,8 @@ public:
     bool operator !=(long value) const;
     bool operator !=(bool value) const;
     bool operator !=(double value) const;
     bool operator !=(long value) const;
     bool operator !=(bool value) const;
     bool operator !=(double value) const;

+    bool operator !=(wxLongLong value) const;
+    bool operator !=(wxULongLong value) const;

     bool operator !=(void* value) const;
     bool operator !=(wxObject* value) const;
     bool operator !=(const wxVariantList& value) const;
     bool operator !=(void* value) const;
     bool operator !=(wxObject* value) const;
     bool operator !=(const wxVariantList& value) const;


@@ -407,6 +512,8 @@ public:
     void operator =(long value);
     void operator =(bool value);
     void operator =(double value);
     void operator =(long value);
     void operator =(bool value);
     void operator =(double value);

+    bool operator =(wxLongLong value) const;
+    bool operator =(wxULongLong value) const;

     void operator =(void* value);
     void operator =(wxObject* value);
     void operator =(const wxVariantList& value);
     void operator =(void* value);
     void operator =(wxObject* value);
     void operator =(const wxVariantList& value);


@@ -425,6 +532,8 @@ public:
     bool operator ==(long value) const;
     bool operator ==(bool value) const;
     bool operator ==(double value) const;
     bool operator ==(long value) const;
     bool operator ==(bool value) const;
     bool operator ==(double value) const;

+    bool operator ==(wxLongLong value) const;
+    bool operator ==(wxULongLong value) const;

     bool operator ==(void* value) const;
     bool operator ==(wxObject* value) const;
     bool operator ==(const wxVariantList& value) const;
     bool operator ==(void* value) const;
     bool operator ==(wxObject* value) const;
     bool operator ==(const wxVariantList& value) const;


@@ -434,10 +543,13 @@ public:
 
     //@{
     /**
 
     //@{
     /**

-        Operator for implicit conversion to a long, using GetLong().
+        Operators for implicit conversion, using appropriate getter member
+        function.

     */
     double operator double() const;
     long operator long() const;
     */
     double operator double() const;
     long operator long() const;

+    wxLongLong operator wxLongLong() const;
+    wxULongLong operator wxULongLong() const;

     //@}
 
     /**
     //@}
 
     /**


@@ -487,7 +599,7 @@ public:
 
     @see wxVariant, wxGetVariantCast()
 */
 
     @see wxVariant, wxGetVariantCast()
 */

-class wxVariantData
+class wxVariantData : public wxObjectRefData

 {
 public:
     /**
 {
 public:
     /**


@@ -516,6 +628,11 @@ public:
     */
     virtual bool Eq(wxVariantData& data) const = 0;
 
     */
     virtual bool Eq(wxVariantData& data) const = 0;
 

+    /**
+        Converts value to wxAny, if possible. Return @true if successful.
+    */
+    virtual bool GetAny(wxAny* any) const;
+

     /**
         Returns the string type of the data.
     */
     /**
         Returns the string type of the data.
     */


@@ -559,7 +676,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_rtti */
+/** @addtogroup group_funcmacro_rtti */

 //@{
 
 /**
 //@{
 
 /**