Update Screen documentation
authorAlan Alpert <alan.alpert@nokia.com>
Tue, 1 May 2012 04:08:24 +0000 (14:08 +1000)
committerQt by Nokia <qt-info@nokia.com>
Thu, 3 May 2012 06:05:33 +0000 (08:05 +0200)
Task-Number: QTBUG-25031

Change-Id: Ie27b42417d63d50769eedcf1f760405861f439e5
Reviewed-by: Samuel Rødal <samuel.rodal@nokia.com>
src/quick/items/qquickscreen.cpp

index 280a06c..2c8bf01 100644 (file)
@@ -54,14 +54,17 @@ QT_BEGIN_NAMESPACE
     \inqmlmodule QtQuick.Window 2
     \brief The Screen attached object provides information about the Screen an Item is displayed on.
 
-    The Screen attached object is only valid inside Item or Item derived elements. Inside these elements
-    it refers to the screen that the element is currently being displayed on.
+    The Screen attached object is only valid inside Item or Item derived elements, after component completion.
+    Inside these elements it refers to the screen that the element is currently being displayed on.
 
     To use this element, you will need to import the module with the following line:
     \code
     import QtQuick.Window 2.0
     \endcode
 
+    Note that the Screen element is not valid at Component.onCompleted, because the Item has not been displayed on
+    a screen by this time.
+
     Restricting this import will allow you to have a QML environment without access to window system features.
 */