QMovie Class Reference

#include <qmovie.h>

Inheritance diagram for QMovie:

[legend]Collaboration diagram for QMovie:

[legend]List of all members.

---

Detailed Description

The QMovie class is a convenience class for playing movies with QImageReader.

First, create a QMovie object by passing either the name of a file or a pointer to a QIODevice containing an animated image format to QMovie's constructor. You can call isValid() to check if the image data is valid, before starting the movie. To start the movie, call start(). QMovie will enter Running state, and emit started() and stateChanged(). To get the current state of the movie, call state().

To display the movie in your application, you can pass your QMovie object to QLabel::setMovie(). Example:

        QLabel label;
        QMovie *movie = new QMovie("animations/fire.gif");

        label.setMovie(movie);
        movie->start();

Whenever a new frame is available in the movie, QMovie will emit updated(). If the size of the frame changes, resized() is emitted. You can call currentImage() or currentPixmap() to get a copy of the current frame. When the movie is done, QMovie emits finished(). If any error occurs during playback (i.e, the image file is corrupt), QMovie will emit error().

You can control the speed of the movie playback by calling setSpeed(), which takes the percentage of the original speed as an argument. Pause the movie by calling setPaused(true). QMovie will then enter Paused state and emit stateChanged(). If you call setPaused(false), QMovie will reenter Running state and start the movie again. To stop the movie, call stop().

Certain animation formats allow you to set the background color. You can call setBackgroundColor() to set the color, or backgroundColor() to retrieve the current background color.

currentFrameNumber() returns the sequence number of the current frame. The first frame in the animation has the sequence number 0. frameCount() returns the total number of frames in the animation, if the image format supports this. You can call loopCount() to get the number of times the movie should loop before finishing. nextFrameDelay() returns the number of milliseconds the current frame should be displayed.

QMovie can be instructed to cache frames of an animation by calling setCacheMode().

Call supportedFormats() for a list of formats that QMovie supports.

See also:

QLabel, QImageReader, {Movie Example}

Definition at line 54 of file qmovie.h.

Public Types
enum	MovieState
enum	CacheMode
Public Slots
void	start ()
bool	jumpToNextFrame ()
void	setPaused (bool paused)
void	stop ()
void	setSpeed (int percentSpeed)
Signals
void	started ()
void	resized (const QSize &size)
void	updated (const QRect &rect)
void	stateChanged (QMovie::MovieState state)
void	error (QImageReader::ImageReaderError error)
void	finished ()
void	frameChanged (int frameNumber)
Public Member Functions
	QMovie (QObject *parent=0)
	QMovie (QIODevice *device, const QByteArray &format=QByteArray(), QObject *parent=0)
	QMovie (const QString &fileName, const QByteArray &format=QByteArray(), QObject *parent=0)
	~QMovie ()
void	setDevice (QIODevice *device)
QIODevice *	device () const
void	setFileName (const QString &fileName)
QString	fileName () const
void	setFormat (const QByteArray &format)
QByteArray	format () const
void	setBackgroundColor (const QColor &color)
QColor	backgroundColor () const
MovieState	state () const
QRect	frameRect () const
QImage	currentImage () const
QPixmap	currentPixmap () const
bool	isValid () const
bool	jumpToFrame (int frameNumber)
int	loopCount () const
int	frameCount () const
int	nextFrameDelay () const
int	currentFrameNumber () const
int	speed () const
QSize	scaledSize ()
void	setScaledSize (const QSize &size)
CacheMode	cacheMode () const
void	setCacheMode (CacheMode mode)
CacheMode	cacheMode ()
Static Public Member Functions
static QList< QByteArray >	supportedFormats ()

---

Member Enumeration Documentation

enum QMovie::MovieState

This enum describes the different states of QMovie.

NotRunning The movie is not running. This is QMovie's initial state, and the state it enters after stop() has been called or the movie is finished.

