QMovie Class Reference
Incrementally loads an animation or image, signalling as it progresses.
More...
#include <qmovie.h>
List of all member functions.
Public Members
-
-
QMovie ( QDataSource *, int bufsize=1024 )Â
QMovie ( const QString & fileName, int bufsize=1024 )Â
QMovie ( QByteArray data, int bufsize=1024 )Â
QMovie ( const QMovie & )Â
-
-
-
voidÂ
pushData ( const uchar * data, int length )Â
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
voidÂ
connectResize ( QObject * receiver, const char * member )Â
-
voidÂ
connectUpdate ( QObject * receiver, const char * member )Â
-
enum Status { SourceEmpty=-2, UnrecognizedFormat=-1, Paused=1, EndOfFrame=2, EndOfLoop=3, EndOfMovie=4, SpeedChanged=5 }
voidÂ
connectStatus ( QObject * receiver, const char * member )Â
-
Detailed Description
Incrementally loads an animation or image, signalling as it progresses.
A QMovie provides a QPixmap as the framePixmap(), and connections can
be made via connectResize() and connectUpdate() to receive notification
of size and pixmap changes. All decoding is driven by
the normal event processing mechanisms. The simplest way to display
a QMovie, is to use a QLabel and QLabel::setMovie().
The movie begins playing as soon as the QMovie is created (actually,
once control returns to the event loop). When the last frame in the
movie has been played, it may loop back to the start if such looping
is defined in the input source.
QMovie objects are explicitly shared. This means that a QMovie copied
from another QMovie will be displaying the same frame at all times.
If one shared movie pauses, all pause. To make independent movies,
they must be constructed separately.
The set of data formats supported by QMovie is determined by the decoder
factories which have been installed, and the format of the input is
determined as the input is decoded.
The supported formats are MNG (if Qt is built with MNG support enabled)
and GIF (if Qt is built with GIF support enabled). For MNG support, you
need to have installed libmng from
http://www.libmng.com.
We are required to state: The Graphics Interchange Format(c) is the
Copyright property of CompuServe Incorporated. GIF(sm) is a Service
Mark property of CompuServe Incorporated.
Warning: Unisys has changed its position regarding GIF. If you are
in a country where Unisys holds a patent on LZW compression and/or
decompression and you want to use GIF, Unisys may require you to
license that technology. These countries include Canada, Japan, the
USA, France, Germany, Italy and the UK.
GIF support may be removed completely in a future version of Qt. We
recommend using the MNG or PNG format.
See also QLabel::setMovie().
Examples:
movies/main.cpp
Member Function Documentation
QMovie::QMovie ()
Constructs a null QMovie. The only interesting thing to do to such
a movie is to assign another movie to it.
See also isNull().
QMovie::QMovie ( QByteArray data, int bufsize=1024 )
Constructs a QMovie which reads an image sequence from given data.
QMovie::QMovie ( QDataSource * src, int bufsize=1024 )
Constructs a QMovie which reads an image sequence from the given
QDataSource. The source must be allocated dynamically,
as it becomes owned by the QMovie, and will be destroyed
when the movie is destroyed.
The movie starts playing as soon as event processing continues.
The bufsize argument sets the maximum amount of data the movie
will transfer from the data source per event loop. The lower this
value, the better interleaved the movie playback will be with other
event processing, but the slower the overall processing.
QMovie::QMovie ( const QString & fileName, int bufsize=1024 )
Constructs a QMovie which reads an image sequence from the named file.
QMovie::QMovie ( const QMovie & movie )
Constructs a movie that uses the same data as another movie.
QMovies use explicit sharing, so operations on the copy will
effect the same operations on the original.
QMovie::QMovie ( int bufsize )
Constructs a QMovie with an external data source.
You should later call pushData() to send incoming animation data to
the movie.
See also pushData().
QMovie::~QMovie ()
Destroys the QMovie. If this is the last reference to the data of the
movie, that will also be destroyed.
const QColor& QMovie::backgroundColor () const
Returns the background color of the movie set by setBackgroundColor().
void QMovie::connectResize ( QObject * receiver, const char * member )
Connects the given member, of type
void member(const QSize&)
such that it is signalled when the movie changes size.
Note that due to the explicit sharing of QMovie objects, these connections
persist until they are explicitly disconnected with disconnectResize(), or
until every shared copy of the movie is deleted.
void QMovie::connectStatus ( QObject * receiver, const char * member )
Connects the given member, of type
void member(int)
such that it is signalled when the movie changes status. The status
code are negative for errors and positive for information, and they
are currently:
-
QMovie::SourceEmpty
- signalled if the input cannot be read.
-
QMovie::UnrecognizedFormat
- signalled if the input data is unrecognized.
-
QMovie::Paused
- signalled when the movie is paused by a call to paused(),
or by after stepping pauses.
-
QMovie::EndOfFrame
- signalled at end-of-frame, after any update and Paused signals.
-
QMovie::EndOfLoop
- signalled at end-of-loop, after any update signals,
EndOfFrame, but before EndOfMovie.
-
QMovie::EndOfMovie
- signalled when the movie completes and is not about
to loop.
More status messages may be added in the future, so a general test for
error would test for negative.
Note that due to the explicit sharing of QMovie objects, these connections
persist until they are explicitly disconnected with disconnectStatus(), or
until every shared copy of the movie is deleted.
void QMovie::connectUpdate ( QObject * receiver, const char * member )
Connects the given member, of type
void member(const QRect&)
such that it is signalled when an area of the framePixmap() has
changed since the previous frame.
Note that due to the explicit sharing of QMovie objects, these connections
persist until they are explicitly disconnected with disconnectUpdate(), or
until every shared copy of the movie is deleted.
void QMovie::disconnectResize ( QObject * receiver, const char * member=0 )
Disconnects the given member, or all members if member is zero,
previously connected by
connectResize().
void QMovie::disconnectStatus ( QObject * receiver, const char * member=0 )
Disconnects the given member, or all members if member is zero,
previously connected by
connectStatus().
void QMovie::disconnectUpdate ( QObject * receiver, const char * member=0 )
Disconnects the given member, or all members if member is zero,
previously connected by
connectUpdate().
bool QMovie::finished () const
Returns TRUE if the image is no longer playing - this happens when all
loops of all frames is complete.
const QImage& QMovie::frameImage () const
Returns the current frame of the movie, as a QImage.
It is not generally useful to keep a copy of this image.
Also note that you must not call this function if the
movie is finished(), as the image is not them available.
See also framePixmap().
int QMovie::frameNumber () const
Returns the number of times EndOfFrame has been emitted since the
start of the current loop of the movie. Thus, before
any EndOfFrame has been emitted, the value will be 0,
within slots processing the first signal, frameNumber() will be 1, and
so on.
const QPixmap& QMovie::framePixmap () const
Returns the current frame of the movie, as a QPixmap.
It is not generally useful to
keep a copy of this pixmap. Better to keep a copy of the QMovie and
get the framePixmap() only when needed for drawing.
See also frameImage().
const QRect& QMovie::getValidRect () const
Returns the area of the pixmap for which pixels have been generated.
bool QMovie::isNull () const
Returns TRUE if the movie is null.
QMovie& QMovie::operator= ( const QMovie & movie )
Makes this movie use the same data as another movie.
QMovies use explicit sharing.
void QMovie::pause ()
Pauses the progress of the animation.
See also unpause().
bool QMovie::paused () const
Returns TRUE if the image is paused.
void QMovie::pushData ( const uchar * data, int length )
Pushes length bytes from data into the movie. length must
be no more than the amount returned by pushSpace() since the previous
call to pushData().
int QMovie::pushSpace () const
Returns the maximum amount of data that can currently be pushed
into the movie by a call to pushData(). This is affected by the
initial buffer size, but varies as the movie plays and data is consumed.
void QMovie::restart ()
Rewinds the movie to the beginning. If the movie has not been paused,
it begins playing again.
bool QMovie::running () const
Returns TRUE if the image is not single-stepping, not paused,
and not finished.
void QMovie::setBackgroundColor ( const QColor & c )
Set the background color of the pixmap. If the background color
isValid(), the pixmap will never have a mask, as the background
color will be used in transparent regions of the image.
See also backgroundColor().
void QMovie::setSpeed ( int percent )
Sets the speed-up factor of the movie. This is a percentage of the
speed dictated by the input data format. The default is 100 percent.
int QMovie::speed () const
Returns the speed-up factor of the movie. The default is 100 percent.
See also setSpeed().
void QMovie::step ()
Steps forward 1 frame, then pauses.
void QMovie::step ( int steps )
Steps forward, showing the given number of frames, then pauses.
int QMovie::steps () const
Returns the number of steps remaining after a call to step(), 0 if paused,
or a negative value if the movie is running normally or is finished.
void QMovie::unpause ()
Unpauses the progress of the animation.
See also pause().
Search the documentation, FAQ, qt-interest archive and more (uses
www.trolltech.com):
This file is part of the Qt toolkit,
copyright © 1995-2005
Trolltech, all rights reserved.