plasma/qqc2-breeze-style/README.md

0001 # QQC2 Breeze Style
0002
0003 This is a style for Qt Quick Controls (also known as QQC2 in Qt5) which implements the KDE Visual Design Group's vision for Breeze in pure Qt Quick and Kirigami.
0004
0005 This library has no public API, applications should not (and cannot) use it directly. Instead, developers should add this library as a dependency of their apps.
0006
0007 ## Usage
0008
0009 The name of the style is `org.kde.breeze`.
0010
0011 On Plasma Mobile, this style should be used automatically. Ensure that your application does not override the style by accident by checking if `QT_QUICK_CONTROLS_STYLE` is set:
0012
0013 ```c++
0014 #include <QQuickStyle>
0015
0016 int main(int argc, char *argv[])
0017 {
0018     QApplication app(argc, argv);
0019
0020     // Default to org.kde.desktop style unless the user forces another style
0021     if (qEnvironmentVariableIsEmpty("QT_QUICK_CONTROLS_STYLE")) {
0022         QQuickStyle::setStyle(QStringLiteral("org.kde.desktop"));
0023     }
0024
0025     QQmlApplicationEngine engine;
0026     ...
0027 }
0028 ```
0029
0030 ## Differences from QQC2 Desktop Style
0031
0032 Unlike [QQC2 Desktop Style](https://invent.kde.org/frameworks/qqc2-desktop-style), it does not depend on Qt Widgets and the system QStyle. This means you can use the lighter `QGuiApplication` instead of `QApplication`, and your application does not need to link to QtWidgets.
0033
0034 The performance, loading times and RAM usage should be generally competitive with the Qt Fusion and Material QQC styles.
0035
0036 ## Building
0037
0038 The easiest way to make changes and test QQC2 Breeze Style during development is to [build it with kdesrc-build](https://community.kde.org/Get_Involved/development/Build_software_with_kdesrc-build).
0039
0040 ## Contributing
0041
0042 Like other projects in the KDE ecosystem, contributions are welcome from all. This repository is managed in [KDE Invent](https://invent.kde.org/plasma/qqc2-breeze-style), our GitLab instance.
0043
0044 * Want to contribute code? See the [GitLab wiki page](https://community.kde.org/Infrastructure/GitLab) for a tutorial on how to send a merge request.
0045 * Reporting a bug? Please submit it on the [Issues page]https://invent.kde.org/plasma/qqc2-breeze-style/-/issues).
0046
0047 If you get stuck or need help with anything at all, head over to the [KDE New Contributors room](https://go.kde.org/matrix/#/#kde-welcome:kde.org) on Matrix. For questions about QQC2 Desktop Style, please ask in the [KDE Development room](https://go.kde.org/matrix/#/#kde-devel:kde.org). See [Matrix](https://community.kde.org/Matrix) for more details.
0048