Paused The movie is paused, and QMovie stops emitting updated() or resized(). This state is entered after calling pause() or setPaused(true). The current frame number it kept, and the movie will continue with the next frame when unpause() or setPaused(false) is called.

Running The movie is running.

Definition at line 62 of file qmovie.h.

                    {
        NotRunning,
        Paused,
        Running
    };

enum QMovie::CacheMode

This enum describes the different cache modes of QMovie.

CacheNone No frames are cached (the default).

CacheAll All frames are cached.

Definition at line 67 of file qmovie.h.

                   {
        CacheNone,
        CacheAll
    };

---

Constructor & Destructor Documentation

QMovie::QMovie

(

QObject *

parent = 0

)

Constructs a QMovie object, passing the parent object to QObject's constructor.

See also:

setFileName(), setDevice(), setFormat()

Definition at line 553 of file qmovie.cpp.

References QObject::connect(), d, SIGNAL, and SLOT.

    : QObject(*new QMoviePrivate(this), parent)
{
    Q_D(QMovie);
    d->reader = new QImageReader;
    connect(&d->nextImageTimer, SIGNAL(timeout()), this, SLOT(_q_loadNextFrame()));
}

Here is the call graph for this function:

QMovie::QMovie	(	QIODevice *	device,
		const QByteArray &	format = QByteArray(),
		QObject *	parent = 0
	)			[explicit]

Constructs a QMovie object. QMovie will use read image data from device, which it assumes is open and readable. If format is not empty, QMovie will use the image format format for decoding the image data. Otherwise, QMovie will attempt to guess the format.

The parent object is passed to QObject's constructor.

Definition at line 569 of file qmovie.cpp.

References QObject::connect(), d, device(), format(), QIODevice::pos(), SIGNAL, and SLOT.

    : QObject(*new QMoviePrivate(this), parent)
{
    Q_D(QMovie);
    d->reader = new QImageReader(device, format);
    d->initialDevicePos = device->pos();
    connect(&d->nextImageTimer, SIGNAL(timeout()), this, SLOT(_q_loadNextFrame()));
}

Here is the call graph for this function:

QMovie::QMovie	(	const QString &	fileName,
		const QByteArray &	format = QByteArray(),
		QObject *	parent = 0
	)			[explicit]

Constructs a QMovie object. QMovie will use read image data from fileName. If format is not empty, QMovie will use the image format format for decoding the image data. Otherwise, QMovie will attempt to guess the format.

The parent object is passed to QObject's constructor.

Definition at line 586 of file qmovie.cpp.

References QObject::connect(), d, fileName(), format(), SIGNAL, and SLOT.

    : QObject(*new QMoviePrivate(this), parent)
{
    Q_D(QMovie);
    d->reader = new QImageReader(fileName, format);
    if (d->reader->device())
        d->initialDevicePos = d->reader->device()->pos();
    connect(&d->nextImageTimer, SIGNAL(timeout()), this, SLOT(_q_loadNextFrame()));
}

Here is the call graph for this function:

QMovie::~QMovie

(

)

Destructs the QMovie object.

Definition at line 599 of file qmovie.cpp.

References d.

{
    Q_D(QMovie);
    delete d->reader;
}

---

Member Function Documentation

QList< QByteArray > QMovie::supportedFormats

(

)

[static]

Since:

4.1

Returns the list of image formats supported by QMovie.

See also:

QImageReader::supportedImageFormats()

Definition at line 1006 of file qmovie.cpp.

References buffer, QIODevice::ReadOnly, and QImageReader::supportedImageFormats().

{
    QList<QByteArray> list = QImageReader::supportedImageFormats();
    QMutableListIterator<QByteArray> it(list);
    QBuffer buffer;
    buffer.open(QIODevice::ReadOnly);
    while (it.hasNext()) {
        QImageReader reader(&buffer, it.next());
        if (!reader.supportsAnimation())
            it.remove();
    }
    return list;
}

Here is the call graph for this function:

void QMovie::setDevice

(

QIODevice *

device

)

Sets the current device to device. QMovie will read image data from this device when the movie is running.

