progressdialog.h

/* -*- c++ -*-
 * progressdialog.h
 *
 *  SPDX-FileCopyrightText: 2004 Till Adam <adam@kde.org>
 *  based on imapprogressdialog.cpp ,which is
 *  SPDX-FileCopyrightText: 2002-2003 Klarälvdalens Datakonsult AB
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#pragma once
 
#include "kdepim_export.h"
 
#include "progressmanager.h"
 
#include <QMap>
#include <QScrollArea>
 
class QProgressBar;
class QFrame;
class QLabel;
class QPushButton;
 
namespace KPIM
{
class TransactionItem;
class SSLLabel;
 
/**
 * This is a widget that can align itself with another one, without using a layout,
 * so that it can actually be on top of other widgets.
 * Currently the only supported type of alignment is "right aligned, on top of the other widget".
 *
 */
class OverlayWidgetPrivate;
class KDEPIM_EXPORT OverlayWidget : public QFrame
{
    Q_OBJECT
 
public:
    OverlayWidget(QWidget *alignWidget, QWidget *parent);
    ~OverlayWidget() override;
 
    [[nodiscard]] QWidget *alignWidget() const;
    void setAlignWidget(QWidget *alignWidget);
 
protected:
    void resizeEvent(QResizeEvent *ev) override;
    [[nodiscard]] bool eventFilter(QObject *o, QEvent *e) override;
 
private:
    KDEPIM_NO_EXPORT void reposition();
 
private:
    std::unique_ptr<OverlayWidgetPrivate> const d;
};
 
class TransactionItemView : public QScrollArea
{
    Q_OBJECT
public:
    explicit TransactionItemView(QWidget *parent = nullptr, const QString &name = QString());
 
    ~TransactionItemView() override;
 
    TransactionItem *addTransactionItem(ProgressItem *item, bool first);
 
    [[nodiscard]] QSize sizeHint() const override;
    [[nodiscard]] QSize minimumSizeHint() const override;
 
public Q_SLOTS:
    void slotLayoutFirstItem();
 
protected:
    void resizeEvent(QResizeEvent *event) override;
 
private:
    QWidget *mBigBox = nullptr;
};
 
class TransactionItem : public QWidget
{
    Q_OBJECT
public:
    TransactionItem(QWidget *parent, ProgressItem *item, bool first);
 
    ~TransactionItem() override;
 
    void hideHLine();
 
    void setProgress(int progress);
    void setLabel(const QString &);
 
    // the given text is interpreted as RichText, so you might need to
    // .toHtmlEscaped() it before passing
    void setStatus(const QString &);
 
    void setCryptoStatus(KPIM::ProgressItem::CryptoStatus);
    void setTotalSteps(int totalSteps);
 
    [[nodiscard]] ProgressItem *item() const
    {
        return mItem;
    }
 
    void addSubTransaction(ProgressItem *item);
 
    // The progressitem is deleted immediately, we take 5s to go out,
    // so better not use mItem during this time.
    void setItemComplete()
    {
        mItem = nullptr;
    }
 
public Q_SLOTS:
    void slotItemCanceled();
 
protected:
    QProgressBar *mProgress = nullptr;
    QPushButton *mCancelButton = nullptr;
    QLabel *mItemLabel = nullptr;
    QLabel *mItemStatus = nullptr;
    QFrame *mFrame = nullptr;
    SSLLabel *mSSLLabel = nullptr;
    ProgressItem *mItem = nullptr;
};
 
class KDEPIM_EXPORT ProgressDialog : public OverlayWidget
{
    Q_OBJECT
public:
    ProgressDialog(QWidget *alignWidget, QWidget *parent);
    ~ProgressDialog() override;
    void setVisible(bool b) override;
 
    void setShowTypeProgressItem(unsigned int type);
 
    [[nodiscard]] bool wasLastShown() const;
 
public Q_SLOTS:
    void slotToggleVisibility();
 
protected Q_SLOTS:
    void slotTransactionAdded(KPIM::ProgressItem *item);
    void slotTransactionCompleted(KPIM::ProgressItem *item);
    void slotTransactionCanceled(KPIM::ProgressItem *item);
    void slotTransactionProgress(KPIM::ProgressItem *item, unsigned int progress);
    void slotTransactionStatus(KPIM::ProgressItem *item, const QString &);
    void slotTransactionLabel(KPIM::ProgressItem *item, const QString &);
    void slotTransactionCryptoStatus(KPIM::ProgressItem *item, KPIM::ProgressItem::CryptoStatus);
    void slotTransactionUsesBusyIndicator(KPIM::ProgressItem *, bool);
 
    void slotClose();
    void slotShow();
    void slotHide();
 
Q_SIGNALS:
    void visibilityChanged(bool);
 
protected:
    void closeEvent(QCloseEvent *) override;
 
    TransactionItemView *mScrollView = nullptr;
    QList<QMetaObject::Connection> mConnections;
    QMap<const ProgressItem *, TransactionItem *> mTransactionsToListviewItems;
    unsigned int mShowTypeProgressItem = 0;
    bool mWasLastShown = false;
};
} // namespace KPIM