From d3ff8ee3ea81f313cf13a8cfa7359cdaa061d709 Mon Sep 17 00:00:00 2001
From: J-P Nurmi <jpnurmi@theqtcompany.com>
Date: Sun, 20 Dec 2015 12:02:41 +0100
Subject: Docs: high-DPI support

Change-Id: Id4308c610669bfff92d09f88eb90cdc240238cd9
Task-number: QTBUG-50002
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
---
 .../controls/doc/src/qtlabscontrols-highdpi.qdoc   | 61 ++++++++++++++++++++++
 .../controls/doc/src/qtlabscontrols-index.qdoc     |  4 +-
 2 files changed, 64 insertions(+), 1 deletion(-)
 create mode 100644 src/imports/controls/doc/src/qtlabscontrols-highdpi.qdoc

(limited to 'src')

diff --git a/src/imports/controls/doc/src/qtlabscontrols-highdpi.qdoc b/src/imports/controls/doc/src/qtlabscontrols-highdpi.qdoc
new file mode 100644
index 00000000..557ef254
--- /dev/null
+++ b/src/imports/controls/doc/src/qtlabscontrols-highdpi.qdoc
@@ -0,0 +1,61 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page qtlabscontrols-highdpi.html
+    \title High-DPI Support in Qt Labs Controls
+
+    Qt Labs Controls support Qt's cross-platform high-DPI scaling introduced in Qt 5.6.
+    The feature is opt-in, and can be enabled by setting the \c Qt::AA_EnableHighDpiScaling
+    application attribute in C++ before QGuiApplication is constructed:
+
+    \code
+    #include <QGuiApplication>
+    #include <QQmlApplicationEngine>
+
+    int main(int argc, char *argv[])
+    {
+        QGuiApplication::setAttribute(Qt::AA_EnableHighDpiScaling); // <--
+        QGuiApplication app(argc, argv);
+        QQmlApplicationEngine engine("main.qml");
+        return app.exec();
+    }
+    \endcode
+
+    Alternatively, an environment variable \c QT_AUTO_SCREEN_SCALE_FACTOR=1 can be set
+    to enable automatic high-DPI scaling.
+
+    \warning \l {Qt Quick Controls}{Qt Quick Controls 1.x} are not compatible with Qt's
+    automatic high-DPI scaling. There is currently no available solution for high-DPI
+    support in applications wishing to mix Qt Quick Controls and Qt Labs Controls.
+
+    \section1 Related Information
+    \list
+    \li \l {High DPI Displays}
+    \li \l {Scalability}
+    \endlist
+*/
diff --git a/src/imports/controls/doc/src/qtlabscontrols-index.qdoc b/src/imports/controls/doc/src/qtlabscontrols-index.qdoc
index f0a1f4cd..93615499 100644
--- a/src/imports/controls/doc/src/qtlabscontrols-index.qdoc
+++ b/src/imports/controls/doc/src/qtlabscontrols-index.qdoc
@@ -61,11 +61,12 @@
     A basic example of a source file that makes use of controls is shown here:
 
     \code
-    #include <QApplication>
+    #include <QGuiApplication>
     #include <QQmlApplicationEngine>
 
     int main(int argc, char *argv[])
     {
+        QGuiApplication::setAttribute(Qt::AA_EnableHighDpiScaling);
         QGuiApplication app(argc, argv);
         QQmlApplicationEngine engine("main.qml");
         return app.exec();
@@ -86,6 +87,7 @@
 
     \list
       \li \l{Styling Qt Labs Controls}
+      \li \l{High-DPI Support in Qt Labs Controls}
       \li \l{Differences between Qt Quick Controls}
     \endlist
 
-- 
cgit v1.2.3