QMovie Class Reference

[ QtGui module]

QMovie 类是用于播放电影的方便类,采用 QImageReader . 更多...

继承 QObject .

类型

方法

Static Methods

Qt Signals


详细描述

QMovie 类是用于播放电影的方便类,采用 QImageReader .

This class is used to show simple animations without sound. If you want to display video and media content, use the Phonon multimedia framework instead.

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 运行 state, and emit started () 和 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 ()。范例:

 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 () 是 emitted. You can call currentImage () 或 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 运行 state and start the movie again. To stop the movie, call stop ().

Certain animation formats allow you to set the background color. 可以调用 setBackgroundColor () to set the color, or backgroundColor () 以检索 current background color.

currentFrameNumber () 返回 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 ().

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


类型文档编制

QMovie.CacheMode

此枚举描述不同缓存模式,为 QMovie .

常量 描述
QMovie.CacheNone 0 没有帧被缓存 (默认)。
QMovie.CacheAll 1 所有帧都被缓存。

QMovie.MovieState

此枚举描述不同状态为 QMovie .

常量 描述
QMovie.NotRunning 0 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.
QMovie.Paused 1 The movie is paused, and QMovie stops emitting updated () 或 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 () 或 setPaused(false) is called.
QMovie.Running 2 The movie is running.

方法文档编制

QMovie.__init__ ( self , QObject   parent  = None)

parent argument, if not None, causes self to be owned by Qt instead of PyQt.

构造 QMovie object, passing the parent object to QObject 's 构造函数。

另请参阅 setFileName (), setDevice (),和 setFormat ().

QMovie.__init__ ( self , QIODevice   device , QByteArray   format  = QByteArray(), QObject   parent  = None)

parent argument, if not None, causes self to be owned by Qt instead of PyQt.

构造 QMovie 对象。 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.

parent 对象被传递给 QObject 的构造函数。

QMovie.__init__ ( self , QString  fileName , QByteArray   format  = QByteArray(), QObject   parent  = None)

parent argument, if not None, causes self to be owned by Qt instead of PyQt.

构造 QMovie 对象。 QMovie will use read image data from fileName 。若 format is not empty, QMovie will use the image format format for decoding the image data. Otherwise, QMovie will attempt to guess the format.

parent 对象被传递给 QObject 的构造函数。

QColor QMovie.backgroundColor ( self )

Returns the background color of the movie. If no background color has been assigned, an invalid QColor 被返回。

另请参阅 setBackgroundColor ().

CacheMode QMovie.cacheMode ( self )

int QMovie.currentFrameNumber ( self )

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

QImage QMovie.currentImage ( self )

返回当前帧,作为 QImage .

另请参阅 currentPixmap () 和 updated ().

QPixmap QMovie.currentPixmap ( self )

返回当前帧,作为 QPixmap .

另请参阅 currentImage () 和 updated ().

QIODevice QMovie.device ( self )

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

另请参阅 setDevice () and fileName ().

QString QMovie.fileName ( self )

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 被返回。

另请参阅 setFileName () 和 device ().

QByteArray QMovie.format ( self )

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

另请参阅 setFormat ().

int QMovie.frameCount ( self )

Returns the number of frames in the movie.

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

QRect QMovie.frameRect ( self )

Returns the rect of the last frame. If no frame has yet been updated, an invalid QRect 被返回。

另请参阅 currentImage () 和 currentPixmap ().

bool QMovie.isValid ( self )

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

bool QMovie.jumpToFrame ( self , int  frameNumber )

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

bool QMovie.jumpToNextFrame ( self )

This method is also a Qt slot with the C++ signature bool jumpToNextFrame() .

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

int QMovie.loopCount ( self )

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 设为 QMovie.CacheAll .

int QMovie.nextFrameDelay ( self )

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

QSize QMovie.scaledSize ( self )

Returns the scaled size of frames.

该函数在 Qt 4.1 引入。

另请参阅 setScaledSize () 和 QImageReader.scaledSize ().

QMovie.setBackgroundColor ( self , QColor   color )

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

另请参阅 backgroundColor ().

QMovie.setCacheMode ( self , CacheMode   mode )

QMovie.setDevice ( self , QIODevice   device )

把当前设备设为 device . QMovie will read image data from this device when the movie is running.

另请参阅 device () 和 setFormat ().

QMovie.setFileName ( self , QString  fileName )

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

另请参阅 fileName (), setDevice (),和 setFormat ().

QMovie.setFormat ( self , 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.

可以调用 supportedFormats () for the full list of formats QMovie 支持。

另请参阅 format () 和 QImageReader.supportedImageFormats ().

QMovie.setPaused ( self , bool  paused )

This method is also a Qt slot with the C++ signature void setPaused(bool) .

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

另请参阅 paused () 和 state ().

QMovie.setScaledSize ( self , QSize   size )

Sets the scaled frame size to size .

该函数在 Qt 4.1 引入。

另请参阅 scaledSize () 和 QImageReader.setScaledSize ().

QMovie.setSpeed ( self , int  percentSpeed )

int QMovie.speed ( self )

QMovie.start ( self )

This method is also a Qt slot with the C++ signature void start() .

Starts the movie. QMovie 将进入 运行 state, and start emitting updated () 和 resized () as the movie progresses.

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

另请参阅 stop () 和 setPaused ().

MovieState QMovie.state ( self )

返回当前状态,为 QMovie .

另请参阅 MovieState and stateChanged ().

QMovie.stop ( self )

This method is also a Qt slot with the C++ signature void stop() .

停止电影。 QMovie 进入 NotRunning state, and stops emitting updated () 和 resized ()。若 start () is called again, the movie will restart from the beginning.

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

另请参阅 start () 和 setPaused ().

list-of-QByteArray QMovie.supportedFormats ()

Returns the list of image formats supported by QMovie .

该函数在 Qt 4.1 引入。

另请参阅 QImageReader.supportedImageFormats ().


Qt Signal Documentation

void error (QImageReader::ImageReaderError)

This is the default overload of this signal.

此信号被发射由 QMovie when the error error occurred during playback. QMovie will stop the movie, and enter QMovie.NotRunning 状态。

void finished ()

This is the default overload of this signal.

This signal is emitted when the movie has finished.

另请参阅 QMovie.stop ().

void frameChanged (int)

This is the default overload of this signal.

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

该函数在 Qt 4.1 引入。

void resized (const QSize&)

This is the default overload of this 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 () 或 currentPixmap () to get a copy of the updated frame.

void started ()

This is the default overload of this signal.

此信号被发射在 QMovie.start () has been called, and QMovie has entered QMovie.Running 状态。

void stateChanged (QMovie::MovieState)

This is the default overload of this signal.

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

另请参阅 QMovie.state ().

void updated (const QRect&)

This is the default overload of this signal.

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