summaryrefslogtreecommitdiffstats
path: root/src/compositor/extensions/qwaylandxdgshell.cpp
diff options
context:
space:
mode:
authorJohan Klokkhammer Helsing <johan.helsing@theqtcompany.com>2016-03-29 16:21:01 +0200
committerJohan Helsing <johan.helsing@qt.io>2016-05-15 13:43:31 +0000
commitbc9c876939efbac4a62f9244cf2a7a15da15fb91 (patch)
tree7ead88667538b824a2d919ec24f1210d1e90bc08 /src/compositor/extensions/qwaylandxdgshell.cpp
parented7505ecbd0ad211c9157fb4dd8d172ae2c72454 (diff)
Add documentation for QWaylandXdgSurface::windowGeometry
Change-Id: I131b41a4711b2b1094871eeb44adf99906190953 Reviewed-by: Giulio Camuffo <giulio.camuffo@kdab.com>
Diffstat (limited to 'src/compositor/extensions/qwaylandxdgshell.cpp')
-rw-r--r--src/compositor/extensions/qwaylandxdgshell.cpp8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/compositor/extensions/qwaylandxdgshell.cpp b/src/compositor/extensions/qwaylandxdgshell.cpp
index c4371339b..3ca39a18b 100644
--- a/src/compositor/extensions/qwaylandxdgshell.cpp
+++ b/src/compositor/extensions/qwaylandxdgshell.cpp
@@ -722,9 +722,13 @@ QString QWaylandXdgSurface::appId() const
}
/*!
- * \property QWaylandXdgSurface::appId
+ * \property QWaylandXdgSurface::windowGeometry
*
- * This property holds the window geometry of the QWaylandXdgSurface.
+ * This property holds the window geometry of the QWaylandXdgSurface. The window
+ * geometry describes the window's visible bounds from the user's perspective.
+ * The geometry includes title bars and borders if drawn by the client, but
+ * excludes drop shadows. It is meant to be used for aligning and tiling
+ * windows.
*/
QRect QWaylandXdgSurface::windowGeometry() const
{