Prepare to add mica

Sine Striker

2023-12-21 c229915e9d4b2818155f3650869726fdcbe7e21d

 README.md

@@ -7,6 +7,19 @@

Support as many system native features as possible without requiring additional dependencies.

<!-- ## Why using QWindowKit?

Here're 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
+ Simpler APIs, more detailed documentation and comments
+ A lot of bugs are fixed

Feature requests are welcome. -->

## Supported Platforms

+ Microsoft Windows
@@ -31,7 +44,7 @@

| Component | Requirement |          Details          |
|:---------:|:-----------:|:-------------------------:|
|    Qt     |   \>=5.15   | Core, Gui, Widgets, Quick |
|    Qt     |   \>=5.12   | Core, Gui, Widgets, Quick |
| Compiler  |  \>=C++17   |   MSVC 2019, GCC, Clang   |
|   CMake   |   \>=3.17   |   >=3.20 is recommended   |

@@ -47,7 +60,7 @@

## Dependencies

+ Qt 5.15 or higher
+ Qt 5.12 or higher
+ [qmsetup](https://github.com/stdware/qmsetup)

## Integrate
@@ -108,13 +121,13 @@

MyWidget::MyWidget(QWidget *parent) {
    // ...
    auto agent = new QWK::WidgetWindowAgent(w);
    agent->setup(w);
    auto agent = new QWK::WidgetWindowAgent(this);
    agent->setup(this);
    // ...
}
```

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();
@@ -129,10 +142,10 @@
Let `WidgetWindowAgent` know which widget the title bar is.

```c++
agent->setTitleBarWidget(myTitleBar);
agent->setTitleBar(myTitleBar);
```

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

Set hit-test visible hint to let `WidgetWindowAgent` know the widgets that desire to receive mouse events.
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.

```c++
agent->setHitTestVisible(myTitleBar->menuBar(), true);
@@ -153,7 +169,7 @@

### Qt Quick Application

Make sure you have registered QWK into QtQuick:
Make sure you have registered `QWindowKit` into QtQuick:

```cpp
#include <QWKQuick/qwkquickglobal.h>