From 995dc0b4d52e66adac84812dedf32785a65bce83 Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 周三, 20 12月 2023 21:36:48 +0800
Subject: [PATCH] Remove hot-switch

---
 README.md |   27 +++++++++++++++------------
 1 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 556e78b..ae739dd 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # 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.
@@ -21,9 +21,9 @@
 ### Windows 10 (And 7, Vista)
 ![image](./docs/images/win10.png)
 
-### MacOS & Linux
+### macOS & Linux
 
-|              MacOS              |       Linux (Ubuntu 20.04)        |
+|              macOS              |       Linux (Ubuntu 20.04)        |
 |:-------------------------------:|:---------------------------------:|
 | ![image](./docs/images/mac.png) | ![image](./docs/images/linux.png) |
 
@@ -31,7 +31,7 @@
 
 | Component | Requirement |          Details          |
 |:---------:|:-----------:|:-------------------------:|
-|    Qt     |   \>=5.15   | Core, Gui, Widgets, Quick |
+|    Qt     |   \>=5.12   | Core, Gui, Widgets, Quick |
 | Compiler  |  \>=C++17   |   MSVC 2019, GCC, Clang   |
 |   CMake   |   \>=3.17   |   >=3.20 is recommended   |
 
@@ -47,7 +47,7 @@
 
 ## Dependencies
 
-+ Qt 5.15 or higher
++ Qt 5.12 or higher
 + [qmsetup](https://github.com/stdware/qmsetup)
 
 ## Integrate
@@ -108,13 +108,13 @@
 
 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();
@@ -129,10 +129,10 @@
 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.
+Next, 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::WindowAgentBase::WindowIcon, myTitleBar->iconButton());
@@ -140,8 +140,11 @@
 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.
 
-Set hit-test visible hint to let `WidgetWindowAgent` know the widgets that desire to receive mouse events.
+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);
@@ -153,7 +156,7 @@
 
 ### Qt Quick Application
 
-Make sure you have registered QWK into QtQuick:
+Make sure you have registered `QWindowKit` into QtQuick:
 
 ```cpp
 #include <QWKQuick/qwkquickglobal.h>

--
Gitblit v1.9.1