wxanimation

this class encapsulates the concept of a platform-dependent animation. an animation is a sequence of frames of the same size. sound is not supported by wxanimation.

derived from

wxgdiobject
wxobject

include files

<wx/animate.h>

predefined objects

objects:

wxnullanimation

see also

wxanimationctrl

members

wxanimation::wxanimation
wxanimation::~wxanimation
wxanimation::getdelay
wxanimation::getframecount
wxanimation::getframe
wxanimation::getsize
wxanimation::isok
wxanimation::load
wxanimation::loadfile
wxanimation::operator =

wxanimation::wxanimation

wxanimation()

default constructor.

wxanimation(const wxanimation& anim)

copy constructor, uses reference counting.

wxanimation(const wxstring& name, wxanimationtype type = wxanimation_type_any)

loads an animation from a file.

name

the name of the file to load.

type

see loadfile for more info.

wxanimation::~wxanimation

~wxanimation()

destructor. see reference-counted object destruction for more info.

wxanimation::getdelay

int getdelay(unsigned int i) const

returns the delay for the i-th frame in milliseconds. if -1 is returned the frame is to be displayed forever.

wxanimation::getframecount

unsigned int getframecount() const

returns the number of frames for this animation.

wxanimation::getframe

wximage getframe(unsigned int i) const

returns the i-th frame as a wximage.

wxanimation::getsize

wxsize getsize() const

returns the size of the animation.

wxanimation::isok

bool isok() const

returns true if animation data is present.

wxanimation::load

bool load(wxinputstream& stream, wxanimationtype type = wxanimation_type_any)

loads an animation from the given stream.

parameters

stream

the stream to use to load the animation.

type

one of the following values:

wxanimation_type_gif	load an animated gif file.
wxanimation_type_ani	load an ani file.
wxanimation_type_any	try to autodetect the filetype.

return value

true if the operation succeeded, false otherwise.

wxanimation::loadfile

bool loadfile(const wxstring& name, wxanimationtype type = wxanimation_type_any)

loads an animation from a file.

parameters

name

a filename.

type

one of the following values:

wxanimation_type_gif	load an animated gif file.
wxanimation_type_ani	load an ani file.
wxanimation_type_any	try to autodetect the filetype.

return value

true if the operation succeeded, false otherwise.

wxanimation::operator =

wxanimation& operator =(const wxanimation& brush)

assignment operator, using reference counting.