sola/qwindowkit.git

			@@ -13,16 +13,16 @@

			## 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,39 +48,24 @@
			\| 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

			@@ -99,19 +84,18 @@

			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)
			```
			@@ -133,6 +117,21 @@
			## 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

			@@ -252,27 +251,42 @@

			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

			+ Once you have made the window frameless, it will not be able to switch back to the system border.
			+ There must not be any child widget with `Qt::WA_NativeWindow` property enabled, otherwise the native features and display may be abnormal. Therefore, do not set any widget that has called `QWidget::winId()` or `QWidget::setAttribute(Qt::WA_NativeWindow)` as a descendant of a frameless window.
			+ If you really need to move widgets between different windows, make sure that the widget is not a top-level window and wrap it with a frameless container.
			+ If you want to show a non-modal dialog as a child of a frameless window, you should call `QGuiApplication::setAttribute(Qt::AA_DontCreateNativeWidgetSiblings)` before the dialog constructs or in the very beginning in the main entry.
			#### Qt Version
			- To achieve better frameless functionality, QWindowKit depends heavily on Qt's internal implementation. However, there are 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

			#### Hot Switch
			- Once you have made the window frameless, it will not be able to switch back to the system border.

			#### Native Child Widget
			- There must not be any internal child widget with `Qt::WA_NativeWindow` property enabled, otherwise the native features and display may be abnormal. Therefore, do not set any widget that has called `QWidget::winId()` or `QWidget::setAttribute(Qt::WA_NativeWindow)` as a descendant of a frameless window.
			- If you really need to move widgets between different windows, make sure that the widget is not a top-level window and wrap it with a frameless container window.

			#### 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 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 5.15 window abnormal behavior
			- 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