Qlementine

Modern QStyle for desktop Qt5 applications.

---

Table of Contents

• Requirements
• Features
• Usage
• Author
• License

---

Requirements

• Platform: Windows, MacOS, Linux.
• CMake 3.19+
• Qt 5.15+

Features

This library contains:

• A custom QStyle named QlementineStyle, that implements all the necessary API to give a modern look and feel to your Qt application. It's a drop-in replacement for the default QStyle.
• An actual way to have client-side decoration (CSD) on your Qt window, with actual OS window animations and effects. (Windows only, at the moment)
• Lots of utilities to help you write beautiful Qt widgets.

Usage

1. Add the library's repository as a Git submodule.

   git submodule add git@github.com:oclero/qlementine.git submodules/qlementine

2. Download submodules.

   git submodule update --init --recursive

3. Add the library to your CMake project.

   add_subdirectory(submodules/qlementine)

4. Link with the library in CMake.

   target_link_libraries(your_project oclero::qlementine)

5. Define the QStyle on your QApplication.

   #include <oclero/qlementine.hpp>
   
   QApplication app(argc, argv);
   
   auto* style = new oclero::qlementine::QlementineStyle(&app);
   style->setThemeJsonPath(":/light.json");
   QApplication::setStyle(style);

Author

Olivier Cléro | email | website | github | gitlab

License

Qlementine is available under the MIT license. See the LICENSE file for more info.