See also:

device(), setFormat()

Definition at line 611 of file qmovie.cpp.

References d, and device().

{
    Q_D(QMovie);
    d->reader->setDevice(device);
    d->reset();
}

Here is the call graph for this function:

QIODevice * QMovie::device

(

)

const

Returns the device QMovie reads image data from. If no device has currently been assigned, 0 is returned.

See also:

setDevice(), fileName()

Definition at line 624 of file qmovie.cpp.

References d.

Referenced by QMovie(), and setDevice().

{
    Q_D(const QMovie);
    return d->reader->device();
}

void QMovie::setFileName

(

const QString &

fileName

)

Sets the name of the file that QMovie reads image data from, to fileName.

See also:

fileName(), setDevice(), setFormat()

Definition at line 636 of file qmovie.cpp.

References d, and fileName().

Referenced by MoviePlayer::openFile().

{
    Q_D(QMovie);
    d->reader->setFileName(fileName);
    d->reset();
}

Here is the call graph for this function:

QString QMovie::fileName

(

)

const

Returns the name of the file that QMovie reads image data from. If no file name has been assigned, or if the assigned device is not a file, an empty QString is returned.

See also:

setFileName(), device()

Definition at line 650 of file qmovie.cpp.

References d.

Referenced by QMovie(), and setFileName().

{
    Q_D(const QMovie);
    return d->reader->fileName();
}

void QMovie::setFormat

(

const QByteArray &

format

)

Sets the format that QMovie will use when decoding image data, to format. By default, QMovie will attempt to guess the format of the image data.

You can call supportedFormats() for the full list of formats QMovie supports.

See also:

QImageReader::supportedImageFormats()

Definition at line 666 of file qmovie.cpp.

References d, and format().

{
    Q_D(QMovie);
    d->reader->setFormat(format);
}

Here is the call graph for this function:

QByteArray QMovie::format

(

)

const

Returns the format that QMovie uses when decoding image data. If no format has been assigned, an empty QByteArray() is returned.

See also:

setFormat()

Definition at line 678 of file qmovie.cpp.

References d.

Referenced by QMovie(), and setFormat().

{
    Q_D(const QMovie);
    return d->reader->format();
}

void QMovie::setBackgroundColor

(

const QColor &

color

)

For image formats that support it, this function sets the background color to color.

See also:

backgroundColor()

Definition at line 690 of file qmovie.cpp.

References d.

{
    Q_D(QMovie);
    d->reader->setBackgroundColor(color);
}

QColor QMovie::backgroundColor

(

)

const

Returns the background color of the movie. If no background color has been assigned, an invalid QColor is returned.

See also:

setBackgroundColor()

Definition at line 702 of file qmovie.cpp.

References d.

{
    Q_D(const QMovie);
    return d->reader->backgroundColor();
}

QMovie::MovieState QMovie::state

(

)

const

Returns the current state of QMovie.

See also:

MovieState, stateChanged()

Definition at line 713 of file qmovie.cpp.

References d.

Referenced by QLabel::setMovie(), and MoviePlayer::updateButtons().

{
    Q_D(const QMovie);
    return d->movieState;
}

QRect QMovie::frameRect

(

)

const

Returns the rect of the last frame. If no frame has yet been updated, an invalid QRect is returned.

See also:

currentImage(), currentPixmap()

Definition at line 725 of file qmovie.cpp.

References d.

{
    Q_D(const QMovie);
    return d->frameRect;
}

QImage QMovie::currentImage

(

)

const

Returns the current frame as a QImage.

See also:

currentPixmap(), updated()

Definition at line 767 of file qmovie.cpp.

References d.

{
    Q_D(const QMovie);
    return d->currentPixmap.toImage();
}

QPixmap QMovie::currentPixmap

(

)

const

Returns the current frame as a QPixmap.

See also:

currentImage(), updated()

Definition at line 751 of file qmovie.cpp.

References d.

{
    Q_D(const QMovie);
    return d->currentPixmap;
}

