File indexing completed on 2025-01-19 03:56:13

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2007-01-24
  * Description : a progress bar used to display action
  *               progress or a text in status bar.
  *               Progress events are dispatched to ProgressManager.
  *
  * SPDX-FileCopyrightText: 2007-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #include "statusprogressbar.h"
 
 // Qt includes
 
 #include <QWidget>
 #include <QPushButton>
 #include <QHBoxLayout>
 #include <QProgressBar>
 #include <QIcon>
 
 // Local includes
 
 #include "digikam_debug.h"
 #include "progressmanager.h"
 #include "dexpanderbox.h"
 
 namespace Digikam
 {
 
 class Q_DECL_HIDDEN StatusProgressBar::Private
 {
 
 public:
 
     enum WidgetStackEnum
     {
         TextLabel = 0,
         ProgressBar
     };
 
     explicit Private()
       : notify(false),
         progressWidget(nullptr),
         cancelButton(nullptr),
         progressBar(nullptr),
         textLabel(nullptr)
     {
     }
 
     // For Progress Manager item
     bool                notify;
     QString             progressId;
     QString             title;
     QIcon               icon;
 
     QWidget*            progressWidget;
     QPushButton*        cancelButton;
     QProgressBar*       progressBar;
 
     DAdjustableLabel*   textLabel;
 };
 
 StatusProgressBar::StatusProgressBar(QWidget* const parent)
     : QStackedWidget(parent),
       d(new Private)
 {
     setAttribute(Qt::WA_DeleteOnClose);
     setFocusPolicy(Qt::NoFocus);
 
     d->textLabel            = new DAdjustableLabel(this);
     d->progressWidget       = new QWidget(this);
     QHBoxLayout* const hBox = new QHBoxLayout(d->progressWidget);
     d->progressBar          = new QProgressBar(d->progressWidget);
     d->cancelButton         = new QPushButton(d->progressWidget);
     d->cancelButton->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Minimum);
     d->cancelButton->setFocusPolicy(Qt::NoFocus);
     d->cancelButton->setIcon(QIcon::fromTheme(QLatin1String("dialog-cancel")));
     setProgressTotalSteps(100);
 
     // Parent widget will probably have the wait cursor set.
     // Set arrow cursor to indicate the button can be clicked.
 
     d->cancelButton->setCursor(Qt::ArrowCursor);
 
     hBox->addWidget(d->progressBar);
     hBox->addWidget(d->cancelButton);
     hBox->setContentsMargins(QMargins());
     hBox->setSpacing(0);
 
     insertWidget(Private::TextLabel,   d->textLabel);
     insertWidget(Private::ProgressBar, d->progressWidget);
 
     connect(d->cancelButton, SIGNAL(clicked()),
             this, SIGNAL(signalCancelButtonPressed()) );
 
     setProgressBarMode(TextMode);
 }
 
 StatusProgressBar::~StatusProgressBar()
 {
     delete d;
 }
 
 void StatusProgressBar::setNotify(bool b)
 {
     d->notify = b;
 }
 
 void StatusProgressBar::setNotificationTitle(const QString& title, const QIcon& icon)
 {
     d->title = title;
     d->icon  = icon;
 }
 
 void StatusProgressBar::setText(const QString& text)
 {
     d->textLabel->setAdjustedText(text);
 }
 
 void StatusProgressBar::setAlignment(Qt::Alignment a)
 {
     d->textLabel->setAlignment(a);
 }
 
 int StatusProgressBar::progressValue() const
 {
     return d->progressBar->value();
 }
 
 void StatusProgressBar::setProgressValue(int v)
 {
     d->progressBar->setValue(v);
 
     if (d->notify)
     {
         ProgressItem* const item = currentProgressItem();
 
         if (item)
         {
             item->setCompletedItems(v);
             item->updateProgress();
         }
     }
 }
 
 int StatusProgressBar::progressTotalSteps() const
 {
     return d->progressBar->maximum();
 }
 
 void StatusProgressBar::setProgressTotalSteps(int v)
 {
     d->progressBar->setMaximum(v);
 
     if (d->notify)
     {
         ProgressItem* const item = currentProgressItem();
 
         if (item)
         {
             item->setTotalItems(v);
         }
     }
 }
 
 void StatusProgressBar::setProgressText(const QString& text)
 {
     d->progressBar->setFormat(text + QLatin1String(" %p%"));
     d->progressBar->update();
 
     if (d->notify)
     {
         ProgressItem* const item = currentProgressItem();
 
         if (item)
         {
             item->setStatus(text);
         }
     }
 }
 
 void StatusProgressBar::setProgressBarMode(int mode, const QString& text)
 {
     if (mode == TextMode)
     {
         setCurrentIndex(Private::TextLabel);
         setProgressValue(0);
         setText(text);
 
         if (d->notify)
         {
             ProgressItem* const item = currentProgressItem();
 
             if (item)
             {
                 item->setComplete();
             }
         }
     }
     else if (mode == ProgressBarMode)
     {
         d->cancelButton->hide();
         setCurrentIndex(Private::ProgressBar);
         setProgressText(text);
 
         if (d->notify)
         {
             ProgressItem* const item = ProgressManager::createProgressItem(d->title, QString(), false, !d->icon.isNull());
             item->setTotalItems(d->progressBar->maximum());
             item->setCompletedItems(d->progressBar->value());
 
             if (!d->icon.isNull())
             {
                 item->setThumbnail(d->icon);
             }
 
             connect(item, SIGNAL(progressItemCanceled(ProgressItem*)),
                     this, SIGNAL(signalCancelButtonPressed()));
 
             d->progressId = item->id();
         }
     }
     else // CancelProgressBarMode
     {
         d->cancelButton->show();
         setCurrentIndex(Private::ProgressBar);
         setProgressText(text);
 
         if (d->notify)
         {
             ProgressItem* const item = ProgressManager::createProgressItem(d->title, QString(), true, !d->icon.isNull());
             item->setTotalItems(d->progressBar->maximum());
             item->setCompletedItems(d->progressBar->value());
 
             if (!d->icon.isNull())
             {
                 item->setThumbnail(d->icon);
             }
 
             connect(item, SIGNAL(progressItemCanceled(ProgressItem*)),
                     this, SIGNAL(signalCancelButtonPressed()));
 
             d->progressId = item->id();
         }
     }
 }
 
 ProgressItem* StatusProgressBar::currentProgressItem() const
 {
     return (ProgressManager::instance()->findItembyId(d->progressId));
 }
 
 } // namespace Digikam
 
 #include "moc_statusprogressbar.cpp"