kanimatedbutton.cpp

/*
    This file is part of the KDE libraries
    SPDX-FileCopyrightText: 2000 Kurt Granroth <granroth@kde.org>
    SPDX-FileCopyrightText: 2006 Hamish Rodda <rodda@kde.org>
    SPDX-FileCopyrightText: 2008 Pino Toscano <pino@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-only
*/
 
#include <kanimatedbutton.h>
 
#include <QImageReader>
#include <QMovie>
#include <QPainter>
#include <QPixmap>
#include <QTimer>
 
class KAnimatedButtonPrivate
{
public:
    KAnimatedButtonPrivate(KAnimatedButton *qq)
        : q(qq)
    {
    }
 
    void updateIcons();
    void updateCurrentIcon();
    void movieFrameChanged(int number);
    void movieFinished();
    void timerUpdate();
 
    KAnimatedButton *const q;
    QMovie *movie = nullptr;
 
    int frames;
    int current_frame;
    QPixmap pixmap;
    QTimer timer;
    QString icon_path;
    QList<QPixmap *> framesCache; // We keep copies of each frame so that
    // the icon code can properly cache them in QPixmapCache,
    // and not fill it up with dead copies
};
 
KAnimatedButton::KAnimatedButton(QWidget *parent)
    : QToolButton(parent)
    , d(new KAnimatedButtonPrivate(this))
{
    connect(&d->timer, &QTimer::timeout, this, [this]() {
        d->timerUpdate();
    });
}
 
KAnimatedButton::~KAnimatedButton()
{
    d->timer.stop();
    qDeleteAll(d->framesCache);
    delete d->movie;
}
 
void KAnimatedButton::start()
{
    if (d->movie) {
        d->movie->start();
    } else {
        d->current_frame = 0;
        d->timer.start(50);
    }
}
 
void KAnimatedButton::stop()
{
    if (d->movie) {
        d->movie->stop();
        d->movie->jumpToFrame(0);
        d->movieFrameChanged(0);
    } else {
        d->current_frame = 0;
        d->timer.stop();
        d->updateCurrentIcon();
    }
}
 
void KAnimatedButton::setAnimationPath(const QString &path)
{
    if (d->icon_path == path) {
        return;
    }
 
    d->timer.stop();
    d->icon_path = path;
    d->updateIcons();
}
 
QString KAnimatedButton::animationPath() const
{
    return d->icon_path;
}
 
void KAnimatedButtonPrivate::timerUpdate()
{
    if (!q->isVisible()) {
        return;
    }
 
    current_frame++;
    if (current_frame == frames) {
        current_frame = 0;
    }
 
    updateCurrentIcon();
}
 
void KAnimatedButtonPrivate::updateCurrentIcon()
{
    if (pixmap.isNull()) {
        return;
    }
 
    QPixmap *frame = framesCache[current_frame];
    if (!frame) {
        const int icon_size = qMin(pixmap.width(), pixmap.height());
        const int row_size = pixmap.width() / icon_size;
        const int row = current_frame / row_size;
        const int column = current_frame % row_size;
        frame = new QPixmap(icon_size, icon_size);
        frame->fill(Qt::transparent);
        QPainter p(frame);
        p.drawPixmap(QPoint(0, 0), pixmap, QRect(column * icon_size, row * icon_size, icon_size, icon_size));
        p.end();
        framesCache[current_frame] = frame;
    }
 
    q->setIcon(QIcon(*frame));
}
 
void KAnimatedButtonPrivate::movieFrameChanged(int number)
{
    Q_UNUSED(number);
    q->setIcon(QIcon(movie->currentPixmap()));
}
 
void KAnimatedButtonPrivate::movieFinished()
{
    // if not running, make it loop
    if (movie->state() == QMovie::NotRunning) {
        movie->start();
    }
}
 
void KAnimatedButtonPrivate::updateIcons()
{
    pixmap = QPixmap();
    QMovie *newMovie = nullptr;
    QImageReader reader(icon_path);
    if (QMovie::supportedFormats().contains(reader.format())) {
        newMovie = new QMovie(icon_path);
        frames = 0;
        newMovie->setCacheMode(QMovie::CacheAll);
        QObject::connect(newMovie, &QMovie::frameChanged, q, [this](int value) {
            movieFrameChanged(value);
        });
        QObject::connect(newMovie, &QMovie::finished, q, [this] {
            movieFinished();
        });
    } else {
        const QPixmap pix(icon_path);
        if (pix.isNull()) {
            return;
        }
 
        const int icon_size = qMin(pix.width(), pix.height());
        if ((pix.height() % icon_size != 0) || (pix.width() % icon_size != 0)) {
            return;
        }
 
        frames = (pix.height() / icon_size) * (pix.width() / icon_size);
        pixmap = pix;
    }
 
    current_frame = 0;
    qDeleteAll(framesCache);
    framesCache.fill(nullptr);
    framesCache.resize(frames);
    delete movie;
    movie = newMovie;
 
    if (movie) {
        movie->jumpToFrame(0);
        movieFrameChanged(0);
    } else {
        updateCurrentIcon();
    }
}
 
#include "moc_kanimatedbutton.cpp"