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 |   62 ++++++++++++++++---------------
 1 files changed, 32 insertions(+), 30 deletions(-)

diff --git a/README.md b/README.md
index e3a1290..16096c5 100644
--- a/README.md
+++ b/README.md
@@ -5,32 +5,27 @@
 This project inherited most of [wangwenx190 FramelessHelper](https://github.com/wangwenx190/framelesshelper)
 implementation, with a complete refactoring and upgrading of the architecture.
 
-## Gallery
-
-### Basic
-
-|            Windows 10             |              MacOS              |               Linux               |
-|:---------------------------------:|:-------------------------------:|:---------------------------------:|
-| ![image](./docs/images/win10.png) | ![image](./docs/images/mac.png) | ![image](./docs/images/linux.png) |
-
-### Windows 11 Snap Layout
-
-![image](./docs/images/win11.png)
-
-## 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
 
 + Microsoft Windows
 + Apple macOS (11+)
 + GNU/Linux
+
+## Gallery
+
+### Windows 11 (With Snap Layout)
+![image](./docs/images/win11.png)
+
+### Windows 10 (And 7, Vista)
+![image](./docs/images/win10.png)
+
+### macOS & Linux
+
+|              macOS              |       Linux (Ubuntu 20.04)        |
+|:-------------------------------:|:---------------------------------:|
+| ![image](./docs/images/mac.png) | ![image](./docs/images/linux.png) |
 
 ## Requirements
 
@@ -127,11 +122,9 @@
 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.
+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.
+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.
 
@@ -139,11 +132,13 @@
 agent->setTitleBarWidget(myTitleBar);
 ```
 
-Set system button hints to let `WidgetWindowAgent` know the role of the child 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.
@@ -161,9 +156,7 @@
 Make sure you have registered QWK into QtQuick:
 
 ```cpp
-// ...
 #include <QWKQuick/qwkquickglobal.h>
-// ...
 
 int main(int argc, char *argv[])
 {
@@ -175,7 +168,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
@@ -206,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