progressmanager.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2012-01-13
 * Description : progress manager
 *
 * Copyright (C) 2007-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2012      by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2004      by Till Adam <adam at kde dot 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, 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_PROGRESS_MANAGER_H
#define DIGIKAM_PROGRESS_MANAGER_H
 
// Qt includes
 
#include <QObject>
#include <QString>
#include <QMap>
#include <QHash>
#include <QPixmap>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT ProgressItem : public QObject
{
    Q_OBJECT
 
public:
 
    ProgressItem(ProgressItem* const parent,
                 const QString& id,
                 const QString& label,
                 const QString& status,
                 bool canBeCanceled,
                 bool hasThumb);
    ~ProgressItem() override;
 
    void setShowAtStart(bool showAtStart);
 
    bool showAtStart()                                      const;
 
    const QString& id()                                     const;
 
    ProgressItem* parent()                                  const;
 
    const QString& label()                                  const;
 
    void setLabel(const QString& v);
 
    const QString& status()                                 const;
 
    void setStatus(const QString& v);
 
    bool canBeCanceled()                                    const;
 
    bool usesBusyIndicator()                                const;
 
    void setUsesBusyIndicator(bool useBusyIndicator);
 
    bool hasThumbnail()                                     const;
 
    void setThumbnail(const QIcon &icon);
 
    unsigned int progress()                                 const;
 
    void setProgress(unsigned int v);
 
    void setComplete();
 
    void reset();
 
    void cancel();
    bool canceled()                                         const;
 
    // Often needed values for calculating progress.
    void         setTotalItems(unsigned int v);
    void         incTotalItems(unsigned int v = 1);
    unsigned int totalItems()                               const;
    bool         setCompletedItems(unsigned int v);
    bool         incCompletedItems(unsigned int v = 1);
    unsigned int completedItems()                           const;
    bool         totalCompleted()                           const;
 
    void updateProgress();
 
    bool advance(unsigned int v);
 
    void addChild(ProgressItem* const kiddo);
    void removeChild(ProgressItem* const kiddo);
 
Q_SIGNALS:
 
    void progressItemAdded(ProgressItem*);
 
    void progressItemProgress(ProgressItem*, unsigned int);
 
    void progressItemCompleted(ProgressItem*);
 
    void progressItemCanceled(ProgressItem*);
    void progressItemCanceledById(const QString& id);
 
    void progressItemStatus(ProgressItem*, const QString&);
 
    void progressItemLabel(ProgressItem*, const QString&);
 
    void progressItemUsesBusyIndicator(ProgressItem* item, bool value);
 
    void progressItemThumbnail(ProgressItem* item, const QPixmap& thumb);
 
private:
 
    class Private;
    Private* const d;
};
 
// --------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT ProgressManager : public QObject
{
    Q_OBJECT
 
public:
 
    bool isEmpty()                                  const;
 
    ProgressItem* findItembyId(const QString& id)   const;
 
    ProgressItem* singleItem()                      const;
 
    static ProgressManager* instance();
 
    QString getUniqueID();
 
    static ProgressItem* createProgressItem(const QString& label,
                                            const QString& status = QString(),
                                            bool  canBeCanceled = true,
                                            bool  hasThumb = false);
 
    static ProgressItem* createProgressItem(ProgressItem* const parent,
                                            const QString& id,
                                            const QString& label,
                                            const QString& status = QString(),
                                            bool  canBeCanceled = true,
                                            bool  hasThumb = false);
 
    static ProgressItem* createProgressItem(const QString& parent,
                                            const QString& id,
                                            const QString& label,
                                            const QString& status = QString(),
                                            bool  canBeCanceled = true,
                                            bool  hasThumb = false);
 
    static ProgressItem* createProgressItem(const QString& id,
                                            const QString& label,
                                            const QString& status = QString(),
                                            bool  canBeCanceled = true,
                                            bool  hasThumb = false);
 
    static bool addProgressItem(ProgressItem* const t, ProgressItem* const parent = nullptr);
 
    static void emitShowProgressView();
 
Q_SIGNALS:
 
    void progressItemAdded(ProgressItem*);
 
    void progressItemProgress(ProgressItem*, unsigned int);
 
    void progressItemCompleted(ProgressItem*);
 
    void progressItemCanceled(ProgressItem*);
 
    void progressItemStatus(ProgressItem*, const QString&);
 
    void progressItemLabel(ProgressItem*, const QString&);
 
    void progressItemUsesBusyIndicator(ProgressItem*, bool);
 
    void progressItemThumbnail(ProgressItem*, const QPixmap&);
 
    void showProgressView();
 
    void completeTransactionDeferred(ProgressItem* item);
 
public Q_SLOTS:
 
    void slotStandardCancelHandler(ProgressItem* item);
 
    void slotAbortAll();
 
private Q_SLOTS:
 
    void slotTransactionCompleted(ProgressItem* item);
    void slotTransactionCompletedDeferred(ProgressItem* item);
    void slotTransactionViewIsEmpty();
 
private:
 
    // Disable
    ProgressManager();
    ProgressManager(QObject*);
    ProgressManager(const ProgressManager&);
    ~ProgressManager() override;
 
    void emitShowProgressViewImpl();
 
    virtual ProgressItem* createProgressItemImpl(ProgressItem* const parent,
                                                 const QString& id,
                                                 const QString& label,
                                                 const QString& status,
                                                 bool  cancellable,
                                                 bool  hasThumb);
 
    virtual ProgressItem* createProgressItemImpl(const QString& parent,
                                                 const QString& id,
                                                 const QString& label,
                                                 const QString& status,
                                                 bool  cancellable,
                                                 bool  hasThumb);
 
    virtual void addProgressItemImpl(ProgressItem* const t, ProgressItem* const parent);
 
private:
 
    class Private;
    Private* const d;
 
    friend class ProgressManagerCreator;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_PROGRESS_MANAGER_H