Version: 3.1.4
wxAnimation Class Reference

#include <wx/animate.h>

+ Inheritance diagram for wxAnimation:

Detailed Description

The wxAnimation class handles the interface between the animation control and the details of the animation image or data.

Predefined objects/pointers: wxNullAnimation

See also
wxAnimationCtrl, Animation Sample

Public Member Functions

 wxAnimation ()
 Constructs a new empty animation object. More...
 
 wxAnimation (const wxString &name, wxAnimationType type=wxANIMATION_TYPE_ANY)
 Constructs a new animation object and load the animation data from the given filename. More...
 
 wxAnimation (const wxAnimation &other)
 Copy constructor. More...
 
bool IsOk () const
 Returns true if animation data is present. More...
 
bool IsCompatibleWith (wxClassInfo *ci) const
 Returns true if animation can be used with controls of the given type. More...
 
int GetDelay (unsigned int frame) const
 Returns the delay for the i-th frame in milliseconds. More...
 
unsigned int GetFrameCount () const
 Returns the number of frames for this animation. More...
 
wxImage GetFrame (unsigned int frame) const
 Returns the i-th frame as a wxImage. More...
 
wxSize GetSize () const
 Returns the size of the animation. More...
 
bool LoadFile (const wxString &name, wxAnimationType type=wxANIMATION_TYPE_ANY)
 Loads an animation from a file. More...
 
bool Load (wxInputStream &stream, wxAnimationType type=wxANIMATION_TYPE_ANY)
 Loads an animation from the given stream. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Static Public Member Functions

static wxAnimationDecoderList & GetHandlers ()
 Returns the list of animation decoders used by the generic animation and wxGenericAnimationCtrl. More...
 
static void AddHandler (wxAnimationDecoder *handler)
 Add a new decoder to the list of animation decoders. More...
 
static void InsertHandler (wxAnimationDecoder *handler)
 Insert a new decoder to the front of the list of animation decoders. More...
 
static const wxAnimationDecoderFindHandler (wxAnimationType animType)
 Search for an animation decoder by type. More...
 
static void InitStandardHandlers ()
 Load the stock animation decoders (currently GIF and ANI) into the list of decoders. More...
 
static void CleanUpHandlers ()
 Clear out the animation decoder list. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

wxAnimation::wxAnimation ( )

Constructs a new empty animation object.

Call Load() to initialize it.

See also
wxAnimationCtrl::CreateAnimation()
wxAnimation::wxAnimation ( const wxString name,
wxAnimationType  type = wxANIMATION_TYPE_ANY 
)

Constructs a new animation object and load the animation data from the given filename.

Parameters
nameA filename.
typeOne of the wxAnimationType values; wxANIMATION_TYPE_ANY means that the function should try to autodetect the filetype.
See also
wxAnimationCtrl::CreateAnimation()
wxAnimation::wxAnimation ( const wxAnimation other)

Copy constructor.

Member Function Documentation

static void wxAnimation::AddHandler ( wxAnimationDecoder handler)
static

Add a new decoder to the list of animation decoders.

static void wxAnimation::CleanUpHandlers ( )
static

Clear out the animation decoder list.

This is called automatically at program shutdown.

static const wxAnimationDecoder* wxAnimation::FindHandler ( wxAnimationType  animType)
static

Search for an animation decoder by type.

int wxAnimation::GetDelay ( unsigned int  frame) const

Returns the delay for the i-th frame in milliseconds.

If -1 is returned the frame is to be displayed forever.

wxImage wxAnimation::GetFrame ( unsigned int  frame) const

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.

unsigned int wxAnimation::GetFrameCount ( ) 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.

static wxAnimationDecoderList& wxAnimation::GetHandlers ( )
inlinestatic

Returns the list of animation decoders used by the generic animation and wxGenericAnimationCtrl.

wxSize wxAnimation::GetSize ( ) const

Returns the size of the animation.

static void wxAnimation::InitStandardHandlers ( )
static

Load the stock animation decoders (currently GIF and ANI) into the list of decoders.

This is called automatically at program startup.

static void wxAnimation::InsertHandler ( wxAnimationDecoder handler)
static

Insert a new decoder to the front of the list of animation decoders.

bool wxAnimation::IsCompatibleWith ( wxClassInfo ci) const

Returns true if animation can be used with controls of the given type.

This function checks if this animation object can be used with wxAnimationCtrl of particular type. This will be always the case for the platforms where only a single wxAnimationCtrl implementation is available, but not necessarily under e.g. wxGTK where both native (but limited) GTK implementation and generic implementation can be used.

Since
3.1.4
bool wxAnimation::IsOk ( ) const

Returns true if animation data is present.

bool wxAnimation::Load ( wxInputStream stream,
wxAnimationType  type = wxANIMATION_TYPE_ANY 
)

Loads an animation from the given stream.

Parameters
streamThe stream to use to load the animation. Under wxGTK may be any kind of stream; under other platforms this must be a seekable stream.
typeOne of the wxAnimationType enumeration values.
Returns
true if the operation succeeded, false otherwise.
bool wxAnimation::LoadFile ( const wxString name,
wxAnimationType  type = wxANIMATION_TYPE_ANY 
)

Loads an animation from a file.

Parameters
nameA filename.
typeOne 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.