-
Bea Lam authored
Adds some missing docs and fixes some incorrect doc references. Also removes AnimatedImage docs that were exactly the same as those in base Image type docs. Change-Id: I1357d3c00e63f1b08683bb78246de93dcc0dac7f Reviewed-by:Andrew den Exter <andrew.den-exter@nokia.com>
49882aea
qquickanimatedimage.cpp 11.29 KiB
/******************************************************************************** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).** Contact: http://www.qt-project.org/**** This file is part of the QtQml module of the Qt Toolkit.**** $QT_BEGIN_LICENSE:LGPL$** GNU Lesser General Public License Usage** This file may be used under the terms of the GNU Lesser General Public** License version 2.1 as published by the Free Software Foundation and** appearing in the file LICENSE.LGPL included in the packaging of this** file. Please review the following information to ensure the GNU Lesser** General Public License version 2.1 requirements will be met:** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.**** In addition, as a special exception, Nokia gives you certain additional** rights. These rights are described in the Nokia Qt LGPL Exception** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.**** GNU General Public License Usage** Alternatively, this file may be used under the terms of the GNU General** Public License version 3.0 as published by the Free Software Foundation** and appearing in the file LICENSE.GPL included in the packaging of this** file. Please review the following information to ensure the GNU General** Public License version 3.0 requirements will be met:** http://www.gnu.org/copyleft/gpl.html.**** Other Usage** Alternatively, this file may be used in accordance with the terms and** conditions contained in a signed written agreement between you and Nokia.************** $QT_END_LICENSE$******************************************************************************/#include "qquickanimatedimage_p.h"#include "qquickanimatedimage_p_p.h"#ifndef QT_NO_MOVIE#include <QtQml/qqmlinfo.h>#include <QtQml/qqmlfile.h>#include <QtQml/qqmlengine.h>#include <QtGui/qmovie.h>#include <QtNetwork/qnetworkrequest.h>#include <QtNetwork/qnetworkreply.h>QT_BEGIN_NAMESPACE/*! \qmltype AnimatedImage \instantiates QQuickAnimatedImage \inqmlmodule QtQuick 2 \inherits Image \brief Plays animations stored as a series of images \ingroup qtquick-visual The AnimatedImage type extends the features of the \l Image type, providing a way to play animations stored as images containing a series of frames, such as those stored in GIF files. Information about the current frame and total length of the animation can be obtained using the \l currentFrame and \l frameCount properties. You can start, pause and stop the animation by changing the values of the \l playing and \l paused properties.7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
The full list of supported formats can be determined with QMovie::supportedFormats().
\section1 Example Usage
\beginfloatleft
\image animatedimageitem.gif
\endfloat
The following QML shows how to display an animated image and obtain information
about its state, such as the current frame and total number of frames.
The result is an animated image with a simple progress indicator underneath it.
\b Note: Unlike images, animated images are not cached or shared internally.
\clearfloat
\snippet qml/animatedimage.qml document
\sa BorderImage, Image
*/
/*!
\qmlproperty url QtQuick2::AnimatedImage::source
This property holds the URL that refers to the source image.
AnimatedImage can handle any image format supported by Qt, loaded from any
URL scheme supported by Qt.
\sa QQuickImageProvider
*/
QQuickAnimatedImage::QQuickAnimatedImage(QQuickItem *parent)
: QQuickImage(*(new QQuickAnimatedImagePrivate), parent)
{
}
QQuickAnimatedImage::~QQuickAnimatedImage()
{
Q_D(QQuickAnimatedImage);
if (d->reply)
d->reply->deleteLater();
delete d->_movie;
}
/*!
\qmlproperty bool QtQuick2::AnimatedImage::paused
This property holds whether the animated image is paused.
By default, this property is false. Set it to true when you want to pause
the animation.
*/
bool QQuickAnimatedImage::isPaused() const
{
Q_D(const QQuickAnimatedImage);
if (!d->_movie)
return d->paused;
return d->_movie->state()==QMovie::Paused;
}
void QQuickAnimatedImage::setPaused(bool pause)
{
Q_D(QQuickAnimatedImage);
if (pause == d->paused)
return;
if (!d->_movie) {
d->paused = pause;
emit pausedChanged();
} else {
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
d->_movie->setPaused(pause);
}
}
/*!
\qmlproperty bool QtQuick2::AnimatedImage::playing
This property holds whether the animated image is playing.
By default, this property is true, meaning that the animation
will start playing immediately.
\b Note: this property is affected by changes to the actual playing
state of AnimatedImage. If non-animated images are used, \a playing
will need to be manually set to \a true in order to animate
following images.
\qml
AnimatedImage {
onStatusChanged: playing = (status == AnimatedImage.Ready)
}
\endqml
*/
bool QQuickAnimatedImage::isPlaying() const
{
Q_D(const QQuickAnimatedImage);
if (!d->_movie)
return d->playing;
return d->_movie->state()!=QMovie::NotRunning;
}
void QQuickAnimatedImage::setPlaying(bool play)
{
Q_D(QQuickAnimatedImage);
if (play == d->playing)
return;
if (!d->_movie) {
d->playing = play;
emit playingChanged();
return;
}
if (play)
d->_movie->start();
else
d->_movie->stop();
}
/*!
\qmlproperty int QtQuick2::AnimatedImage::currentFrame
\qmlproperty int QtQuick2::AnimatedImage::frameCount
currentFrame is the frame that is currently visible. By monitoring this property
for changes, you can animate other items at the same time as the image.
frameCount is the number of frames in the animation. For some animation formats,
frameCount is unknown and has a value of zero.
*/
int QQuickAnimatedImage::currentFrame() const
{
Q_D(const QQuickAnimatedImage);
if (!d->_movie)
return d->preset_currentframe;
return d->_movie->currentFrameNumber();
}
void QQuickAnimatedImage::setCurrentFrame(int frame)
{
Q_D(QQuickAnimatedImage);
if (!d->_movie) {
d->preset_currentframe = frame;
return;
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
}
d->_movie->jumpToFrame(frame);
}
int QQuickAnimatedImage::frameCount() const
{
Q_D(const QQuickAnimatedImage);
if (!d->_movie)
return 0;
return d->_movie->frameCount();
}
void QQuickAnimatedImage::setSource(const QUrl &url)
{
Q_D(QQuickAnimatedImage);
if (url == d->url)
return;
if (d->reply) {
d->reply->deleteLater();
d->reply = 0;
}
d->oldPlaying = isPlaying();
if (d->_movie) {
delete d->_movie;
d->_movie = 0;
}
d->url = url;
emit sourceChanged(d->url);
if (isComponentComplete())
load();
}
void QQuickAnimatedImage::load()
{
Q_D(QQuickAnimatedImage);
if (d->url.isEmpty()) {
if (d->progress != 0) {
d->progress = 0;
emit progressChanged(d->progress);
}
d->setImage(QImage());
d->status = Null;
emit statusChanged(d->status);
if (sourceSize() != d->oldSourceSize) {
d->oldSourceSize = sourceSize();
emit sourceSizeChanged();
}
if (isPlaying() != d->oldPlaying)
emit playingChanged();
} else {
QString lf = QQmlFile::urlToLocalFileOrQrc(d->url);
if (!lf.isEmpty()) {
d->_movie = new QMovie(lf);
movieRequestFinished();
} else {
if (d->status != Loading) {
d->status = Loading;
emit statusChanged(d->status);
}
if (d->progress != 0) {
d->progress = 0;
emit progressChanged(d->progress);
}
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
QNetworkRequest req(d->url);
req.setAttribute(QNetworkRequest::HttpPipeliningAllowedAttribute, true);
d->reply = qmlEngine(this)->networkAccessManager()->get(req);
QObject::connect(d->reply, SIGNAL(finished()),
this, SLOT(movieRequestFinished()));
QObject::connect(d->reply, SIGNAL(downloadProgress(qint64,qint64)),
this, SLOT(requestProgress(qint64,qint64)));
}
}
}
#define ANIMATEDIMAGE_MAXIMUM_REDIRECT_RECURSION 16
void QQuickAnimatedImage::movieRequestFinished()
{
Q_D(QQuickAnimatedImage);
if (d->reply) {
d->redirectCount++;
if (d->redirectCount < ANIMATEDIMAGE_MAXIMUM_REDIRECT_RECURSION) {
QVariant redirect = d->reply->attribute(QNetworkRequest::RedirectionTargetAttribute);
if (redirect.isValid()) {
QUrl url = d->reply->url().resolved(redirect.toUrl());
d->reply->deleteLater();
setSource(url);
return;
}
}
d->redirectCount=0;
d->_movie = new QMovie(d->reply);
}
if (!d->_movie->isValid()) {
qmlInfo(this) << "Error Reading Animated Image File " << d->url.toString();
delete d->_movie;
d->_movie = 0;
d->setImage(QImage());
if (d->progress != 0) {
d->progress = 0;
emit progressChanged(d->progress);
}
d->status = Error;
emit statusChanged(d->status);
if (sourceSize() != d->oldSourceSize) {
d->oldSourceSize = sourceSize();
emit sourceSizeChanged();
}
if (isPlaying() != d->oldPlaying)
emit playingChanged();
return;
}
connect(d->_movie, SIGNAL(stateChanged(QMovie::MovieState)),
this, SLOT(playingStatusChanged()));
connect(d->_movie, SIGNAL(frameChanged(int)),
this, SLOT(movieUpdate()));
d->_movie->setCacheMode(QMovie::CacheAll);
d->status = Ready;
emit statusChanged(d->status);
if (d->progress != 1.0) {
d->progress = 1.0;
emit progressChanged(d->progress);
}
bool pausedAtStart = d->paused;
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
if (d->playing) {
d->_movie->start();
}
if (pausedAtStart)
d->_movie->setPaused(true);
if (d->paused || !d->playing) {
d->_movie->jumpToFrame(d->preset_currentframe);
d->preset_currentframe = 0;
}
d->setImage(d->_movie->currentPixmap().toImage());
if (isPlaying() != d->oldPlaying)
emit playingChanged();
if (sourceSize() != d->oldSourceSize) {
d->oldSourceSize = sourceSize();
emit sourceSizeChanged();
}
}
void QQuickAnimatedImage::movieUpdate()
{
Q_D(QQuickAnimatedImage);
if (d->_movie) {
d->setImage(d->_movie->currentPixmap().toImage());
emit frameChanged();
}
}
void QQuickAnimatedImage::playingStatusChanged()
{
Q_D(QQuickAnimatedImage);
if ((d->_movie->state() != QMovie::NotRunning) != d->playing) {
d->playing = (d->_movie->state() != QMovie::NotRunning);
emit playingChanged();
}
if ((d->_movie->state() == QMovie::Paused) != d->paused) {
d->paused = (d->_movie->state() == QMovie::Paused);
emit pausedChanged();
}
}
QSize QQuickAnimatedImage::sourceSize()
{
Q_D(QQuickAnimatedImage);
if (!d->_movie)
return QSize(0, 0);
return QSize(d->_movie->currentPixmap().size());
}
void QQuickAnimatedImage::componentComplete()
{
QQuickItem::componentComplete(); // NOT QQuickImage
load();
}
QT_END_NAMESPACE
#endif // QT_NO_MOVIE