aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src/qtquickcontrols2-highdpi.qdoc
blob: f0440e4fc61f06b227262ddb58621f27e98bb2d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page qtquickcontrols2-highdpi.html
    \keyword High-DPI Support in Qt Quick Controlsi 2
    \title High-DPI Support in Qt Quick Controls

    Qt Quick 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;
        engine.load(QUrl(QStringLiteral("qrc:/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 Quick Controls.

    \section1 Related Information
    \list
    \li \l {High DPI Displays}
    \li \l {Scalability}
    \endlist
*/