Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/any.h b/interface/wx/any.h
index 826d2b7a1488f3ed5cb8337e0837fcc022a4c168..6862746c886273bbd5df78965306e53efca4439d 100644 (file)
--- a/interface/wx/any.h
+++ b/interface/wx/any.h
@@ -2,8 +2,7 @@
 // Name:        any.h
 // Purpose:     interface of wxAny
 // Author:      wxWidgets team
 // Name:        any.h
 // Purpose:     interface of wxAny
 // Author:      wxWidgets team

-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -45,23 +44,13 @@
 
     When compared to wxVariant, there are various internal implementation
     differences as well. For instance, wxAny only allocates separate data
 
     When compared to wxVariant, there are various internal implementation
     differences as well. For instance, wxAny only allocates separate data

-    object in heap for large (ie. size in bytes more than
-    WX_ANY_VALUE_BUFFER_SIZE) or 'non-movable' data types. Pointers, integers,
-    bools etc. are fitted in the wxAny's own buffer without need for any extra
-    allocation. Use following code to declare your own data type as 'movable':
+    object in heap for large objects (i.e. ones with size more than
+    WX_ANY_VALUE_BUFFER_SIZE, which at the time of writing is 16 bytes).

 
 

-    @code
-    #include "wx/meta/movable.h"
-    WX_DECLARE_TYPE_MOVABLE(MyClass)
-    @endcode
-
-    However, you must be aware that 'movable' means such data that can be
-    copied with memcpy() without corrupting program integrity. For instance,
-    movable objects usually cannot contain pointers or references to other
-    data. wxRect, wxPoint, and wxSize are good examples of movable classes.
-
-    Note that pointers to any and all classes are already automatically
-    declared as movable data.
+    @note When performing conversions between strings and floating point
+        numbers, the representation of numbers in C locale is always used.
+        I.e. @code wxAny("1.23").GetAs<double>() @endcode will always work,
+        even if the current locale uses comma as decimal separator.

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


@@ -104,14 +93,17 @@ public:
     ~wxAny();
 
     /**
     ~wxAny();
 
     /**

-        This template function converts wxAny into given type. No dynamic
-        conversion is performed, so if the type is incorrect an assertion
-        failure will occur in debug builds, and a bogus value is returned
-        in release ones.
+        This template function converts wxAny into given type. In most cases
+        no type conversion is performed, so if the type is incorrect an
+        assertion failure will occur.

 
 

-        @remarks This template function may not work properly with Visual C++
-                6. For full compiler compatibility, please use
-                wxANY_AS(any, T) macro instead.
+        @remarks For conveniency, conversion is done when T is wxString. This
+                 is useful when a string literal (which are treated as
+                 const char* and const wchar_t*) has been assigned to wxAny.
+
+                 This template function may not work properly with Visual C++
+                 6. For full compiler compatibility, please use
+                 wxANY_AS(any, T) macro instead.

     */
     template<typename T>
     T As() const;
     */
     template<typename T>
     T As() const;


@@ -127,7 +119,7 @@ public:
         @see wxAnyValueType::CheckType()
     */
     template<typename T>
         @see wxAnyValueType::CheckType()
     */
     template<typename T>

-    bool CheckType();
+    bool CheckType() const;

 
     /**
         Template function that retrieves and converts the value of this
 
     /**
         Template function that retrieves and converts the value of this


@@ -152,14 +144,21 @@ public:
         Returns the value type as wxAnyValueType instance.
 
         @remarks You cannot reliably test whether two wxAnys are of
         Returns the value type as wxAnyValueType instance.
 
         @remarks You cannot reliably test whether two wxAnys are of

-                same value type by simply comparing return values
-                of wxAny::GetType(). Instead use
-                wxAnyValueType::CheckType<T>() template function.
+                 same value type by simply comparing return values
+                 of wxAny::GetType(). Instead, use wxAny::HasSameType().
+
+        @see HasSameType()

     */
     const wxAnyValueType* GetType() const;
 
     /**
     */
     const wxAnyValueType* GetType() const;
 
     /**

-        Tests if wxAny is null (that is, whether there is data).
+        Returns @true if this and another wxAny have the same
+        value type.
+    */
+    bool HasSameType(const wxAny& other) const;
+
+    /**
+        Tests if wxAny is null (that is, whether there is no data).

     */
     bool IsNull() const;
 
     */
     bool IsNull() const;
 


@@ -407,7 +406,7 @@ public:
         @see wxAny::CheckType()
     */
     template <typename T>
         @see wxAny::CheckType()
     */
     template <typename T>

-    bool CheckType();
+    bool CheckType() const;

 
     /**
         Convert value into buffer of different type. Return false if
 
     /**
         Convert value into buffer of different type. Return false if