kde-extraapps/gwenview/app/savebar.cpp

// vim: set tabstop=4 shiftwidth=4 expandtab:
/*
Gwenview: an image viewer
Copyright 2007 Aurélien Gâteau <agateau@kde.org>

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

*/
// Self
#include "moc_savebar.cpp"

// Katie
#include <QHBoxLayout>
#include <QLabel>
#include <QToolButton>
#include <QToolTip>

// KDE
#include <KActionCollection>
#include <KColorScheme>
#include <KDebug>
#include <KIcon>
#include <KIconLoader>
#include <KLocale>
#include <KUrl>
#include <KPixmapWidget>

// Local
#include "lib/document/documentfactory.h"
#include "lib/gwenviewconfig.h"
#include "lib/memoryutils.h"
#include "lib/paintutils.h"

namespace Gwenview
{

QToolButton* createToolButton()
{
    QToolButton* button = new QToolButton;
    button->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
    button->hide();
    return button;
}

struct SaveBarPrivate
{
    SaveBar* q;
    KActionCollection* mActionCollection;
    QWidget* mSaveBarWidget;
    QWidget* mTopRowWidget;
    QToolButton* mUndoButton;
    QToolButton* mRedoButton;
    QToolButton* mSaveCurrentUrlButton;
    QToolButton* mSaveAsButton;
    QToolButton* mSaveAllButton;
    QToolButton* mSaveAllFullScreenButton;
    QLabel* mMessageLabel;
    QLabel* mActionsLabel;
    QFrame* mTooManyChangesFrame;
    KUrl mCurrentUrl;
    bool mFullScreenMode;

    void createTooManyChangesFrame()
    {
#warning TODO: use KMessageWidget instead
        mTooManyChangesFrame = new QFrame();

        // Icon
        KPixmapWidget* iconWidget = new KPixmapWidget();
        QPixmap pix = KIconLoader::global()->loadIcon(
                          "dialog-warning", KIconLoader::Dialog, KIconLoader::SizeSmall);
        iconWidget->setPixmap(pix);

        // Text label
        QLabel* textLabel = new QLabel;
        textLabel->setText(
            i18n("You have modified many images. To avoid memory problems, you should save your changes.")
        );

        mSaveAllFullScreenButton = createToolButton();

        // Layout
        QHBoxLayout* layout = new QHBoxLayout(mTooManyChangesFrame);
        layout->setMargin(0);
        layout->addWidget(iconWidget);
        layout->addWidget(textLabel);
        layout->addWidget(mSaveAllFullScreenButton);
        mTooManyChangesFrame->hide();
    }

    void updateTooManyChangesFrame(const QList<KUrl>& list)
    {
        qreal maxPercentageOfMemoryUsage = GwenviewConfig::percentageOfMemoryUsageWarning();
        qulonglong maxMemoryUsage = MemoryUtils::getTotalMemory() * maxPercentageOfMemoryUsage;
        qulonglong memoryUsage = 0;
        Q_FOREACH(const KUrl & url, list) {
            Document::Ptr doc = DocumentFactory::instance()->load(url);
            memoryUsage += doc->memoryUsage();
        }

        mTooManyChangesFrame->setVisible(memoryUsage > maxMemoryUsage);
    }

    void updateTopRowWidget(const QList<KUrl>& lst)
    {
        QStringList links;
        QString message;

        if (lst.contains(mCurrentUrl)) {
            message = i18n("Current image modified");

            mUndoButton->show();
            mRedoButton->show();

            if (lst.size() > 1) {
                QString previous = i18n("Previous modified image");
                QString next = i18n("Next modified image");
                if (mCurrentUrl == lst[0]) {
                    links << previous;
                } else {
                    links << QString("<a href='previous'>%1</a>").arg(previous);
                }
                if (mCurrentUrl == lst[lst.size() - 1]) {
                    links << next;
                } else {
                    links << QString("<a href='next'>%1</a>").arg(next);
                }
            }
        } else {
            mUndoButton->hide();
            mRedoButton->hide();

            message = i18np("One image modified", "%1 images modified", lst.size());
            if (lst.size() > 1) {
                links << QString("<a href='first'>%1</a>").arg(i18n("Go to first modified image"));
            } else {
                links << QString("<a href='first'>%1</a>").arg(i18n("Go to it"));
            }
        }

        mSaveCurrentUrlButton->setVisible(lst.contains(mCurrentUrl));
        mSaveAsButton->setVisible(lst.contains(mCurrentUrl));
        mSaveAllButton->setVisible(lst.size() >= 1);

        mMessageLabel->setText(message);
        mActionsLabel->setText(links.join(" | "));
    }

    void updateWidgetSizes()
    {
        QVBoxLayout* layout = static_cast<QVBoxLayout*>(mSaveBarWidget->layout());
        int topRowHeight = mFullScreenMode ? 0 : mTopRowWidget->height();
        int bottomRowHeight = mTooManyChangesFrame->isVisibleTo(mSaveBarWidget) ? mTooManyChangesFrame->sizeHint().height() : 0;

        int height = 2 * layout->margin() + topRowHeight + bottomRowHeight;
        if (topRowHeight > 0 && bottomRowHeight > 0) {
            height += layout->spacing();
        }
        mSaveBarWidget->setFixedHeight(height);
    }
};

SaveBar::SaveBar(QWidget* parent, KActionCollection* actionCollection)
: SlideContainer(parent)
, d(new SaveBarPrivate)
{
    d->q = this;
    d->mFullScreenMode = false;
    d->mActionCollection = actionCollection;
    d->mSaveBarWidget = new QWidget();
    d->mSaveBarWidget->setObjectName(QLatin1String("saveBarWidget"));

    d->mMessageLabel = new QLabel();
    d->mMessageLabel->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Fixed);

