From 8ce0185c92a8914b54eb12c8be1ce1c873befa55 Mon Sep 17 00:00:00 2001 From: Johan Klokkhammer Helsing Date: Thu, 11 Jan 2018 13:06:26 +0100 Subject: Fix incorrect documentation of QWaylandQuickItem::paintEnabled Change-Id: Id24b417687843709d9f7df499c4e8c8428f658b6 Reviewed-by: Martin Smith Reviewed-by: Paul Olav Tvete --- src/compositor/compositor_api/qwaylandquickitem.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp index 00c3117ad..ceef4d2cc 100644 --- a/src/compositor/compositor_api/qwaylandquickitem.cpp +++ b/src/compositor/compositor_api/qwaylandquickitem.cpp @@ -1064,14 +1064,14 @@ QVariant QWaylandQuickItem::inputMethodQuery(Qt::InputMethodQuery query, QVarian Returns true if the item is hidden, though the texture is still updated. As opposed to hiding the item by - setting \l{Item::visible}{visible} to \c false, setting this property to \c true + setting \l{Item::visible}{visible} to \c false, setting this property to \c false will not prevent mouse or keyboard input from reaching item. */ /*! Returns true if the item is hidden, though the texture is still updated. As opposed to hiding the item by - setting \l{Item::visible}{visible} to \c false, setting this property to \c true + setting \l{Item::visible}{visible} to \c false, setting this property to \c false will not prevent mouse or keyboard input from reaching item. */ bool QWaylandQuickItem::paintEnabled() const -- cgit v1.2.3 From 9f1db9d0ae60ffe8be1453a57be3b8f2861e4882 Mon Sep 17 00:00:00 2001 From: Johan Klokkhammer Helsing Date: Tue, 8 Aug 2017 13:32:19 +0200 Subject: Add documentation for QWaylandShellSurface Change-Id: I5948aea1afdd8b9a71e6de128a5203eb9422f5e1 Reviewed-by: Pier Luigi Fiorini Reviewed-by: Martin Smith --- src/compositor/extensions/extensions.pri | 1 + src/compositor/extensions/qwaylandshellsurface.cpp | 93 ++++++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 src/compositor/extensions/qwaylandshellsurface.cpp diff --git a/src/compositor/extensions/extensions.pri b/src/compositor/extensions/extensions.pri index 9c5b37eac..6b189748d 100644 --- a/src/compositor/extensions/extensions.pri +++ b/src/compositor/extensions/extensions.pri @@ -42,6 +42,7 @@ SOURCES += \ extensions/qwaylandtextinputmanager.cpp \ extensions/qwaylandqtwindowmanager.cpp \ extensions/qwaylandxdgshellv5.cpp \ + extensions/qwaylandshellsurface.cpp \ extensions/qwaylandiviapplication.cpp \ extensions/qwaylandivisurface.cpp \ diff --git a/src/compositor/extensions/qwaylandshellsurface.cpp b/src/compositor/extensions/qwaylandshellsurface.cpp new file mode 100644 index 000000000..c1cd5272e --- /dev/null +++ b/src/compositor/extensions/qwaylandshellsurface.cpp @@ -0,0 +1,93 @@ +/**************************************************************************** +** +** 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 + +/*! + * \qmltype ShellSurface + * \inqmlmodule QtWayland.Compositor + * \since 5.8 + * \brief Provides a common interface for surface roles specified by shell extensions + * + * 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 + * 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 + */ + +/*! + * \class QWaylandShellSurface + * \inmodule QtWaylandCompositor + * \since 5.8 + * \brief The QWaylandShellSurface class is a common interface for surface roles specified by shell extensions + * + * 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 + */ + +#ifdef QT_WAYLAND_COMPOSITOR_QUICK +/*! + * \fn QWaylandQuickShellIntegration *QWaylandShellSurface::createIntegration(QWaylandQuickShellSurfaceItem *item) + * + * Creates a QWaylandQuickShellIntegration for this QWaylandQuickShellSurface. It's called + * automatically when QWaylandQuickShellSurfaceItem::shellSurface is assigned. + * + * \sa QWaylandQuickShellSurfaceItem + */ +#endif + +/*! + * \qmlproperty enum QtWaylandCompositor::ShellSurface::windowType + * + * This property holds the window type of the ShellSurface. + */ + +/*! + * \property QWaylandWlShellSurface::windowType + * + * This property holds the window type of the QWaylandShellSurface. + */ -- cgit v1.2.3