From 245ddfa1f01b4c9fa10337246b8045755e5bcce5 Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 周二, 19 12月 2023 21:03:58 +0800
Subject: [PATCH] Change back to qScopeGuard
---
README.md | 143 +++++++++++++++++++++++++++++++++++------------
1 files changed, 106 insertions(+), 37 deletions(-)
diff --git a/README.md b/README.md
index 3e3a7aa..16096c5 100644
--- a/README.md
+++ b/README.md
@@ -2,40 +2,48 @@
Cross-platform window customization framework for Qt Widgets and Qt Quick. Support Windows, macOS, Linux.
-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.
-## TODO
-
-+ Fix 5.15 window unsupported behavior
-+ Fix window 10 top border color in dark background
-+ Fix `isFixedSize` code
-+ Support customized system button area on Mac
-+ Make Linux system move/resize more robust
-+ Fix unhandled WinIdChange when adding a QWebEngineView as sub-widget (Win32 and Qt fixed)
+Support as many system native features as possible without requiring additional dependencies.
## Supported Platforms
-+ Microsoft Windows (Vista ~ 11)
-+ Apple Mac OSX (11+)
-+ GNU/Linux (Tested on Ubuntu)
++ Microsoft Windows
++ 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 | Detailed |
-|:---------:|:-----------:|:------------------------------------:|
-| 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.15 | 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: 13.2.0
-+ MacOSX
- + Clang 14.0.3
+ + MSVC: 2019, 2022
+ + MinGW (GCC): 13.2.0
++ macOS
+ + Clang 14.0.3
+ Ubuntu
- + GCC: 9.4.0
+ + GCC: 9.4.0
## Dependencies
@@ -58,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
@@ -67,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)
@@ -74,6 +84,7 @@
```
#### QMake Project
+
```cmake
# WidgetsApp.pro
include("/path/install/share/QWindowKit/qmake/QWKWidgets.pri")
@@ -90,45 +101,94 @@
### Qt Widgets Application
-First, setup `WidgetWindowAgent` for your QWidget instance. (Each widget needs its own agent.)
-```c++
-auto w = new MyWidget();
-auto agent = new WidgetWindowAgent(w);
-agent->setup(w);
-```
+First, setup `WidgetWindowAgent` for your top `QWidget` instance. (Each window needs its own agent.)
-You can also initialize the agent in the widget constructor.
```c++
+#include <QWKWidgets/widgetwindowagent.h>
+
MyWidget::MyWidget(QWidget *parent) {
// ...
- auto agent = new WidgetWindowAgent(w);
+ auto agent = new QWK::WidgetWindowAgent(w);
agent->setup(w);
+ // ...
}
```
-Then, construct your title bar widget, without which the window is lacking in basic interaction feature. You can use the [`WindowBar`](examples/shared/widgetframe/windowbar.h) provided by `WidgetFrame` in the examples as the container for your title bar components.
+You can also 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);
```
-Set system button hints to let `WidgetWindowAgent` know the role of the widgets, which is important for the Snap Layout to work.
+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);
+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());
```
-Set hit-test visible hint to let `WidgetWindowAgent` know the widgets that desire to receive mouse events.
+Set hit-test visible hint to let `WidgetWindowAgent` know the widgets that desire to receive mouse events.
+
```c++
agent->setHitTestVisible(myTitleBar->menuBar(), true);
```
-Other region inside the title bar will be regarded as the draggable area for user to move the window.
+
+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
-TODO
+Make sure you have registered QWK into QtQuick:
+
+```cpp
+#include <QWKQuick/qwkquickglobal.h>
+
+int main(int argc, char *argv[])
+{
+ // ...
+ QQmlApplicationEngine engine;
+ // ...
+ QWK::registerTypes(&engine);
+ // ...
+}
+```
+
+Then you can use `QWindowKit` data types and classes by importing it's URI:
+
+```qml
+import QtQuick 2.15
+import QtQuick.Window 2.15
+import QWindowKit 1.0
+
+Window {
+ id: window
+ visible: false // We hide it first, so we can move the window to our desired position silently.
+ Component.onCompleted: {
+ windowAgent.setup(window)
+ window.visible = true
+ }
+ WindowAgent {
+ // ...
+ }
+}
+```
+
+You can omit the version number or use "auto" instead of "1.0" for the module URI if you are using Qt6.
### Learn More
@@ -139,6 +199,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