From f874811443991759df4231b5127788af059a0df9 Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 周二, 19 12月 2023 15:55:52 +0800
Subject: [PATCH] Add raise hook

---
 README.md |   35 +++++++++++++++++++++--------------
 1 files changed, 21 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 3e3a7aa..88076e0 100644
--- a/README.md
+++ b/README.md
@@ -6,12 +6,12 @@
 
 ## TODO
 
-+ Fix 5.15 window unsupported behavior
++ 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
-+ Make Linux system move/resize more robust
-+ Fix unhandled WinIdChange when adding a QWebEngineView as sub-widget (Win32 and Qt fixed)
++ Implement Mac window context hook
++ Support window attribute switching on Windows
 
 ## Supported Platforms
 
@@ -90,30 +90,37 @@
 
 ### Qt Widgets Application
 
-First, setup `WidgetWindowAgent` for your QWidget instance. (Each widget needs its own agent.)
+First, setup `WidgetWindowAgent` for your top `QWidget` instance. (Each window needs its own agent.)
 ```c++
-auto w = new MyWidget();
-auto agent = new WidgetWindowAgent(w);
-agent->setup(w);
-```
+#include <QWKWidgets/widgetwindowagent.h>
 
-You can also initialize the agent in the widget constructor.
-```c++
 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);
 ```
@@ -122,7 +129,7 @@
 ```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.
 

--
Gitblit v1.9.1