minor tweaks

Sine Striker

2023-12-19 ee61addaaae18623da94fb531b0cf0ffd0e9630c

 README.md

@@ -1,36 +1,31 @@
# QWindowKit

Cross-platform window customization framework for Qt Widgets and Qt Quick. Support Windows, macOS, Linux.
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.

## Gallery

### Basic

|            Windows 10             |              MacOS              |               Linux               |
|:---------------------------------:|:-------------------------------:|:---------------------------------:|
| ![image](./docs/images/win10.png) | ![image](./docs/images/mac.png) | ![image](./docs/images/linux.png) |

### Windows 11 Snap Layout

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

## 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
Support as many system native features as possible without requiring additional dependencies.

## Supported Platforms

+ Microsoft Windows
+ Apple macOS (11+)
+ GNU/Linux

## Gallery

### Windows 11 (With Snap Layout)
![image](./docs/images/win11.png)

### Windows 10 (And 7, Vista)
![image](./docs/images/win10.png)

### macOS & Linux

|              macOS              |       Linux (Ubuntu 20.04)        |
|:-------------------------------:|:---------------------------------:|
| ![image](./docs/images/mac.png) | ![image](./docs/images/linux.png) |

## Requirements

@@ -127,11 +122,9 @@
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.
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.

@@ -139,8 +132,7 @@
agent->setTitleBarWidget(myTitleBar);
```

Set system button hints to let `WidgetWindowAgent` know the role of the child widgets, which is important for the Snap
Layout to work.
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());
@@ -207,6 +199,15 @@
+ Examples (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

## License

QWindowKit is licensed under the Apache 2.0 License.