Make the CreateTool factories be public so they can be used from application code

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

diff --git a/interface/wx/animate.h b/interface/wx/animate.h
index 62e2ab5a8fec5a3fb6bf816e8d03e900513a6d1f..19716e2c996d9b3c58f88de1ba5418c91967bb0c 100644 (file)
--- a/interface/wx/animate.h
+++ b/interface/wx/animate.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxAnimation* classes
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -25,7 +25,6 @@ enum wxAnimationType
 
 /**
     @class wxAnimationCtrl
-    @wxheader{animate.h}
 
     This is a static control which displays an animation.
     wxAnimationCtrl API is as simple as possible and won't give you full control
@@ -50,7 +49,7 @@ enum wxAnimationType
 
     @nativeimpl{wxgtk,wxmsw}
 
-    <!-- @appearance{animationctrl.png} -->
+    @appearance{animationctrl.png}
 
     @see wxAnimation, @sample{animate}
 */
@@ -71,7 +70,7 @@ public:
     /**
         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.
 
@@ -177,12 +176,17 @@ public:
 
 /**
     @class wxAnimation
-    @wxheader{animate.h}
 
     This class encapsulates the concept of a platform-dependent animation.
     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}
 
@@ -205,7 +209,7 @@ public:
         @param name
             The name of the file to load.
         @param type
-            See LoadFile for more info.
+            See LoadFile() for more info.
     */
     wxAnimation(const wxString& name,
                 wxAnimationType type = wxANIMATION_TYPE_ANY);
@@ -224,11 +228,17 @@ public:
 
     /**
         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.
+
+        This method is not implemented in the native wxGTK implementation of
+        this class and always returns 0 there.
     */
     virtual unsigned int GetFrameCount() const;
 
@@ -247,11 +257,10 @@ public:
 
         @param stream
             The stream to use to load the animation.
+            Under wxGTK may be any kind of stream; under other platforms
+            this must be a seekable stream.
         @param type
-            One of the following values:
-             @li wxANIMATION_TYPE_GIF: loads an animated GIF file;
-             @li wxANIMATION_TYPE_ANI: load an ANI file;
-             @li wxANIMATION_TYPE_ANY: tries to autodetect the filetype.
+            One of the ::wxAnimationType enumeration values.
 
         @return @true if the operation succeeded, @false otherwise.
     */
@@ -264,7 +273,7 @@ public:
         @param name
             A filename.
         @param type
-            One of the wxAnimationType values; wxANIMATION_TYPE_ANY
+            One of the ::wxAnimationType values; wxANIMATION_TYPE_ANY
             means that the function should try to autodetect the filetype.
 
         @return @true if the operation succeeded, @false otherwise.