Documentation and versioning for new Window properties

Even some of the properties that existed in 5.0 were not documented.

Change-Id: I25a14b9b19425a6c792d06bc41983e9abd1d17d0
Task-number: QTBUG-29807
Reviewed-by: J-P Nurmi <jpnurmi@digia.com>

diff --git a/src/quick/doc/images/screen-and-window-dimensions.jpg b/src/quick/doc/images/screen-and-window-dimensions.jpg
new file mode 100644 (file)
index 0000000..98c8b06
Binary files /dev/null and b/src/quick/doc/images/screen-and-window-dimensions.jpg differ

diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp
index 1732251..53b731b 100644 (file)
--- a/src/quick/items/qquickwindow.cpp
+++ b/src/quick/items/qquickwindow.cpp
@@ -833,11 +833,11 @@ void QQuickWindowPrivate::cleanup(QSGNode *n)
     \brief Creates a new top-level window
 
     The Window object creates a new top-level window for a QtQuick scene. It automatically sets up the
-    window for use with QtQuick 2.0 graphical types.
+    window for use with QtQuick 2.x graphical types.
 
     To use this type, you will need to import the module with the following line:
     \code
-    import QtQuick.Window 2.0
+    import QtQuick.Window 2.1
     \endcode
 
     Restricting this import will allow you to have a QML environment without access to window system features.
@@ -2850,7 +2850,7 @@ QColor QQuickWindow::color() const
  */
 
 /*!
-    \qmlproperty string QtQuick.Window2::Window::modality
+    \qmlproperty Qt::WindowModality QtQuick.Window2::Window::modality
 
     The modality of the window.
 
@@ -2859,6 +2859,127 @@ QColor QQuickWindow::color() const
     and Qt.ApplicationModal.
  */
 
+/*!
+    \qmlproperty Qt::WindowFlags QtQuick.Window2::Window::flags
+
+    The window flags of the window.
+
+    The window flags control the window's appearance in the windowing system,
+    whether it's a dialog, popup, or a regular window, and whether it should
+    have a title bar, etc.
+
+    The flags which you read from this property might differ from the ones
+    that you set if the requested flags could not be fulfilled.
+ */
+
+/*!
+    \qmlproperty int QtQuick.Window2::Window::x
+    \qmlproperty int QtQuick.Window2::Window::y
+    \qmlproperty int QtQuick.Window2::Window::width
+    \qmlproperty int QtQuick.Window2::Window::height
+
+    Defines the window's position and size.
+
+    The (x,y) position is relative to the \l Screen if there is only one,
+    or to the virtual desktop (arrangement of multiple screens).
+
+    \qml
+    Window { x: 100; y: 100; width: 100; height: 100 }
+    \endqml
+
+    \image screen-and-window-dimensions.jpg
+ */
+
+/*!
+    \qmlproperty int QtQuick.Window2::Window::minimumWidth
+    \qmlproperty int QtQuick.Window2::Window::minimumHeight
+    \since Qt 5.1
+
+    Defines the window's minimum size.
+
+    This is a hint to the window manager to prevent resizing below the specified
+    width and height.
+ */
+
+/*!
+    \qmlproperty int QtQuick.Window2::Window::maximumWidth
+    \qmlproperty int QtQuick.Window2::Window::maximumHeight
+    \since Qt 5.1
+
+    Defines the window's maximum size.
+
+    This is a hint to the window manager to prevent resizing above the specified
+    width and height.
+ */
+
+/*!
+    \qmlproperty bool QtQuick.Window2::Window::visible
+
+    Whether the window is visible on the screen.
+
+    Setting visible to false is the same as setting \l visibility to Hidden.
+
+    \sa visibility
+ */
+
+/*!
+    \qmlproperty QWindow::Visibility QtQuick.Window2::Window::visibility
+
+    The screen-occupation state of the window.
+
+    Visibility is whether the window should appear in the windowing system as
+    normal, minimized, maximized, fullscreen or hidden.
+
+    To set the visibility to AutomaticVisibility means to give the window a
+    default visible state, which might be fullscreen or windowed depending on
+    the platform. However when reading the visibility property you will always
+    get the actual state, never AutomaticVisibility.
+
+    When a window is not visible its visibility is Hidden, and setting
+    visibility to Hidden is the same as setting \l visible to false.
+
+    \sa visible
+    \since Qt 5.1
+ */
+
+/*!
+    \qmlproperty Qt::ScreenOrientation QtQuick.Window2::Window::contentOrientation
+
+    This is a hint to the window manager in case it needs to display
+    additional content like popups, dialogs, status bars, or similar
+    in relation to the window.
+
+    The recommended orientation is \l Screen.orientation, but
+    an application doesn't have to support all possible orientations,
+    and thus can opt to ignore the current screen orientation.
+
+    The difference between the window and the content orientation
+    determines how much to rotate the content by.
+
+    The default value is Qt::PrimaryOrientation.
+
+    \sa Screen
+
+    \since Qt 5.1
+ */
+
+/*!
+    \qmlproperty real QtQuick.Window2::Window::opacity
+
+    The opacity of the window.
+
+    If the windowing system supports window opacity, this can be used to fade the
+    window in and out, or to make it semitransparent.
+
+    A value of 1.0 or above is treated as fully opaque, whereas a value of 0.0 or below
+    is treated as fully transparent. Values inbetween represent varying levels of
+    translucency between the two extremes.
+
+    The default value is 1.0.
+
+    \since Qt 5.1
+ */
+
 #include "moc_qquickwindow.cpp"
 
 QT_END_NAMESPACE

diff --git a/src/quick/items/qquickwindowmodule.cpp b/src/quick/items/qquickwindowmodule.cpp
index 8d2d583..f826a53 100644 (file)
--- a/src/quick/items/qquickwindowmodule.cpp
+++ b/src/quick/items/qquickwindowmodule.cpp
@@ -50,6 +50,8 @@ void QQuickWindowModule::defineModule()
     const char uri[] = "QtQuick.Window";
 
     qmlRegisterType<QQuickWindow>(uri, 2, 0, "Window");
+    qmlRegisterRevision<QWindow,1>(uri, 2, 1);
+    qmlRegisterType<QQuickWindow,1>(uri, 2, 1, "Window");
     qmlRegisterUncreatableType<QQuickScreen>(uri, 2, 0, "Screen", QStringLiteral("Screen can only be used via the attached property."));
 }