From 9dcea027f16c4ce5852da3dfc8aca284c582bd7d Mon Sep 17 00:00:00 2001
From: sola.lu <sola.lu.greentest.com.cn>
Date: 周五, 06 6月 2025 18:19:18 +0800
Subject: [PATCH] 1.注释掉custom margin，解决程序放大后，遮盖窗口底部内容的问题。

---
 README.md |  158 ++++++++++++++++++++++++++++++++++------------------
 1 files changed, 102 insertions(+), 56 deletions(-)

diff --git a/README.md b/README.md
index 87609c0..2f100c5 100644
--- a/README.md
+++ b/README.md
@@ -2,27 +2,29 @@
 
 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 the major implementations from [wangwenx190 FramelessHelper](https://github.com/wangwenx190/framelesshelper), with a complete refactoring and upgrading of the architecture.
 
 Feature requests are welcome.
 
-## Join with Us :triangular_flag_on_post:
+## Stay In Touch :triangular_flag_on_post:
 
-You can join our [Discord channel](https://discord.gg/grrM4Tmesy). You can share your findings, thoughts and ideas on improving / implementing FramelessHelper functionalities on more platforms and apps!
+You can share your findings, thoughts and ideas on improving / implementing QWindowKit functionalities on more platforms and apps!
+
+- Chat with us on [Discord](https://discord.gg/grrM4Tmesy)
+- 涓枃鐢ㄦ埛鍙姞鍏� QQ 缇� 876419693
 
 ## Supported Platforms
 
-+ Microsoft Windows
-+ Apple macOS (11+)
-+ GNU/Linux
+- Microsoft Windows
+- Apple macOS (11+)
+- GNU/Linux
 
 ## Features
 
-+ Full support of Windows 11 Snap Layout
-+ Better workaround to handle Windows 10 top border issue
-+ Support Mac system buttons geometry customization
-+ Simpler APIs, more detailed documentations and comments
+- Full support of Windows 11 Snap Layout
+- Better workaround to handle Windows 10 top border issue
+- Support Mac system buttons geometry customization
+- Simpler APIs, more detailed documentations and comments
 
 ## Gallery
 
@@ -48,67 +50,57 @@
 | Compiler  |  \>=C++17   |   MSVC 2019, GCC, Clang   |
 |   CMake   |   \>=3.19   |   >=3.20 is recommended   |
 
+Please read [Vulnerabilities](#Vulnerabilities) carefully to acquire detailed requirements.
+
 ### Tested Compilers
 
-+ Windows
-    + MSVC: 2019, 2022
-    + MinGW (GCC): 13.2.0
-+ macOS
-    + Clang 14.0.3
-+ Ubuntu
-    + GCC: 9.4.0
+- Windows
+    - MSVC: 2019, 2022
+    - MinGW (GCC): 13.2.0
+- macOS
+    - Clang 14.0.3
+- Ubuntu
+    - GCC: 9.4.0
 
 ## Dependencies
 
-+ Qt 5.12 or higher
-+ [qmsetup](https://github.com/stdware/qmsetup)
+- Qt 5.12 or higher
+- [qmsetup](https://github.com/stdware/qmsetup)
 
 ## Integrate
-
-### Configure Options
-
-+ `QWINDOWKIT_BUILD_DOCUMENTATIONS`
-    + If you have installed `Doxygen`, you can **enable** this option so that the documentations will also be built and installed.
-    + If not, you can read the comments in *qdoc* style in `cpp` files to get detailed usages of the public APIs.
-
-+ `QWINDOWKIT_ENABLE_WINDOWS_SYSTEM_BORDERS`
-    + If you don't want the system borders on Windows 10/11, you can **disable** this option.
-    + If so, the Windows 10 top border issue will disappear. However, part of the client edge area will be occupied as the resizing margins.
-
-+ `QWINDOWKIT_ENABLE_QT_WINDOW_CONTEXT`
-    + If you want to use pure Qt emulated frameless implementation, you can **enable** this option.
-    + If so, all system native features will be lost.
-
-+ `QWINDOWKIT_ENABLE_STYLE_AGENT`
-    + Select whether to exclude the style component by **disabling** this option according to your requirements and your Qt version.
 
 ### Build & Install
 
 ```sh
-cmake -B build \
-  -Dqmsetup_DIR=<dir> \ # Optional
+git clone --recursive https://github.com/stdware/qwindowkit
+cd qwindowkit
+
+cmake -B build -S . \
+  -DCMAKE_PREFIX_PATH=<QT_DIR> \
+  -Dqmsetup_DIR=<dir> \             # Optional
+  -DQWINDOWKIT_BUILD_QUICK=TRUE \   # Optional
   -DCMAKE_INSTALL_PREFIX=/path/install \
   -G "Ninja Multi-Config"
 
 cmake --build build --target install --config Debug
 cmake --build build --target install --config Release
 ```
+Read the root `CMakeLists.txt` for more build options.
 
 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
 
 #### CMake Project
 
 ```sh
-cmake -B build -DQWindowKit_DIR=/path/install/cmake/QWindowKit
+cmake -B build -DQWindowKit_DIR=/path/install/lib/cmake/QWindowKit
 ```
 
 ```cmake
-find_package(QWindowKit REQUIRED)
+find_package(QWindowKit COMPONENTS Core Widgets Quick REQUIRED)
 target_link_libraries(widgets_app PUBLIC QWindowKit::Widgets)
 target_link_libraries(quick_app PUBLIC QWindowKit::Quick)
 ```
@@ -125,11 +117,26 @@
 
 #### Visual Studio Project
 
-TODO
+See [Visual Studio Guide](./docs/visual-studio-guide.md) for detailed usages.
 
 ## Quick Start
 
 ### Qt Widgets Application
+
+#### Initialization
+
+The following initialization should be done before any widget constructs.
+
+```cpp
+#include <QtWidgets/QApplication>
+
+int main(int argc, char *argv[])
+{
+    QGuiApplication::setAttribute(Qt::AA_DontCreateNativeWidgetSiblings)
+    
+    // ...
+}
+```
 
 #### Setup Window Agent
 
@@ -154,6 +161,8 @@
 auto agent = new QWK::WidgetWindowAgent(w);
 agent->setup(w);
 ```
+
+You should call `QWK::WidgetWindowAgent::setup()` as early as possible, especially when you need to set the size constrains. QWindowKit will change some Qt internal data which will affect how Qt calculates the window size, and thus you need to let QWindowKit initialize at the very beginning.
 
 #### Construct Title bar
 
@@ -183,13 +192,15 @@
 
 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.
+Last but not least, set hit-test visible hint to let `WidgetWindowAgent` know which widgets are willing 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.
+The rest region within the title bar will be regarded as the draggable area for the user to move the window, and thus any QWidgets inside it will not receive any user interaction events such as mouse events/focus events/etc anymore, but you can still send/post such events to these widgets manually, either through Qt API or system API.
+
+- If you want to disable window maximization, you can remove the `Qt::WindowMaximizeButtonHint` flag from the window.
 
 <!-- #### Window Attributes (Experimental)
 
@@ -222,7 +233,7 @@
 
 #### Setup Window Components
 
-Then you can use `QWindowKit` data types and classes by importing it's URI:
+Then you can use `QWindowKit` data types and classes by importing its URI:
 
 ```qml
 import QtQuick 2.15
@@ -237,31 +248,66 @@
         window.visible = true
     }
     WindowAgent {
-      // ...
+        id: windowAgent
+        // ...
     }
 }
 ```
 
 You can omit the version number or use "auto" instead of "1.0" for the module URI if you are using Qt6.
 
+As we just mentioned above, if you are going to set the size constrains, please do it after `windowAgent.setup()` is called.
+
 ### Learn More
 
 See [examples](examples) for more demo use cases. The examples have no High DPI support.
 
-+ QWindowKit Internals [TODO]
-+ [FramelessHelper Related](docs/framelesshelper-related.md)
+- QWindowKit Internals [TODO]
+- [FramelessHelper Related](docs/framelesshelper-related.md)
+
+
+### Vulnerabilities
+
+#### Qt Version
+- To achieve better frameless functionality, QWindowKit depends heavily on Qt's internal implementation. However, there are many differences in different versions of Qt, and earlier versions of Qt5 and Qt6 have many bugs which make it extremely difficult for QWindowKit to workaround without changing the Qt source code.
+- And also due to limited manpower, although QWindowKit can be successfully compiled on Qt 5.12 or later, it can hardly work perfectly on all Qt versions.
+- Therefore, the following Qt version ranges are recommended, if there are any exceptions with QWindowKit in your application, make sure the Qt version you use is in the ranges before raising the issue.
+    - Qt 5: 5.15.2 or higher
+    - Qt 6: 6.6.2 or higher (the newer, the better)
+
+#### Hot Switch
+- Once you have made the window frameless, it will not be able to switch back to the system frame again unless you destroy your window and recreate it with different settings.
+
+#### Native Child Widget
+- If you are about to add a widget with `Qt::WA_NativeWindow` property enabled as a descendent of the frameless window, you should enable `Qt::WA_DontCreateNativeAncestors` of it in advance.
+
+#### Size Constrains
+- If you want to disable window resizing, you can set a fixed size, which is officially supported by QWindowKit. If you use other special means to achieve this, QWK doesn't guarantee everything can still be fully functional.
+- If you set a maximized width or height, the window should not be maximized because you cannot get the correct window size through Qt APIs. You may workaround this by using system APIs such as `GetWindowRect` or `GetClientRect`. The root cause lies deep in Qt QPA implementations and currently we don't know how to fix it without modifying Qt itself.
+
+#### Windows 10
+- Due to the inherent defects in the Windows 10 window system, the top border will disappear when the system title bar is removed. We have filtered Qt's event and perfectly reshown the system top border, thanks to the implementation of Windows Terminal for our reference. However, this workaround only works with QtWidgets and QtQuick (**only when rendering through D3D**) applications.
+- In QtQuick applications that use OpenGL or other rendering backends, we use Qt's painting system to emulate this border. But since Windows 10 system border is translucent, the difference from the system border is more noticeable in a dark background.
 
 ## TODO
 
-+ Fix 5.15 window abnormal behavior
-+ More documentations
-+ When do we support Linux native features?
+- Fix mouse cursor mapping issues
+- More documentations
+- When do we support Linux native features?
 
 ## Special Thanks
 
-+ [Maplespe](https://github.com/Maplespe)
-+ [zhiyiYo](https://github.com/zhiyiYo)
+- [Maplespe](https://github.com/Maplespe)
+- [zhiyiYo](https://github.com/zhiyiYo)
 
 ## License
 
-QWindowKit is licensed under the Apache 2.0 License.
\ No newline at end of file
+QWindowKit is licensed under the [Apache 2.0 License](./LICENSE).
+
+<!--
+
+**You MUST keep a copyright notice of QWindowKit in a prominent place on your project, such as the README document and the About Dialog.**
+
+**You MUST NOT remove the license text from the header files and source files of QWindowKit.**
+
+-->

--
Gitblit v1.9.1