Cross-platform window customization framework for Qt Widgets and Qt Quick. Support Windows, macOS, Linux.
This project inherited most of wangwenx190 FramelessHelper implementation, with a complete refactoring and upgrading of the architecture.
isFixedSize code| Component | Requirement | Detailed |
|---|---|---|
| Qt | >=5.15 | Core, Gui, Widgets, Quick |
| Compiler | >=C++17 | MSVC 2019, GCC, Clang |
| CMake | >=3.17 | >=3.20 is recommended |
cmake -B build \
-Dqmsetup_DIR=<dir> \ # Optional
-DCMAKE_INSTALL_PREFIX=/path/install \
-G "Ninja Multi-Config"
cmake --build build --target install --config Debug
cmake --build build --target install --config Release
You can also include this directory as a sub-project if you choose CMake as your build system.
For other build systems, you need to install with CMake first and include the corresponding configuration files in your project.
cmake -B build -DQWindowKit_DIR=/path/install/cmake/QWindowKit
find_package(QWindowKit REQUIRED)
taraget_link_libraries(widgets_app PUBLIC QWindowKit::Widgets)
taraget_link_libraries(quick_app PUBLIC QWindowKit::Quick)
# WidgetsApp.pro
include("/path/install/share/QWindowKit/qmake/QWKWidgets.pri")
# QuickApp.pro
include("/path/install/share/QWindowKit/qmake/QWKQuick.pri")
TODO
First, setup WidgetWindowAgent for your QWidget instance. (Each widget needs its own agent.)
auto w = new MyWidget();
auto agent = new WidgetWindowAgent(w);
agent->setup(w);
You can also initialize the agent in the widget constructor.
MyWidget::MyWidget(QWidget *parent) {
// ...
auto agent = new WidgetWindowAgent(w);
agent->setup(w);
}
Then, construct your titlebar widget, without which the window is lacking in basic interaction feature. You can use the WindowBar provided by WidgetFrame in the examples as the container for your titlebar components.
auto titleLabel = new QLabel();
auto menuBar = new QMenuBar();
auto windowBar = new QWK::WindowBar();
windowBar->setMenuBar(menuBar);
windowBar->setTitleLabel(titleLabel);
windowBar->setHostWidget(this);
auto iconButton = new QPushButton("😄");
auto minButton = new QPushButton("─");
auto maxButton = new QPushButton("▢");
auto closeButton = new QPushButton("✕");
agent->setSystemButton(QWK::WindowAgentBase::WindowIcon, iconButton);
agent->setSystemButton(QWK::WindowAgentBase::Minimize, minButton);
agent->setSystemButton(QWK::WindowAgentBase::Maximize, maxButton);
agent->setSystemButton(QWK::WindowAgentBase::Close, closeButton);
TODO
See examples for more demo use cases. The examples has no High DPI support.
QWindowKit is licensed under the Apache 2.0 License.