bool QMovie::isValid

(

)

const

Returns true if the movie is valid (e.g., the image data is readable and the image format is supported); otherwise returns false.

Definition at line 777 of file qmovie.cpp.

References d.

Referenced by MoviePlayer::updateButtons().

{
    Q_D(const QMovie);
    return d->isValid();
}

bool QMovie::jumpToFrame

(

int

frameNumber

)

Jumps to frame number frameNumber. Returns true on success; otherwise returns false.

Definition at line 864 of file qmovie.cpp.

References d.

Referenced by MoviePlayer::goToFrame().

{
    Q_D(QMovie);
    return d->jumpToFrame(frameNumber);
}

int QMovie::loopCount

(

)

const

Returns the number of times the movie will loop before it finishes. If the movie will only play once (no looping), loopCount returns 0. If the movie loops forever, loopCount returns -1.

Note that, if the image data comes from a sequential device (e.g. a socket), QMovie can only loop the movie if the cacheMode is set to QMovie::CacheAll.

Definition at line 879 of file qmovie.cpp.

References d.

{
    Q_D(const QMovie);
    return d->reader->loopCount();
}

int QMovie::frameCount

(

)

const

Returns the number of frames in the movie.

Certain animation formats do not support this feature, in which case 0 is returned.

Definition at line 825 of file qmovie.cpp.

References d.

Referenced by MoviePlayer::updateButtons(), and MoviePlayer::updateFrameSlider().

{
    Q_D(const QMovie);
    return d->frameCount();
}

int QMovie::nextFrameDelay

(

)

const

Returns the number of milliseconds QMovie will wait before updating the next frame in the animation.

Definition at line 835 of file qmovie.cpp.

References d.

Referenced by setPaused().

{
    Q_D(const QMovie);
    return d->nextDelay;
}

int QMovie::currentFrameNumber

(

)

const

Returns the sequence number of the current frame. The number of the first frame in the movie is 0.

Definition at line 845 of file qmovie.cpp.

References d.

Referenced by MoviePlayer::updateFrameSlider().

{
    Q_D(const QMovie);
    return d->currentFrameNumber;
}

int QMovie::speed

(

)

const

Definition at line 927 of file qmovie.cpp.

References d.

{
    Q_D(const QMovie);
    return d->speed;
}

QSize QMovie::scaledSize

(

)

Since:

4.1

Returns the scaled size of frames.

See also:

QImageReader::scaledSize()

Definition at line 980 of file qmovie.cpp.

References d.

{
    Q_D(QMovie);
    return d->reader->scaledSize();
}

void QMovie::setScaledSize

(

const QSize &

size

)

Since:

4.1

Sets the scaled frame size to size.

See also:

QImageReader::setScaledSize()

Definition at line 993 of file qmovie.cpp.

References d, and size.

{
    Q_D(QMovie);
    d->reader->setScaledSize(size);
}

QMovie::CacheMode QMovie::cacheMode

(

)

const

Definition at line 1037 of file qmovie.cpp.

References d.

{
    Q_D(const QMovie);
    return d->cacheMode;
}

void QMovie::setCacheMode

(

CacheMode

mode

)

Definition at line 1043 of file qmovie.cpp.

References d.

Referenced by MoviePlayer::MoviePlayer().

{
    Q_D(QMovie);
    d->cacheMode = cacheMode;
}

QMovie::CacheMode QMovie::cacheMode

(

)

the movie's cache mode

Caching frames can be useful when the underlying animation format handler that QMovie relies on to decode the animation data does not support jumping to particular frames in the animation, or even "rewinding" the animation to the beginning (for looping). Furthermore, if the image data comes from a sequential device, it is not possible for the underlying animation handler to seek back to frames whose data has already been read (making looping altogether impossible). To aid in such situations, QMovie can be instructed to cache the frames, at the added memory cost of keeping the frames in memory for the lifetime of the QMovie.

See also:

QMovie::CacheMode

