wxVector<T> is header-based, use @nolibrary

[wxWidgets.git] / interface / animate.h

diff --git a/interface/animate.h b/interface/animate.h
index 3631671843246a6781b6ef6d3afcc6d1e55bb9c9..83f5731c74e241e4d8aa887f18f269224c99a7f3 100644 (file)
--- a/interface/animate.h
+++ b/interface/animate.h
@@ -62,7 +62,7 @@ public:
         all the parameters.
     */
     wxAnimationCtrl(wxWindow* parent, wxWindowID id,
-                    const wxAnimation& anim,
+                    const wxAnimation& anim = wxNullAnimation,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = wxAC_DEFAULT_STYLE,
@@ -70,11 +70,11 @@ public:
 
     /**
         Creates the control with the given @a anim animation.
-    
+
         After control creation you must explicitely call Play() to start to play
         the animation. Until that function won't be called, the first frame
         of the animation is displayed.
-        
+
         @param parent
             Parent window, must be non-@NULL.
         @param id
@@ -89,12 +89,12 @@ public:
             The window style, see wxAC_* flags.
         @param name
             Control name.
-        
+
         @returns @true if the control was successfully created or @false if
                  creation failed.
     */
     bool Create(wxWindow* parent, wxWindowID id,
-                const wxAnimation& anim,
+                const wxAnimation& anim = wxNullAnimation,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxAC_DEFAULT_STYLE,
@@ -170,7 +170,6 @@ public:
 
 /**
     @class wxAnimation
-    @ingroup group_class_gdi
     @wxheader{animate.h}
 
     This class encapsulates the concept of a platform-dependent animation.
@@ -188,12 +187,14 @@ public:
 class wxAnimation : public wxGDIObject
 {
 public:
-    wxAnimation();
+    /**
+        Copy ctor.
+    */
     wxAnimation(const wxAnimation& anim);
 
     /**
         Loads an animation from a file.
-        
+
         @param name
             The name of the file to load.
         @param type
@@ -236,7 +237,7 @@ public:
 
     /**
         Loads an animation from the given stream.
-        
+
         @param stream
             The stream to use to load the animation.
         @param type
@@ -244,7 +245,7 @@ public:
              @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.
-        
+
         @returns @true if the operation succeeded, @false otherwise.
     */
     bool Load(wxInputStream& stream,
@@ -252,13 +253,13 @@ public:
 
     /**
         Loads an animation from a file.
-        
+
         @param name
             A filename.
         @param type
             One of the wxAnimationType values; wxANIMATION_TYPE_ANY
             means that the function should try to autodetect the filetype.
-        
+
         @returns @true if the operation succeeded, @false otherwise.
     */
     bool LoadFile(const wxString& name,
@@ -267,9 +268,14 @@ public:
     /**
         Assignment operator, using @ref overview_refcount "reference counting".
     */
-    wxAnimation operator =(const wxAnimation& brush);
+    wxAnimation& operator =(const wxAnimation& brush);
 };
 
+
+// ============================================================================
+// Global functions/macros
+// ============================================================================
+
 /**
     An empty animation object.
 */