From 1900ef3c9805d7fe15e0634cef9b5ff2a5dc7838 Mon Sep 17 00:00:00 2001
From: SineStriker <trueful@163.com>
Date: 周三, 20 12月 2023 20:02:05 +0800
Subject: [PATCH] minor tweaks
---
README.md | 114 ++++++++++++++++++++++++++++++++-------------------------
1 files changed, 64 insertions(+), 50 deletions(-)
diff --git a/README.md b/README.md
index 8aca4df..ae739dd 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,11 @@
# QWindowKit
-Cross-platform window customization framework for Qt Widgets and Qt Quick. Support Windows, macOS, Linux.
+Cross-platform window customization framework for Qt Widgets and Qt Quick.
-This project inherited most of [wangwenx190 FramelessHelper](https://github.com/wangwenx190/framelesshelper) implementation, with a complete refactoring and upgrading of the architecture.
+This project inherited most of [wangwenx190 FramelessHelper](https://github.com/wangwenx190/framelesshelper)
+implementation, with a complete refactoring and upgrading of the architecture.
-## Screenshots
-
-### Windows
-
-
-
-### Linux
-
-
-
-### macOS
-
-
-
-## TODO
-
-+ Fix 5.15 window abnormal behavior
-+ Fix window 10 top border color in dark background
-+ Fix `isFixedSize` code
-+ Support customized system button area on Mac
-+ Implement Mac window context hook
-+ Support window attribute switching on Windows
+Support as many system native features as possible without requiring additional dependencies.
## Supported Platforms
@@ -33,27 +13,41 @@
+ Apple macOS (11+)
+ GNU/Linux
+## Gallery
+
+### Windows 11 (With Snap Layout)
+
+
+### Windows 10 (And 7, Vista)
+
+
+### macOS & Linux
+
+| macOS | Linux (Ubuntu 20.04) |
+|:-------------------------------:|:---------------------------------:|
+|  |  |
+
## Requirements
-| Component | Requirement | Details |
-|:---------:|:-----------:|:------------------------------------:|
-| Qt | \>=5.15 | Core, Gui, Widgets, Quick |
-| Compiler | \>=C++17 | MSVC 2019, GCC, Clang |
-| CMake | \>=3.17 | >=3.20 is recommended |
+| Component | Requirement | Details |
+|:---------:|:-----------:|:-------------------------:|
+| Qt | \>=5.12 | Core, Gui, Widgets, Quick |
+| Compiler | \>=C++17 | MSVC 2019, GCC, Clang |
+| CMake | \>=3.17 | >=3.20 is recommended |
### Tested Compilers
+ Windows
- + MSVC: 2019, 2022
- + MinGW (GCC): 13.2.0
+ + MSVC: 2019, 2022
+ + MinGW (GCC): 13.2.0
+ macOS
- + Clang 14.0.3
+ + Clang 14.0.3
+ Ubuntu
- + GCC: 9.4.0
+ + GCC: 9.4.0
## Dependencies
-+ Qt 5.15 or higher
++ Qt 5.12 or higher
+ [qmsetup](https://github.com/stdware/qmsetup)
## Integrate
@@ -72,7 +66,8 @@
You can also include this directory as a subproject 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.
+For other build systems, you need to install with CMake first and include the corresponding configuration files in your
+project.
### Import
@@ -81,6 +76,7 @@
```sh
cmake -B build -DQWindowKit_DIR=/path/install/cmake/QWindowKit
```
+
```cmake
find_package(QWindowKit REQUIRED)
target_link_libraries(widgets_app PUBLIC QWindowKit::Widgets)
@@ -88,6 +84,7 @@
```
#### QMake Project
+
```cmake
# WidgetsApp.pro
include("/path/install/share/QWindowKit/qmake/QWKWidgets.pri")
@@ -105,56 +102,64 @@
### Qt Widgets Application
First, setup `WidgetWindowAgent` for your top `QWidget` instance. (Each window needs its own agent.)
+
```c++
#include <QWKWidgets/widgetwindowagent.h>
MyWidget::MyWidget(QWidget *parent) {
// ...
- auto agent = new QWK::WidgetWindowAgent(w);
- agent->setup(w);
+ auto agent = new QWK::WidgetWindowAgent(this);
+ agent->setup(this);
// ...
}
```
-You can also initialize the agent after the window constructs.
+If you don't want to derive a new widget class or change the constructor, you can initialize the agent after the window constructs.
+
```c++
auto w = new MyWidget();
auto agent = new QWK::WidgetWindowAgent(w);
agent->setup(w);
```
-
-
Then, construct your title bar widget, without which the window lacks the basic interaction feature, and it's better to put it into the window's layout.
You can use the [`WindowBar`](examples/shared/widgetframe/windowbar.h) provided by `WidgetFrame` in the examples as the container of your title bar components.
Let `WidgetWindowAgent` know which widget the title bar is.
+
```c++
-agent->setTitleBarWidget(myTitleBar);
+agent->setTitleBar(myTitleBar);
```
-Set system button hints to let `WidgetWindowAgent` know the role of the child widgets, which is important for the Snap Layout to work.
-```c++
-agent->setSystemButton(QWK::WindowAgent::Base::Maximize, maxButton);
-```
+Next, set system button hints to let `WidgetWindowAgent` know the role of the child widgets, which is important for the Snap Layout to work.
-Set hit-test visible hint to let `WidgetWindowAgent` know the widgets that desire to receive mouse events.
+```c++
+agent->setSystemButton(QWK::WindowAgentBase::WindowIcon, myTitleBar->iconButton());
+agent->setSystemButton(QWK::WindowAgentBase::Minimize, myTitleBar->minButton());
+agent->setSystemButton(QWK::WindowAgentBase::Maximize, myTitleBar->maxButton());
+agent->setSystemButton(QWK::WindowAgentBase::Close, myTitleBar->closeButton());
+```
+Doing this does not mean that these buttons' click events are automatically associated with window actions, you still need to manually connect the signals and slots to emulate the native window behaviors.
+
+On macOS, this step can be skipped because it is better to use the buttons provided by the system.
+
+Last but not least, set hit-test visible hint to let `WidgetWindowAgent` know other widgets that desire to receive mouse events.
+
```c++
agent->setHitTestVisible(myTitleBar->menuBar(), true);
```
+
The rest region within the title bar will be regarded as the draggable area for the user to move the window.
Check [`MainWindow`](examples/mainwindow/mainwindow.cpp#L108) example to get detailed information.
### Qt Quick Application
-Make sure you have registered QWK into QtQuick:
+Make sure you have registered `QWindowKit` into QtQuick:
```cpp
-// ...
#include <QWKQuick/qwkquickglobal.h>
-// ...
int main(int argc, char *argv[])
{
@@ -166,7 +171,7 @@
}
```
-Then you can use QWK data types and classes by importing it's URI:
+Then you can use `QWindowKit` data types and classes by importing it's URI:
```qml
import QtQuick 2.15
@@ -197,6 +202,15 @@
+ Examples (TODO)
+ [FramelessHelper Related](docs/framelesshelper-related.md)
+## TODO
+
++ Fix 5.15 window abnormal behavior
++ Fix window 10 top border color in dark background
++ Fix `isFixedSize` code
++ Support customized system button area on Mac
++ Implement Mac window context hook
++ Support window attribute switching on Windows
+
## License
QWindowKit is licensed under the Apache 2.0 License.
\ No newline at end of file
--
Gitblit v1.9.1