X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ab8b305b820aa2d8c422e85059df7f591b003084..d928f01967cec20e112cc9dde2162b147d8f1433:/interface/wx/animate.h diff --git a/interface/wx/animate.h b/interface/wx/animate.h index 4dc9dd7567..19716e2c99 100644 --- 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 ///////////////////////////////////////////////////////////////////////////// /** @@ -70,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. @@ -183,7 +183,7 @@ public: Note that on wxGTK wxAnimation is capable of loading the formats supported by the internally-used @c gdk-pixbuf library (typically this means only - or @c wxANIMATION_TYPE_GIF). + @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). @@ -228,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;