kis_floating_message.h

Go to the documentation of this file.

/*
 *  This file is part of KimageShop^WKrayon^WKrita
 *
 *  SPDX-FileCopyrightText: 2004 Christian Muehlhaeuser <chris@chris.de>
 *  SPDX-FileCopyrightText: 2004-2006 Seb Ruiz <ruiz@kde.org>
 *  SPDX-FileCopyrightText: 2004, 2005 Max Howell <max.howell@methylblue.com>
 *  SPDX-FileCopyrightText: 2005 Gabor Lehel <illissius@gmail.com>
 *  SPDX-FileCopyrightText: 2008, 2009 Mark Kretschmann <kretschmann@kde.org>
 *  SPDX-FileCopyrightText: 2012 Boudewijn Rempt <boud@valdyas.org>
 *  SPDX-FileCopyrightText: 2021 Alvin Wong <alvin@alvinhc.com>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
#ifndef KIS_FLOATING_MESSAGE_H
#define KIS_FLOATING_MESSAGE_H
 
#include <QWidget>
#include <QString>
#include <QImage>
#include <QTimer>
#include <QTimeLine>
 
#include <kritaui_export.h>
 
class QLabel;
 
class KRITAUI_EXPORT KisFloatingMessage : public QWidget
{
    Q_OBJECT
 
public:
    enum Priority {
        High = 0,
        Medium,
        Low
    };
 
    explicit KisFloatingMessage(const QString &message, QWidget *parent, bool showOverParent, int timeout,
                                Priority priority, int alignment = Qt::AlignCenter | Qt::TextWordWrap);
 
    void setShowOverParent(bool show);
 
    void setIcon(const QIcon& icon);
 
    void tryOverrideMessage(const QString message,
                            const QIcon& icon,
                            int timeout,
                            KisFloatingMessage::Priority priority,
                            int alignment = Qt::AlignCenter | Qt::TextWordWrap);
 
public Q_SLOTS:
    void showMessage();
    void removeMessage();
 
private Q_SLOTS:
    void startFade();
    void updateOpacity(int value);
    void widgetDeleted();
private:
 
    QRect determineMetrics(const int M);
 
    QString m_message;
    QImage m_icon;
    QPixmap m_scaledIcon;
    QTimer m_timer;
    int m_m {0};
    QTimeLine m_fadeTimeLine;
    bool m_showOverParent {false};
    int m_timeout {0};
    Priority m_priority;
    int m_alignment {0};
    bool widgetQueuedForDeletion {false};
    QLabel *m_messageLabel {nullptr};
    QLabel *m_iconLabel {nullptr};
};
 
#endif // KIS_FLOATING_MESSAGE_H