dnotificationwidget.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2011-07-03
 * Description : A widget to provide feedback or propose opportunistic interactions
 *
 * Copyright (C) 2009-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (c) 2011      by Aurelien Gateau <agateau at kde dot org>
 * Copyright (c) 2014      by Dominik Haumann <dhaumann 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_DNOTIFICATION_WIDGET_H
#define DIGIKAM_DNOTIFICATION_WIDGET_H
 
// Qt includes
 
#include <QFrame>
#include <QIcon>
#include <QString>
#include <QAction>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DNotificationWidget : public QFrame
{
    Q_OBJECT
    Q_PROPERTY(QString text READ text WRITE setText)
    Q_PROPERTY(bool wordWrap READ wordWrap WRITE setWordWrap)
    Q_PROPERTY(bool closeButtonVisible READ isCloseButtonVisible WRITE setCloseButtonVisible)
    Q_PROPERTY(MessageType messageType READ messageType WRITE setMessageType)
    Q_PROPERTY(QIcon icon READ icon WRITE setIcon)
 
public:
 
    enum MessageType
    {
        Positive,
        Information,
        Warning,
        Error
    };
    Q_ENUM(MessageType)
 
public:
 
    explicit DNotificationWidget(QWidget* const parent = nullptr);
 
    explicit DNotificationWidget(const QString& text, QWidget* const parent = nullptr);
 
    ~DNotificationWidget() override;
 
    QString text() const;
 
    bool wordWrap() const;
 
    bool isCloseButtonVisible() const;
 
    MessageType messageType() const;
 
    void addAction(QAction* action);
 
    void removeAction(QAction* action);
 
    void clearAllActions();
 
    QSize sizeHint() const override;
 
    QSize minimumSizeHint() const override;
 
    int heightForWidth(int width) const override;
 
    QIcon icon() const;
 
    bool isHideAnimationRunning() const;
 
    bool isShowAnimationRunning() const;
 
    void animatedShowTemporized(int delay);
 
public Q_SLOTS:
 
    void setText(const QString& text);
 
    void setWordWrap(bool wordWrap);
 
    void setCloseButtonVisible(bool visible);
 
    void setMessageType(DNotificationWidget::MessageType type);
 
    void animatedShow();
 
    void animatedHide();
 
    void setIcon(const QIcon& icon);
 
Q_SIGNALS:
 
    void linkActivated(const QString& contents);
 
    void linkHovered(const QString& contents);
 
    void hideAnimationFinished();
 
    void showAnimationFinished();
 
private Q_SLOTS:
 
    void slotTimerTimeout();
 
protected:
 
    void paintEvent(QPaintEvent* event)   override;
    bool event(QEvent* event)             override;
    void resizeEvent(QResizeEvent* event) override;
 
private:
 
    class Private;
    Private* const d;
 
    friend class Private;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DNOTIFICATION_WIDGET_H