1/****************************************************************************
2**
3** Copyright (C) 2017 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWaylandCompositor module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:GPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU
19** General Public License version 3 or (at your option) any later version
20** approved by the KDE Free Qt Foundation. The licenses are as published by
21** the Free Software Foundation and appearing in the file LICENSE.GPL3
22** included in the packaging of this file. Please review the following
23** information to ensure the GNU General Public License requirements will
24** be met: https://www.gnu.org/licenses/gpl-3.0.html.
25**
26** $QT_END_LICENSE$
27**
28****************************************************************************/
29
30#include "qwaylandquickshellintegration.h"
31
32/*!
33 * \class QWaylandQuickShellIntegration
34 * \inmodule QtWaylandCompositor
35 * \since 5.14
36 * \brief Provides support for shell surface integration with QtQuick.
37 *
38 * Shell surface implementations should inherit from this class in order to provide
39 * an integration between the shell surface and QtQuick.
40 *
41 * Shell integration is installed as an event filter for a QWaylandQuickShellSurfaceItem.
42 * Reimplement the event filter method and return \c true when you want to filter the
43 * event out, otherwise return \c false.
44 *
45 * Example:
46 *
47 * \code
48 * class MyShellIntegration : public QWaylandQuickShellIntegration
49 * {
50 * Q_OBJECT
51 * public:
52 * MyShellIntegration(QObject *parent = nullptr);
53 *
54 * protected:
55 * bool eventFilter(QObject *object, QEvent *event) override;
56 * };
57 *
58 * MyShellIntegration::MyShellIntegration(QObject *parent)
59 * : QWaylandQuickShellIntegration(parent)
60 * {
61 * }
62 *
63 * bool MyShellIntegration::eventFilter(QObject *object, QEvent *event)
64 * {
65 * QWaylandQuickShellSurfaceItem *shellSurfaceItem = qobject_cast<QWaylandQuickShellSurfaceItem *>(object);
66 * if (!shellSurfaceItem)
67 * return QWaylandQuickShellIntegration::eventFilter(object, event);
68 *
69 * if (event->type() == QEvent::MouseMove) {
70 * QMouseEvent *mouseEvent = static_cast<QMouseEvent *>(event);
71 * qDebug() << "Mouse moved on" << shellSurfaceItem << "pos:" << mouseEvent->pos();
72 * return true;
73 * }
74 *
75 * return QWaylandQuickShellIntegration::eventFilter(object, event);
76 * }
77 * \endcode
78 *
79 * \sa QWaylandQuickShellSurfaceItem
80 * \sa QObject::eventFilter()
81 */
82
83QWaylandQuickShellIntegration::QWaylandQuickShellIntegration(QObject *parent)
84 : QObject(parent)
85{
86}
87
88QWaylandQuickShellIntegration::~QWaylandQuickShellIntegration()
89{
90}
91

source code of qtwayland/src/compositor/extensions/qwaylandquickshellintegration.cpp