summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJohan Klokkhammer Helsing <johan.helsing@qt.io>2017-01-11 11:40:53 +0100
committerJohan Helsing <johan.helsing@qt.io>2017-04-21 06:51:41 +0000
commite9bf98d2bf8c1d5d4f671bcb6146ed13de213f01 (patch)
treec733eccc61d39f816f1587c56615df752be014bb
parenta5dd3692697fcf905749b5686d5d7bfbf47969e1 (diff)
Add missing documentation for XdgShellV5v5.9.0-beta3
Change-Id: I96fa1d37b42bfc2cc0a10aafbc2021a8d5b8fd16 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Pier Luigi Fiorini <pierluigi.fiorini@liri.io>
-rw-r--r--src/compositor/extensions/qwaylandxdgshellv5.cpp64
1 files changed, 64 insertions, 0 deletions
diff --git a/src/compositor/extensions/qwaylandxdgshellv5.cpp b/src/compositor/extensions/qwaylandxdgshellv5.cpp
index 6a09a6c7..5d1fb03a 100644
--- a/src/compositor/extensions/qwaylandxdgshellv5.cpp
+++ b/src/compositor/extensions/qwaylandxdgshellv5.cpp
@@ -510,6 +510,44 @@ void QWaylandXdgPopupV5Private::xdg_popup_destroy(Resource *resource)
}
/*!
+ * \qmltype XdgShellV5
+ * \inqmlmodule QtWayland.Compositor
+ * \since 5.8
+ * \brief Provides an extension for desktop-style user interfaces.
+ *
+ * The XdgShellV5 extension provides a way to associate an XdgSurfaceV5
+ * with a regular Wayland surface. Using the xdg_surface interface, the client
+ * can request that the surface is resized, moved, and so on.
+ *
+ * XdgShellV5 corresponds to the Wayland interface \c xdg_shell.
+ *
+ * To provide the functionality of the shell extension in a compositor, create
+ * an instance of the XdgShellV5 component and add it as a child of the
+ * compositor: \code
+ * import QtWayland.Compositor 1.0
+ *
+ * WaylandCompositor {
+ * XdgShellV5 {
+ * // ...
+ * }
+ * }
+ * \endcode
+ */
+
+/*!
+ * \class QWaylandXdgShellV5
+ * \inmodule QtWaylandCompositor
+ * \since 5.8
+ * \brief The QWaylandXdgShellV5 class is an extension for desktop-style user interfaces.
+ *
+ * The QWaylandXdgShellV5 extension provides a way to associate a QWaylandXdgSurfaceV5 with
+ * a regular Wayland surface. Using the xdg_surface interface, the client
+ * can request that the surface is resized, moved, and so on.
+ *
+ * QWaylandXdgShellV5 corresponds to the Wayland interface \c xdg_shell.
+ */
+
+/*!
* Constructs a QWaylandXdgShellV5 object.
*/
QWaylandXdgShellV5::QWaylandXdgShellV5()
@@ -633,6 +671,19 @@ void QWaylandXdgShellV5::handleFocusChanged(QWaylandSurface *newSurface, QWaylan
}
/*!
+ * \qmltype XdgSurfaceV5
+ * \inqmlmodule QtWayland.Compositor
+ * \since 5.8
+ * \brief Provides a \c xdg_surface that offers desktop-style compositor-specific features to a surface.
+ *
+ * This type is part of the \l{XdgShellV5} extension and provides a way to extend
+ * the functionality of an existing WaylandSurface with features specific to desktop-style
+ * compositors, such as resizing and moving the surface.
+ *
+ * It corresponds to the Wayland interface \c xdg_surface for the unstable xdg-shell protocol v5.
+ */
+
+/*!
* \class QWaylandXdgSurfaceV5
* \inmodule QtWaylandCompositor
* \since 5.8
@@ -1048,6 +1099,19 @@ QWaylandQuickShellIntegration *QWaylandXdgSurfaceV5::createIntegration(QWaylandQ
#endif
/*!
+ * \qmltype XdgPopupV5
+ * \inqmlmodule QtWayland.Compositor
+ * \since 5.8
+ * \brief Provides a \c xdg_popup interface that implements popup features for the xdg-shell protocol.
+ *
+ * This type is part of the \l{XdgShellV5} extension and provides a way to extend
+ * the functionality of an existing WaylandSurface for handling popup surfaces created by clients
+ * using xdg-shell.
+ *
+ * It corresponds to the Wayland interface \c xdg_popup for the unstable xdg-shell protocol v5.
+ */
+
+/*!
* \class QWaylandXdgPopupV5
* \inmodule QtWaylandCompositor
* \since 5.8