diff options
author | Johan Klokkhammer Helsing <johan.helsing@qt.io> | 2018-03-16 14:44:30 +0100 |
---|---|---|
committer | Johan Helsing <johan.helsing@qt.io> | 2018-03-26 14:53:44 +0000 |
commit | 7fcd4a2b24dbc0834b96baaeb432abc032ba4020 (patch) | |
tree | a857951a3693837f6ff34f662886048914e5cb2a | |
parent | 6bd1d22475a10e84f2bcc1eaa25bd7fb259e761b (diff) | |
download | qtwayland-7fcd4a2b24dbc0834b96baaeb432abc032ba4020.tar.gz |
Compositor: Add documentation for XdgShellV6
Change-Id: Ic6976f8368be7bbd61652fc1b62b6439d3509b81
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Reviewed-by: Martin Smith <martin.smith@qt.io>
-rw-r--r-- | src/compositor/extensions/qwaylandxdgshellv6.cpp | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/src/compositor/extensions/qwaylandxdgshellv6.cpp b/src/compositor/extensions/qwaylandxdgshellv6.cpp index 09da7b32..f45dbbff 100644 --- a/src/compositor/extensions/qwaylandxdgshellv6.cpp +++ b/src/compositor/extensions/qwaylandxdgshellv6.cpp @@ -1078,6 +1078,83 @@ QWaylandSurfaceRole *QWaylandXdgToplevelV6::role() return &QWaylandXdgToplevelV6Private::s_role; } + +/*! + * \qmlsignal QtWaylandCompositor::XdgShellV6::xdgSurfaceCreated(XdgSurfaceV6 xdgSurface) + * + * This signal is emitted when the client has created a \c zxdg_surface_v6. + * Note that \a xdgSurface is not mapped, i.e. according to the \c xdg-shell + * protocol it should not be displayed, until it has received a role object. + * + * \sa toplevelCreated(), popupCreated() + */ + +/*! + * \fn void QWaylandXdgShellV6::xdgSurfaceCreated(QWaylandXdgSurfaceV6 *xdgSurface) + * + * This signal is emitted when the client has created a \c zxdg_surface_v6. + * Note that \a xdgSurface is not mapped, i.e. according to the \c xdg-shell + * protocol it should not be displayed, until it has received a role object. + * + * \sa toplevelCreated(), popupCreated() + */ + +/*! + * \qmlsignal QtWaylandCompositor::XdgShellV6::toplevelCreated(XdgToplevelV6 toplevel, XdgSurfaceV6 xdgSurface) + * + * This signal is emitted when the client has created a \c zxdg_toplevel_v6. + * A common use case is to let the handler of this signal instantiate a ShellSurfaceItem or + * WaylandQuickItem for displaying \a toplevel in a QtQuick scene. + * + * \a xdgSurface is the XdgSurfaceV6 \a toplevel is the role object for. + */ + +/*! + * \fn void QWaylandXdgShellV6::toplevelCreated(QWaylandXdgToplevelV6 *toplevel, QWaylandXdgSurfaceV6 *xdgSurface) + * + * This signal is emitted when the client has created a \c zxdg_toplevel_v6. + * A common use case is to let the handler of this signal instantiate a QWaylandShellSurfaceItem or + * QWaylandQuickItem for displaying \a toplevel in a QtQuick scene. + * + * \a xdgSurface is the XdgSurfaceV6 \a toplevel is the role object for. + */ + +/*! + * \qmlsignal QtWaylandCompositor::XdgShellV6::popupCreated(XdgPopupV6 popup, XdgSurfaceV6 xdgSurface) + * + * This signal is emitted when the client has created a \c zxdg_popup_v6. + * A common use case is to let the handler of this signal instantiate a ShellSurfaceItem or + * WaylandQuickItem for displaying \a popup in a QtQuick scene. + * + * \a xdgSurface is the XdgSurfaceV6 \a popup is the role object for. + */ + +/*! + * \fn void QWaylandXdgShellV6::popupCreated(QWaylandXdgPopupV6 *popup, QWaylandXdgSurfaceV6 *xdgSurface) + * + * This signal is emitted when the client has created a \c zxdg_popup_v6. + * A common use case is to let the handler of this signal instantiate a QWaylandShellSurfaceItem or + * QWaylandQuickItem for displaying \a popup in a QtQuick scene. + * + * \a xdgSurface is the XdgSurfaceV6 \a popup is the role object for. + */ + +/*! + * \qmlsignal QtWaylandCompositor::XdgShellV6::pong(int serial) + * + * This signal is emitted when the client has responded to a ping event with serial, \a serial. + * + * \sa ping() + */ + +/*! + * \fn void QWaylandXdgShellV6::pong(uint serial) + * + * This signal is emitted when the client has responded to a ping event with serial, \a serial. + * + * \sa QWaylandXdgShellV6::ping() + */ + QList<int> QWaylandXdgToplevelV6::statesAsInts() const { QList<int> list; |