File indexing completed on 2024-11-10 04:57:51

 /*
     SPDX-FileCopyrightText: 2016 Martin Graesslin <mgraesslin@kde.org>
 
     SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 
 */
 #include "onscreennotification.h"
 
 #include <config-kwin.h>
 
 #include "input.h"
 #include "input_event.h"
 #include "input_event_spy.h"
 
 #include <QPropertyAnimation>
 #include <QQmlComponent>
 #include <QQmlContext>
 #include <QQmlEngine>
 #include <QQuickWindow>
 #include <QStandardPaths>
 #include <QTimer>
 
 #include <KConfigGroup>
 
 #include <functional>
 
 namespace KWin
 {
 
 class OnScreenNotificationInputEventSpy : public InputEventSpy
 {
 public:
     explicit OnScreenNotificationInputEventSpy(OnScreenNotification *parent);
 
     void pointerEvent(MouseEvent *event) override;
 
 private:
     OnScreenNotification *m_parent;
 };
 
 OnScreenNotificationInputEventSpy::OnScreenNotificationInputEventSpy(OnScreenNotification *parent)
     : m_parent(parent)
 {
 }
 
 void OnScreenNotificationInputEventSpy::pointerEvent(MouseEvent *event)
 {
     if (event->type() != QEvent::MouseMove) {
         return;
     }
 
     m_parent->setContainsPointer(m_parent->geometry().contains(event->globalPos()));
 }
 
 OnScreenNotification::OnScreenNotification(QObject *parent)
     : QObject(parent)
     , m_timer(new QTimer(this))
 {
     m_timer->setSingleShot(true);
     connect(m_timer, &QTimer::timeout, this, std::bind(&OnScreenNotification::setVisible, this, false));
     connect(this, &OnScreenNotification::visibleChanged, this, [this]() {
         if (m_visible) {
             show();
         } else {
             m_timer->stop();
             m_spy.reset();
             m_containsPointer = false;
         }
     });
 }
 
 OnScreenNotification::~OnScreenNotification()
 {
     if (QQuickWindow *w = qobject_cast<QQuickWindow *>(m_mainItem.get())) {
         w->hide();
         w->destroy();
     }
 }
 
 void OnScreenNotification::setConfig(KSharedConfigPtr config)
 {
     m_config = config;
 }
 
 void OnScreenNotification::setEngine(QQmlEngine *engine)
 {
     m_qmlEngine = engine;
 }
 
 bool OnScreenNotification::isVisible() const
 {
     return m_visible;
 }
 
 void OnScreenNotification::setVisible(bool visible)
 {
     if (m_visible == visible) {
         return;
     }
     m_visible = visible;
     Q_EMIT visibleChanged();
 }
 
 QString OnScreenNotification::message() const
 {
     return m_message;
 }
 
 void OnScreenNotification::setMessage(const QString &message)
 {
     if (m_message == message) {
         return;
     }
     m_message = message;
     Q_EMIT messageChanged();
 }
 
 QString OnScreenNotification::iconName() const
 {
     return m_iconName;
 }
 
 void OnScreenNotification::setIconName(const QString &iconName)
 {
     if (m_iconName == iconName) {
         return;
     }
     m_iconName = iconName;
     Q_EMIT iconNameChanged();
 }
 
 int OnScreenNotification::timeout() const
 {
     return m_timer->interval();
 }
 
 void OnScreenNotification::setTimeout(int timeout)
 {
     if (m_timer->interval() == timeout) {
         return;
     }
     m_timer->setInterval(timeout);
     Q_EMIT timeoutChanged();
 }
 
 void OnScreenNotification::show()
 {
     Q_ASSERT(m_visible);
     ensureQmlContext();
     ensureQmlComponent();
     createInputSpy();
     if (m_timer->interval() != 0) {
         m_timer->start();
     }
 }
 
 void OnScreenNotification::ensureQmlContext()
 {
     Q_ASSERT(m_qmlEngine);
     if (m_qmlContext) {
         return;
     }
     m_qmlContext = std::make_unique<QQmlContext>(m_qmlEngine);
     m_qmlContext->setContextProperty(QStringLiteral("osd"), this);
 }
 
 void OnScreenNotification::ensureQmlComponent()
 {
     Q_ASSERT(m_config);
     Q_ASSERT(m_qmlEngine);
     if (m_qmlComponent) {
         return;
     }
     m_qmlComponent = std::make_unique<QQmlComponent>(m_qmlEngine);
     const QString fileName = QStandardPaths::locate(QStandardPaths::GenericDataLocation,
                                                     m_config->group(QStringLiteral("OnScreenNotification")).readEntry("QmlPath", QStringLiteral("kwin/onscreennotification/plasma/main.qml")));
     if (fileName.isEmpty()) {
         return;
     }
     m_qmlComponent->loadUrl(QUrl::fromLocalFile(fileName));
     if (!m_qmlComponent->isError()) {
         m_mainItem.reset(m_qmlComponent->create(m_qmlContext.get()));
     } else {
         m_qmlComponent.reset();
     }
 }
 
 void OnScreenNotification::createInputSpy()
 {
     Q_ASSERT(!m_spy);
     if (auto w = qobject_cast<QQuickWindow *>(m_mainItem.get())) {
         m_spy = std::make_unique<OnScreenNotificationInputEventSpy>(this);
         input()->installInputEventSpy(m_spy.get());
         if (!m_animation) {
             m_animation = new QPropertyAnimation(w, "opacity", this);
             m_animation->setStartValue(1.0);
             m_animation->setEndValue(0.0);
             m_animation->setDuration(250);
             m_animation->setEasingCurve(QEasingCurve::InOutCubic);
         }
     }
 }
 
 QRect OnScreenNotification::geometry() const
 {
     if (QQuickWindow *w = qobject_cast<QQuickWindow *>(m_mainItem.get())) {
         return w->geometry();
     }
     return QRect();
 }
 
 void OnScreenNotification::setContainsPointer(bool contains)
 {
     if (m_containsPointer == contains) {
         return;
     }
     m_containsPointer = contains;
     if (!m_animation) {
         return;
     }
     m_animation->setDirection(m_containsPointer ? QAbstractAnimation::Forward : QAbstractAnimation::Backward);
     m_animation->start();
 }
 
 void OnScreenNotification::setSkipCloseAnimation(bool skip)
 {
     if (QQuickWindow *w = qobject_cast<QQuickWindow *>(m_mainItem.get())) {
         w->setProperty("KWIN_SKIP_CLOSE_ANIMATION", skip);
     }
 }
 
 } // namespace KWin
 
 #include "moc_onscreennotification.cpp"