Definition at line 1052 of file qmovie.cpp.

References d.

{
    Q_D(QMovie);
    return d->cacheMode;
}

void QMovie::started

(

)

[signal]

This signal is emitted after QMovie::start() has been called, and QMovie has entered QMovie::Running state.

void QMovie::resized

(

const QSize &

size

)

[signal]

This signal is emitted when the current frame has been resized to size. This effect is sometimes used in animations as an alternative to replacing the frame. You can call currentImage() or currentPixmap() to get a copy of the updated frame.

void QMovie::updated

(

const QRect &

rect

)

[signal]

This signal is emitted when the rect rect in the current frame has been updated. You can call currentImage() or currentPixmap() to get a copy of the updated frame.

void QMovie::stateChanged

(

QMovie::MovieState

state

)

[signal]

This signal is emitted every time the state of the movie changes. The new state is specified by state.

See also:

QMovie::state()

void QMovie::error

(

QImageReader::ImageReaderError

error

)

[signal]

This signal is emitted by QMovie when the error error occurred during playback. QMovie will stop the movie, and enter QMovie::NotRunning state.

void QMovie::finished

(

)

[signal]

This signal is emitted when the movie has finished.

See also:

QMovie::stop()

void QMovie::frameChanged

(

int

frameNumber

)

[signal]

Since:

4.1

This signal is emitted when the frame number has changed to frameNumber. You can call currentImage() or currentPixmap() to get a copy of the frame.

void QMovie::start

(

)

[slot]

Starts the movie. QMovie will enter Running state, and start emitting updated() and resized() as the movie progresses.

If QMovie is in the Paused state, this function is equivalent to calling setPaused(false). If QMovie is already in the Running state, this function does nothing.

See also:

stop(), setPaused()

Definition at line 943 of file qmovie.cpp.

References d, NotRunning, Paused, and setPaused().

Referenced by MoviePlayer::openFile().

{
    Q_D(QMovie);
    if (d->movieState == NotRunning) {
        d->_q_loadNextFrame(true);
    } else if (d->movieState == Paused) {
        setPaused(false);
    }
}

bool QMovie::jumpToNextFrame

(

)

[slot]

Jumps to the next frame. Returns true on success; otherwise returns false.

Definition at line 854 of file qmovie.cpp.

References d.

{
    Q_D(QMovie);
    return d->jumpToNextFrame();
}

void QMovie::setPaused

(

bool

paused

)

[slot]

If paused is true, QMovie will enter Paused state and emit stateChanged(Paused); otherwise it will enter Running state and emit stateChanged(Running).

See also:

state()

Definition at line 892 of file qmovie.cpp.

References d, nextFrameDelay(), NotRunning, Paused, and Running.

Referenced by start().

{
    Q_D(QMovie);
    if (paused) {
        if (d->movieState == NotRunning)
            return;
        d->enterState(Paused);
        d->nextImageTimer.stop();
    } else {
        if (d->movieState == Running)
            return;
        d->enterState(Running);
        d->nextImageTimer.start(nextFrameDelay());
    }
}

void QMovie::stop

(

)

[slot]

Stops the movie. QMovie enters NotRunning state, and stops emitting updated() and resized(). If start() is called again, the movie will restart from the beginning.

If QMovie is already in the NotRunning state, this function does nothing.

See also:

start(), setPaused()

Definition at line 963 of file qmovie.cpp.

References d, and NotRunning.

Referenced by MoviePlayer::openFile().

{
    Q_D(QMovie);
    if (d->movieState == NotRunning)
        return;
    d->enterState(NotRunning);
    d->nextImageTimer.stop();
    d->nextFrameNumber = 0;
}

void QMovie::setSpeed

(

int

percentSpeed

)

[slot]

Definition at line 921 of file qmovie.cpp.

References d.

{
    Q_D(QMovie);
    d->speed = percentSpeed;
}

---

The documentation for this class was generated from the following files:

• src/gui/image/qmovie.h
• src/gui/image/qmovie.cpp

---