sola/qwindowkit.git

			@@ -5,7 +5,11 @@
			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.

			## Join with Us :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!

			## Supported Platforms

			@@ -13,12 +17,21 @@
			+ 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
			@@ -33,7 +46,7 @@
			\|:---------:\|:-----------:\|:-------------------------:\|
			\| 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 \|

			### Tested Compilers

			@@ -52,10 +65,30 @@

			## 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 \
			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"
			@@ -101,6 +134,8 @@

			### Qt Widgets Application

			#### Setup Window Agent

			First, setup `WidgetWindowAgent` for your top `QWidget` instance. (Each window needs its own agent.)

			```c++
			@@ -114,7 +149,8 @@
			}
			```

			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();
			@@ -122,9 +158,13 @@
			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.
			#### Construct Title bar

			You can use the [`WindowBar`](examples/shared/widgetframe/windowbar.h) provided by `WidgetFrame` in the examples as the container of your title bar components.
			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.

			@@ -132,7 +172,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());
			@@ -140,6 +181,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.
			@@ -152,9 +194,19 @@

			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.
			<!-- #### Window Attributes (Experimental)

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

			```c++
			agent->setWindowAttribute("mica", true);
			```

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

			### Qt Quick Application

			#### Initialization

			Make sure you have registered `QWindowKit` into QtQuick:

			@@ -171,6 +223,8 @@
			}
			```

			#### Setup Window Components

			Then you can use `QWindowKit` data types and classes by importing it's URI:

			```qml
			@@ -186,7 +240,8 @@
			window.visible = true
			}
			WindowAgent {
			// ...
			id: windowAgent
			// ...
			}
			}
			```
			@@ -197,20 +252,28 @@

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

			## Documentations

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

			## TODO

			+ 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
			+ Implement Mac window context hook
			+ Support window attribute switching on Windows
			+ More documentations
			+ When do we support Linux native features?

			## Special Thanks

			+ [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.

			-->