    d->mUndoButton = createToolButton();
    d->mRedoButton = createToolButton();
    d->mSaveCurrentUrlButton = createToolButton();
    d->mSaveAsButton = createToolButton();
    d->mSaveAllButton = createToolButton();

    d->mActionsLabel = new QLabel();
    d->mActionsLabel->setAlignment(Qt::AlignCenter);
    d->mActionsLabel->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);

    d->createTooManyChangesFrame();

    // Setup top row
    d->mTopRowWidget = new QWidget();
    QHBoxLayout* rowLayout = new QHBoxLayout(d->mTopRowWidget);
    rowLayout->addWidget(d->mMessageLabel);
    rowLayout->addWidget(d->mUndoButton);
    rowLayout->addWidget(d->mRedoButton);
    rowLayout->addWidget(d->mActionsLabel);
    rowLayout->addWidget(d->mSaveCurrentUrlButton);
    rowLayout->addWidget(d->mSaveAsButton);
    rowLayout->addWidget(d->mSaveAllButton);
    rowLayout->setMargin(0);

    // Setup bottom row
    QHBoxLayout* bottomRowLayout = new QHBoxLayout();
    bottomRowLayout->addStretch();
    bottomRowLayout->addWidget(d->mTooManyChangesFrame);
    bottomRowLayout->addStretch();

    // Gather everything together
    QVBoxLayout* layout = new QVBoxLayout(d->mSaveBarWidget);
    layout->addWidget(d->mTopRowWidget);
    layout->addLayout(bottomRowLayout);
    layout->setMargin(3);
    layout->setSpacing(3);

    setContent(d->mSaveBarWidget);

    connect(DocumentFactory::instance(), SIGNAL(modifiedDocumentListChanged()),
            SLOT(updateContent()));

    connect(d->mActionsLabel, SIGNAL(linkActivated(QString)),
            SLOT(triggerAction(QString)));
}

SaveBar::~SaveBar()
{
    delete d;
}

void SaveBar::initActionDependentWidgets()
{
    d->mUndoButton->setDefaultAction(d->mActionCollection->action("edit_undo"));
    d->mRedoButton->setDefaultAction(d->mActionCollection->action("edit_redo"));
    d->mSaveCurrentUrlButton->setDefaultAction(d->mActionCollection->action("file_save"));
    d->mSaveAsButton->setDefaultAction(d->mActionCollection->action("file_save_as"));

    // FIXME: Not using an action for now
    d->mSaveAllButton->setText(i18n("Save All"));
    d->mSaveAllButton->setIcon(KIcon("document-save-all"));
    connect(d->mSaveAllButton, SIGNAL(clicked()),
            SIGNAL(requestSaveAll()));

    d->mSaveAllFullScreenButton->setText(i18n("Save All"));
    connect(d->mSaveAllFullScreenButton, SIGNAL(clicked()),
            SIGNAL(requestSaveAll()));

    int height = d->mUndoButton->sizeHint().height();
    d->mTopRowWidget->setFixedHeight(height);
    d->updateWidgetSizes();
}

void SaveBar::setFullScreenMode(bool value)
{
    d->mFullScreenMode = value;
    d->mSaveAllFullScreenButton->setVisible(value);
    updateContent();
}

void SaveBar::updateContent()
{
    QList<KUrl> lst = DocumentFactory::instance()->modifiedDocumentList();

    if (d->mFullScreenMode) {
        d->mTopRowWidget->hide();
    } else {
        d->mTopRowWidget->show();
        d->updateTopRowWidget(lst);
    }

    d->updateTooManyChangesFrame(lst);

    d->updateWidgetSizes();
    if (lst.isEmpty() || (d->mFullScreenMode && !d->mTooManyChangesFrame->isVisibleTo(d->mSaveBarWidget))) {
        slideOut();
    } else {
        slideIn();
    }
}

void SaveBar::triggerAction(const QString& action)
{
    QList<KUrl> lst = DocumentFactory::instance()->modifiedDocumentList();
    if (action == "first") {
        goToUrl(lst[0]);
    } else if (action == "previous") {
        int pos = lst.indexOf(d->mCurrentUrl);
        --pos;
        Q_ASSERT(pos >= 0);
        goToUrl(lst[pos]);
    } else if (action == "next") {
        int pos = lst.indexOf(d->mCurrentUrl);
        ++pos;
        Q_ASSERT(pos < lst.size());
        goToUrl(lst[pos]);
    } else {
        kWarning() << "Unknown action: " << action ;
    }
}

void SaveBar::setCurrentUrl(const KUrl& url)
{
    d->mCurrentUrl = url;
    updateContent();
}

} // namespace