07c6878ff0
Summary: Recently we noticed that there are multiple areas where KWin needs to inform the user about how to operate. Examples are: * Screenshot * ColorPicker * Pointer constraint enabled * Pointer constraint about to be removed * Kill Window For Screenshot and ColorPicker we used an EffectFrame to render it. But this is not an optimal solution as it's lacking many features we would need. We cannot properly use it from within KWin core, we cannot implement features like hide on mouse over, etc. etc. This change introduces an OnScreenNotification which supports: * showing an icon * showing a message * timeout It is Qml styled, so that it can be easily adjusted. This is a big improvement over the EffectFrame solution. The Qml file creates a Plasma Dialog of type OSD. Thus KWin places it like the normal OSD windows and also looks kind of similar. In the case of KWin the focus is more on the message, than an icon, so the icon is placed left of the text. While the OnScreenNotification is supposed to be used like a singleton, it doesn't use the KWin singleton pattern. Instead a small wrapper namespace OSD is introduced which provides a convenient API for KWin internal areas to show/hide the notification. By not using the KWin singleton pattern, the OnScreenNotification does not depend on any other parts of KWin and can be easily unit-tested. A few features are still missing and will be added in further commits: * hide-out on mouse over * optional skip close animation (needed for screenshot) * X11 support (not that important as it's mostly for Wayland features) Reviewers: #kwin, #plasma Subscribers: plasma-devel, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D3723
82 lines
2.5 KiB
C++
82 lines
2.5 KiB
C++
/*
|
|
* Copyright 2016 Martin Graesslin <mgraesslin@kde.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 of
|
|
* the License or (at your option) version 3 or any later version
|
|
* accepted by the membership of KDE e.V. (or its successor approved
|
|
* by the membership of KDE e.V.), which shall act as a proxy
|
|
* defined in Section 14 of version 3 of the license.
|
|
*
|
|
* 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.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef KWIN_ONSCREENNOTIFICATION_H
|
|
#define KWIN_ONSCREENNOTIFICATION_H
|
|
|
|
#include <QObject>
|
|
|
|
#include <KSharedConfig>
|
|
|
|
class QTimer;
|
|
class QQmlContext;
|
|
class QQmlComponent;
|
|
class QQmlEngine;
|
|
|
|
namespace KWin {
|
|
|
|
class OnScreenNotification : public QObject
|
|
{
|
|
Q_OBJECT
|
|
Q_PROPERTY(bool visible READ isVisible WRITE setVisible NOTIFY visibleChanged)
|
|
Q_PROPERTY(QString message READ message WRITE setMessage NOTIFY messageChanged)
|
|
Q_PROPERTY(QString iconName READ iconName WRITE setIconName NOTIFY iconNameChanged)
|
|
Q_PROPERTY(int timeout READ timeout WRITE setTimeout NOTIFY timeoutChanged)
|
|
|
|
public:
|
|
explicit OnScreenNotification(QObject *parent = nullptr);
|
|
~OnScreenNotification() override;
|
|
bool isVisible() const;
|
|
QString message() const;
|
|
QString iconName() const;
|
|
int timeout() const;
|
|
|
|
void setVisible(bool m_visible);
|
|
void setMessage(const QString &message);
|
|
void setIconName(const QString &iconName);
|
|
void setTimeout(int timeout);
|
|
|
|
void setConfig(KSharedConfigPtr config);
|
|
void setEngine(QQmlEngine *engine);
|
|
|
|
Q_SIGNALS:
|
|
void visibleChanged();
|
|
void messageChanged();
|
|
void iconNameChanged();
|
|
void timeoutChanged();
|
|
|
|
private:
|
|
void show();
|
|
void ensureQmlContext();
|
|
void ensureQmlComponent();
|
|
bool m_visible = false;
|
|
QString m_message;
|
|
QString m_iconName;
|
|
QTimer *m_timer;
|
|
KSharedConfigPtr m_config;
|
|
QScopedPointer<QQmlContext> m_qmlContext;
|
|
QScopedPointer<QQmlComponent> m_qmlComponent;
|
|
QQmlEngine *m_qmlEngine = nullptr;
|
|
QScopedPointer<QObject> m_mainItem;
|
|
};
|
|
}
|
|
|
|
#endif // KWIN_ONSCREENNOTIFICATION_H
|