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 config.tests 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 <QtWaylandCompositor/QWaylandShellSurface>
31
32/*!
33 * \qmltype ShellSurface
34 * \instantiates QWaylandShellSurface
35 * \inqmlmodule QtWayland.Compositor
36 * \since 5.8
37 * \brief Provides a common interface for surface roles specified by shell extensions.
38 *
39 * This interface represents a Wayland surface role given by a Wayland protocol extension that
40 * defines how the WaylandSurface should map onto the screen.
41 *
42 * Note: Even though this type contains a very limited API, the properties and signals of the
43 * implementations are named consistently. For example, if you're only using desktop shell
44 * extensions in your compositor, it's safe to access properties such as title, maximized, etc.
45 * directly on the ShellSurface. See the various implementations for additional properties and
46 * signals.
47 *
48 * \sa WaylandSurface, ShellSurfaceItem, WlShellSurface, XdgSurfaceV5, IviSurface
49 */
50
51/*!
52 * \class QWaylandShellSurface
53 * \inmodule QtWaylandCompositor
54 * \since 5.8
55 * \brief The QWaylandShellSurface class is a common interface for surface roles specified by shell extensions.
56 *
57 * This interface represents a Wayland surface role given by a Wayland protocol extension that
58 * defines how the QWaylandSurface should map onto the screen.
59 *
60 * \sa QWaylandSurface, QWaylandWlShellSurface, QWaylandXdgSurfaceV5, QWaylandIviSurface
61 */
62
63#if QT_CONFIG(wayland_compositor_quick)
64/*!
65 * \fn QWaylandQuickShellIntegration *QWaylandShellSurface::createIntegration(QWaylandQuickShellSurfaceItem *item)
66 *
67 * Creates a QWaylandQuickShellIntegration for this QWaylandQuickShellSurface. It's called
68 * automatically when \a {item}'s \l {QWaylandQuickShellSurfaceItem::}{shellSurface} is assigned.
69 *
70 * \sa QWaylandQuickShellSurfaceItem
71 */
72#endif
73
74/*!
75 * \qmlproperty enum QtWaylandCompositor::ShellSurface::windowType
76 *
77 * This property holds the window type of the ShellSurface.
78 */
79
80/*!
81 * \property QWaylandShellSurface::windowType
82 *
83 * This property holds the window type of the QWaylandShellSurface.
84 */
85

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