diff options
Diffstat (limited to 'src/compositor/extensions/qwaylandshellsurface.cpp')
| -rw-r--r-- | src/compositor/extensions/qwaylandshellsurface.cpp | 140 |
1 files changed, 95 insertions, 45 deletions
diff --git a/src/compositor/extensions/qwaylandshellsurface.cpp b/src/compositor/extensions/qwaylandshellsurface.cpp index 7b59801e9..7e2fcee60 100644 --- a/src/compositor/extensions/qwaylandshellsurface.cpp +++ b/src/compositor/extensions/qwaylandshellsurface.cpp @@ -1,46 +1,46 @@ -/**************************************************************************** -** -** Copyright (C) 2017 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the config.tests of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtWaylandCompositor/QWaylandShellSurface> +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +#include "qwaylandshellsurface_p.h" + +/*! + * \class QWaylandShellSurfaceTemplate + * \inmodule QtWaylandCompositor + * \since 5.8 + * \brief QWaylandShellSurfaceTemplate is a convenience class for creating custom shell surface + * classes. + * + * QWaylandShellSurfaceTemplate is a template class which inherits from QWaylandShellSurface and + * is convenience for building custom shell extensions. + * + * It provides the connection between Qt Wayland Compositor and the class generated by + * \c qtwaylandscanner, based on the XML description of the extension protocol. + * + * It provides two specific pieces of convenience: + * \list + * \li A reimplementation of \l{QWaylandCompositorExtension::extensionInterface()} which returns + * the \c wl_interface pointer for the qtwaylandscanner-generated base class. + * \li A static \l{findIn()} function which searches for an instance of the extension in a + * provided container, and returns this if it is found. + * \endlist + * + * The same usage pattern applies as for QWaylandCompositorExtensionTemplate. + * + * \sa { Custom Shell} + */ + +/*! + * \fn template <typename T> T *QWaylandShellSurfaceTemplate<T>::findIn(QWaylandObject *container) + * + * If any instance of the interface has been registered with \a container, this is returned. + * Otherwise null is returned. The look-up is based on the generated \c interfaceName() which + * matches the interface name in the protocol description. + */ + /*! * \qmltype ShellSurface + * \instantiates QWaylandShellSurface * \inqmlmodule QtWayland.Compositor * \since 5.8 * \brief Provides a common interface for surface roles specified by shell extensions. @@ -48,13 +48,13 @@ * This interface represents a Wayland surface role given by a Wayland protocol extension that * defines how the WaylandSurface should map onto the screen. * - * Note: Even though this type contains a very limited API, the properties and signals of the + * \note Even though this type contains a very limited API, the properties and signals of the * implementations are named consistently. For example, if you're only using desktop shell * extensions in your compositor, it's safe to access properties such as title, maximized, etc. * directly on the ShellSurface. See the various implementations for additional properties and * signals. * - * \sa WaylandSurface, ShellSurfaceItem, WlShellSurface, XdgSurfaceV5, IviSurface + * \sa WaylandSurface, ShellSurfaceItem, WlShellSurface, IviSurface */ /*! @@ -66,7 +66,7 @@ * This interface represents a Wayland surface role given by a Wayland protocol extension that * defines how the QWaylandSurface should map onto the screen. * - * \sa QWaylandSurface, QWaylandWlShellSurface, QWaylandXdgSurfaceV5, QWaylandIviSurface + * \sa QWaylandSurface, QWaylandWlShellSurface, QWaylandIviSurface, QWaylandShellSurfaceTemplate */ #if QT_CONFIG(wayland_compositor_quick) @@ -74,14 +74,14 @@ * \fn QWaylandQuickShellIntegration *QWaylandShellSurface::createIntegration(QWaylandQuickShellSurfaceItem *item) * * Creates a QWaylandQuickShellIntegration for this QWaylandQuickShellSurface. It's called - * automatically when QWaylandQuickShellSurfaceItem::shellSurface is assigned. + * automatically when \a {item}'s \l {QWaylandQuickShellSurfaceItem::}{shellSurface} is assigned. * * \sa QWaylandQuickShellSurfaceItem */ #endif /*! - * \qmlproperty enum QtWaylandCompositor::ShellSurface::windowType + * \qmlproperty enum QtWayland.Compositor::ShellSurface::windowType * * This property holds the window type of the ShellSurface. */ @@ -91,3 +91,53 @@ * * This property holds the window type of the QWaylandShellSurface. */ + +/*! + * \qmlproperty bool QtWayland.Compositor::ShellSurface::modal + * + * This property is true if the ShellSurface represents a modal dialog. + * \since 6.8 + */ + +/*! + * \property QWaylandShellSurface::modal + * + * This property is true if the ShellSurface represents a modal dialog. + * \since 6.8 + */ + +QT_BEGIN_NAMESPACE + +QWaylandShellSurface::QWaylandShellSurface(QWaylandShellSurfacePrivate &dd) + : QWaylandCompositorExtension(dd) +{ +} + +QWaylandShellSurface::QWaylandShellSurface(QWaylandObject *container, QWaylandShellSurfacePrivate &dd) + : QWaylandCompositorExtension(container, dd) +{ +} + +QWaylandShellSurface::QWaylandShellSurface(QWaylandObject *waylandObject) + : QWaylandCompositorExtension(waylandObject, *new QWaylandShellSurfacePrivate) +{ +} + +bool QWaylandShellSurface::modal() const +{ + Q_D(const QWaylandShellSurface); + return d->modal; +} + +void QWaylandShellSurface::setModal(bool newModal) +{ + Q_D(QWaylandShellSurface); + if (d->modal == newModal) + return; + d->modal = newModal; + emit modalChanged(); +} + +QT_END_NAMESPACE + +#include "moc_qwaylandshellsurface.cpp" |