summaryrefslogtreecommitdiffstats
path: root/src/corelib/global/qnamespace.qdoc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2018-05-14 14:03:39 +0200
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2018-05-23 05:54:06 +0000
commit57868b60814f012d5514b32f77a0a28408362741 (patch)
tree79156efc63ab9bc4eafa4cb8e1dbb935a2e1e4b8 /src/corelib/global/qnamespace.qdoc
parentf86fbc45667528ac9a496d1476bd139f26b3b5bc (diff)
Doc: Document the WA_ContentsMarginsRespectsSafeArea widget attribute
Task-number: QTBUG-68153 Change-Id: Ie4fa1a4e06ff5ee506e1d7788c245b7add776bd6 Reviewed-by: Andy Shaw <andy.shaw@qt.io>
Diffstat (limited to 'src/corelib/global/qnamespace.qdoc')
-rw-r--r--src/corelib/global/qnamespace.qdoc9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc
index 11c431d015..0361fd6085 100644
--- a/src/corelib/global/qnamespace.qdoc
+++ b/src/corelib/global/qnamespace.qdoc
@@ -1329,7 +1329,14 @@
\omitvalue WA_WState_WindowOpacitySet
\omitvalue WA_WState_AcceptedTouchBeginEvent
\omitvalue WA_MacNoShadow
- \omitvalue WA_ContentsMarginsRespectsSafeArea
+ \value WA_ContentsMarginsRespectsSafeArea A QWidget respects the safe
+ area margins of a window by incorporating the margins into its contents'
+ margins by default. This means, that a QLayout will use the content area
+ of a widget for its layout, unless the Qt::WA_LayoutOnEntireRect attribute
+ is set. This along with a contents margin of 0 can be used on the actual
+ layout, to allow for example a background image to underlay the status bar and other
+ system areas on an iOS device, while still allowing child widgets of
+ that background to be inset based on the safe area.
*/
/*! \typedef Qt::HANDLE