// Purpose: interface of wxAnimation* classes
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@nativeimpl{wxgtk,wxmsw}
- <!-- @appearance{animationctrl.png} -->
+ @appearance{animationctrl.png}
@see wxAnimation, @sample{animate}
*/
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
+ or @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);
@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.