diff options
author | Johan Klokkhammer Helsing <johan.helsing@qt.io> | 2017-09-26 15:24:14 +0200 |
---|---|---|
committer | Johan Helsing <johan.helsing@qt.io> | 2017-11-23 10:00:13 +0000 |
commit | 806dc04fdb7eec148fefe28670774e9a827688bb (patch) | |
tree | e263ba291a172b504244042da140706ecbe92b40 | |
parent | bbb6fb1d87bba2f77a33683807b1ceb8f11e7380 (diff) | |
download | qtwayland-806dc04fdb7eec148fefe28670774e9a827688bb.tar.gz |
Add documentation for QWaylandQuickItem::surfaceDestroyed
Change-Id: I7fd1e44974857b77fea27e75ef791603e607642e
Reviewed-by: Pier Luigi Fiorini <pierluigi.fiorini@liri.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r-- | src/compositor/compositor_api/qwaylandquickitem.cpp | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp index f31bf39e..998250db 100644 --- a/src/compositor/compositor_api/qwaylandquickitem.cpp +++ b/src/compositor/compositor_api/qwaylandquickitem.cpp @@ -1156,6 +1156,32 @@ void QWaylandQuickItem::updateInputMethod(Qt::InputMethodQueries queries) } #endif +/*! + * \qmlsignal void QtWaylandCompositor::WaylandQuickItem::surfaceDestroyed() + * + * This signal is emitted when the client has destroyed the \c wl_surface associated + * with the WaylandQuickItem. The handler for this signal is expected to either destroy the + * WaylandQuickItem immediately or start a close animation and then destroy the Item. + * + * If an animation is started, bufferLocked should be set to ensure the item keeps its content + * until the animation finishes + * + * \sa bufferLocked + */ + +/*! + * \fn void QWaylandQuickItem::surfaceDestroyed() + * + * This signal is emitted when the client has destroyed the \c wl_surface associated + * with the QWaylandQuickItem. The handler for this signal is expected to either destroy the + * QWaylandQuickItem immediately or start a close animation and then destroy the Item. + * + * If an animation is started, bufferLocked should be set to ensure the item keeps its content + * until the animation finishes + * + * \sa QWaylandQuickkItem::bufferLocked + */ + QSGNode *QWaylandQuickItem::updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData *) { Q_D(QWaylandQuickItem); |