// Purpose: interface of wxAnimation* classes
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
/**
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.
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}
@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);
/**
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;
@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.
*/
@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.