frameworks/qqc2-desktop-style/Mainpage.dox

0001 /*
0002     This file is part of QQC2-Desktop-Style
0003     SPDX-FileCopyrightText: 2017 Marco Martin <mart@kde.org>
0004
0005     SPDX-License-Identifier: LGPL-2.0-or-later
0006 */
0007
0008
0009 /** \mainpage QQC2-Desktop-Style
0010
0011
0012 \section overview Introduction
0013
0014 QQC2-Desktop-Style is a style for Qt Quick Controls 2 (QQC2) which uses [`QStyle`](https://doc.qt.io/qt-5/qstyle.html) to paint the controls in order to give them native look and feel.
0015
0016 This framework has no public API, applications should not (and can not) use it directly. Instead, developers should add this framework as a dependency of their desktop apps.
0017
0018 Style name is `"org.kde.desktop"`. It can be enabled like [any other QQC2 style](https://doc.qt.io/qt-5/qtquickcontrols2-styles.html#using-styles-in-qt-quick-controls), e.g.:
0019  - via environment variable `QT_QUICK_CONTROLS_STYLE=org.kde.desktop`
0020  - from the C++ code:
0021
0022     @code{cpp}
0023     #include <QQuickStyle>
0024
0025     int main(int argc, char *argv[])
0026     {
0027         QGuiApplication app(argc, argv);
0028
0029         QQuickStyle::setStyle("org.kde.desktop");
0030
0031         QQmlApplicationEngine engine;
0032         // ...
0033     }
0034     @endcode
0035
0036 @authors
0037 Marco Martin \<notmart@gmail.com\><br>
0038
0039 @maintainers
0040 Marco Martin \<notmart@gmail.com\>
0041
0042 @licenses
0043 @lgpl
0044
0045 */
0046
0047
0048 // DOXYGEN_SET_RECURSIVE = YES
0049 // DOXYGEN_SET_EXCLUDE_PATTERNS += *_p.h */private/* */examples/*
0050 // DOXYGEN_SET_PROJECT_NAME = Kirigami
0051 // vim:ts=4:sw=4:expandtab:filetype=doxygen