Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/animate.h b/interface/wx/animate.h
index 967055b7bf7d2b5b325475de8a61edb4d08da4e7..f4376a3e29f6d328eb4e326a64b98936a86187d2 100644 (file)
--- a/interface/wx/animate.h
+++ b/interface/wx/animate.h
@@ -2,8 +2,7 @@
 // Name:        animate.h
 // Purpose:     interface of wxAnimation* classes
 // Author:      wxWidgets team
 // Name:        animate.h
 // Purpose:     interface of wxAnimation* classes
 // Author:      wxWidgets team

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

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


@@ -23,6 +22,11 @@ enum wxAnimationType
     wxANIMATION_TYPE_ANY
 };
 
     wxANIMATION_TYPE_ANY
 };
 

+
+#define wxAC_NO_AUTORESIZE       (0x0010)
+#define wxAC_DEFAULT_STYLE       (wxBORDER_NONE)
+
+

 /**
     @class wxAnimationCtrl
 
 /**
     @class wxAnimationCtrl
 


@@ -49,7 +53,7 @@ enum wxAnimationType
 
     @nativeimpl{wxgtk,wxmsw}
 
 
     @nativeimpl{wxgtk,wxmsw}
 

-    @appearance{animationctrl.png}
+    @appearance{animationctrl}

 
     @see wxAnimation, @sample{animate}
 */
 
     @see wxAnimation, @sample{animate}
 */


@@ -70,7 +74,7 @@ public:
     /**
         Creates the control with the given @a anim animation.
 
     /**
         Creates the control with the given @a anim animation.
 

-        After control creation you must explicitely call Play() to start to play
+        After control creation you must explicitly call Play() to start to play

         the animation. Until that function won't be called, the first frame
         of the animation is displayed.
 
         the animation. Until that function won't be called, the first frame
         of the animation is displayed.
 


@@ -181,6 +185,12 @@ public:
     An animation is a sequence of frames of the same size.
     Sound is not supported by wxAnimation.
 
     An animation is a sequence of frames of the same size.
     Sound is not supported by wxAnimation.
 

+    Note that on wxGTK wxAnimation is capable of loading the formats supported
+    by the internally-used @c gdk-pixbuf library (typically this means only
+    @c wxANIMATION_TYPE_GIF).
+    On other platforms wxAnimation is always capable of loading both GIF and ANI
+    formats (i.e. both @c wxANIMATION_TYPE_GIF and @c wxANIMATION_TYPE_ANI).
+

     @library{wxadv}
     @category{gdi}
 
     @library{wxadv}
     @category{gdi}
 


@@ -189,9 +199,14 @@ public:
 
     @see wxAnimationCtrl, @sample{animate}
 */
 
     @see wxAnimationCtrl, @sample{animate}
 */

-class wxAnimation : public wxGDIObject
+class wxAnimation : public wxObject

 {
 public:
 {
 public:

+    /**
+       Default ctor.
+    */
+    wxAnimation();
+    

     /**
         Copy ctor.
     */
     /**
         Copy ctor.
     */


@@ -222,11 +237,17 @@ public:
 
     /**
         Returns the i-th frame as a wxImage.
 
     /**
         Returns the i-th frame as a wxImage.

+
+        This method is not implemented in the native wxGTK implementation of
+        this class and always returns an invalid image there.

     */
     virtual wxImage GetFrame(unsigned int i) const;
 
     /**
         Returns the number of frames for this animation.
     */
     virtual wxImage GetFrame(unsigned int i) const;
 
     /**
         Returns the number of frames for this animation.

+
+        This method is not implemented in the native wxGTK implementation of
+        this class and always returns 0 there.

     */
     virtual unsigned int GetFrameCount() const;
 
     */
     virtual unsigned int GetFrameCount() const;