dnotificationpopup.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2004-07-03
 * Description : dialog-like popup that displays messages without interrupting the user
 *
 * Copyright (C) 2009-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2001-2006 by Richard Moore <rich at kde dot org>
 * Copyright (C) 2004-2005 by Sascha Cunz <sascha.cunz at tiscali dot de>
 *
 * 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_POPUP_H
#define DIGIKAM_DNOTIFICATION_POPUP_H
 
// Qt includes
 
#include <QFrame>
 
// Local includes
 
#include "digikam_export.h"
 
class QSystemTrayIcon;
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DNotificationPopup : public QFrame
{
    Q_OBJECT
    Q_PROPERTY(bool autoDelete READ autoDelete WRITE setAutoDelete)
    Q_PROPERTY(int timeout     READ timeout    WRITE setTimeout)
 
public:
 
    enum PopupStyle
    {
        Boxed,             
        Balloon,           
    };
 
public:
 
    explicit DNotificationPopup(QWidget* const parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());
 
    explicit DNotificationPopup(WId parent);
 
    ~DNotificationPopup() override;
 
    void setView(QWidget* child);
 
    void setView(const QString& caption, const QString& text = QString());
 
    virtual void setView(const QString& caption, const QString& text, const QPixmap& icon);
 
    QWidget* standardView(const QString& caption, const QString& text,
                          const QPixmap& icon, QWidget* parent = nullptr);
 
    QWidget* view() const;
 
    int timeout() const;
 
    virtual void setAutoDelete(bool autoDelete);
 
    bool autoDelete() const;
 
    QPoint anchor() const;
 
    void setAnchor(const QPoint& anchor);
 
    static DNotificationPopup* message(const QString& text, QWidget* parent,
                                       const QPoint& p = QPoint());
 
    static DNotificationPopup* message(const QString& text, QSystemTrayIcon* parent);
 
    static DNotificationPopup* message(const QString& caption, const QString& text,
                                       QWidget* parent, const QPoint& p = QPoint());
 
    static DNotificationPopup* message(const QString& caption, const QString& text,
                                       QSystemTrayIcon* parent);
 
    static DNotificationPopup* message(const QString& caption, const QString& text,
                                       const QPixmap& icon, QWidget* parent, int timeout = -1,
                                       const QPoint& p = QPoint());
 
    static DNotificationPopup* message(const QString& caption, const QString& text,
                                       const QPixmap& icon, QSystemTrayIcon* parent, int timeout = -1);
 
    static DNotificationPopup* message(const QString& caption, const QString& text,
                                       const QPixmap& icon, WId parent,
                                       int timeout = -1, const QPoint& p = QPoint());
 
    static DNotificationPopup* message(int popupStyle, const QString& text, QWidget* parent, const QPoint& p = QPoint());
 
    static DNotificationPopup* message(int popupStyle, const QString& text, QSystemTrayIcon* parent);
 
    static DNotificationPopup* message(int popupStyle, const QString& caption, const QString& text,
                                       QSystemTrayIcon* parent);
 
    static DNotificationPopup* message(int popupStyle, const QString& caption, const QString& text,
                                       QWidget* parent, const QPoint& p = QPoint());
 
    static DNotificationPopup* message(int popupStyle, const QString& caption, const QString& text,
                                       const QPixmap& icon, QWidget* parent, int timeout = -1,
                                       const QPoint& p = QPoint());
 
    static DNotificationPopup* message(int popupStyle, const QString& caption, const QString& text,
                                       const QPixmap& icon, QSystemTrayIcon* parent, int timeout = -1);
 
    static DNotificationPopup* message(int popupStyle, const QString& caption, const QString& text,
                                       const QPixmap& icon, WId parent, int timeout = -1,
                                       const QPoint& p = QPoint());
 
    // we create an overloaded version of show()
    using QFrame::show;
 
public Q_SLOTS:
 
    void setTimeout(int delay);
 
    void setPopupStyle(int popupstyle);
 
    void show(const QPoint& p);
 
    void setVisible(bool visible) override;
 
Q_SIGNALS:
 
    void clicked();
 
    void clicked(const QPoint& pos);
 
protected:
 
    virtual void positionSelf();
 
    virtual QPoint defaultLocation() const;
 
    void moveNear(const QRect& target);
 
    void hideEvent(QHideEvent*) override;
 
    void mouseReleaseEvent(QMouseEvent* e) override;
 
    void paintEvent(QPaintEvent* pe) override;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DNOTIFICATION_POPUP_H