sola/qwindowkit.git

			@@ -5,34 +5,33 @@
			This project inherited most of [wangwenx190 FramelessHelper](https://github.com/wangwenx190/framelesshelper)
			implementation, with a complete refactoring and upgrading of the architecture.

			Support as many system native features as possible without requiring additional dependencies.
			Feature requests are welcome.

			<!-- ## Why using QWindowKit?
			## Join with Us :triangular_flag_on_post:

			Here are why `QWindowKit` is better than `FramelessHelper`:

			+ Full support of Windows 11 Snap Layout
			+ Most of the redundant codes and architectural flaws are eliminated, and the binary size compiled by MSVC is about 1/9 of `FramelessHelper`
			+ A critical issue that moving window forces the entire window to be repainted on Windows is fixed
			+ Capable to cope with WinId mutation, and `QWebEngineView` is perfectly supported
			+ Better workaround to handle Windows 10 top border issue
			+ Simpler APIs, more detailed documentation and comments
			+ A lot of bugs are fixed

			Feature requests are welcome. -->
			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!

			## 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

			## Gallery

			### Windows 11 (With Snap Layout)

			![image](./docs/images/win11.png)

			### Windows 10 (And 7, Vista)

			![image](./docs/images/win10.png)

			### macOS & Linux
			@@ -47,29 +46,34 @@
			\|:---------:\|:-----------:\|:-------------------------:\|
			\| Qt \| \>=5.12 \| Core, Gui, Widgets, Quick \|
			\| Compiler \| \>=C++17 \| MSVC 2019, GCC, Clang \|
			\| CMake \| \>=3.17 \| >=3.20 is recommended \|
			\| 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

			### Build & Install

			```sh
			cmake -B build \
			git clone --recursive https://github.com/stdware/qwindowkit
			cd qwindowkit

			cmake -B build -S . \
			-Dqmsetup_DIR=<dir> \ # Optional
			-DCMAKE_INSTALL_PREFIX=/path/install \
			-G "Ninja Multi-Config"
			@@ -80,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)
			```
			@@ -115,6 +118,21 @@

			### 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

			First, setup `WidgetWindowAgent` for your top `QWidget` instance. (Each window needs its own agent.)
			@@ -130,7 +148,8 @@
			}
			```

			If you don't want to derive a new widget class or change the constructor, you can 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();
			@@ -140,9 +159,11 @@

			#### Construct Title bar

			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.

			@@ -150,7 +171,8 @@
			agent->setTitleBar(myTitleBar);
			```

			Next, 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());
			@@ -158,6 +180,7 @@
			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.

			On macOS, this step can be skipped because it is better to use the buttons provided by the system.
			@@ -170,8 +193,7 @@

			The rest region within the title bar will be regarded as the draggable area for the user to move the window.


			#### Window Attributes (Experimental)
			<!-- #### Window Attributes (Experimental)

			On Windows 11, you can use this API to enable system effects.

			@@ -179,7 +201,7 @@
			agent->setWindowAttribute("mica", true);
			```

			Available keys: `mica`, `mica-alt`, `acrylic`, `dark-mode`.
			Available keys: `mica`, `mica-alt`, `acrylic`, `dark-mode`. -->

			### Qt Quick Application

			@@ -217,37 +239,57 @@
			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.

			#### Window Attributes (Experimental)

			TODO

			### Learn More

			See [examples](examples) for more demo use cases. The examples have no High DPI support.

			## Documentations
			- QWindowKit Internals [TODO]
			- [FramelessHelper Related](docs/framelesshelper-related.md)

			+ Examples (TODO)
			+ Notes (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 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.

			## TODO

			+ Fix 5.15 window abnormal behavior
			- Fix 5.15 window abnormal behavior
			- More documentations
			- When do we support Linux native features?

			## Special Thanks

			+ [Arabaku](https://github.com/Arabaku)
			+ [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.
			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.

			-->