Change back to qScopeGuard

Sine Striker

2023-12-19 245ddfa1f01b4c9fa10337246b8045755e5bcce5

 README.md

@@ -2,39 +2,48 @@

Cross-platform window customization framework for Qt Widgets and Qt Quick. Support Windows, macOS, Linux.

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

## 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
+ Make Linux system move/resize more robust
Support as many system native features as possible without requiring additional dependencies.

## Supported Platforms

+ Microsoft Windows (Vista ~ 11)
+ Apple Mac OSX (11+)
+ GNU/Linux (Tested on Ubuntu)
+ 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

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

### Tested Compilers

+ Windows
  + MSVC: 2019, 2022
  + MinGW: 13.2.0
+ MacOSX
  + Clang 14.0.3
    + MSVC: 2019, 2022
    + MinGW (GCC): 13.2.0
+ macOS
    + Clang 14.0.3
+ Ubuntu
  + GCC: 9.4.0
    + GCC: 9.4.0

## Dependencies

@@ -57,7 +66,8 @@

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

@@ -66,6 +76,7 @@
```sh
cmake -B build -DQWindowKit_DIR=/path/install/cmake/QWindowKit
```

```cmake
find_package(QWindowKit REQUIRED)
target_link_libraries(widgets_app PUBLIC QWindowKit::Widgets)
@@ -73,6 +84,7 @@
```

#### QMake Project

```cmake
# WidgetsApp.pro
include("/path/install/share/QWindowKit/qmake/QWKWidgets.pri")
@@ -90,21 +102,23 @@
### Qt Widgets Application

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

```c++
#include <QWKWidgets/widgetwindowagent.h>

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

You can also initialize the agent after the window constructs.

```c++
auto w = new MyWidget();
auto agent = new WidgetWindowAgent(w);
auto agent = new QWK::WidgetWindowAgent(w);
agent->setup(w);
```

@@ -113,26 +127,68 @@
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.

```c++
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.

```c++
agent->setSystemButton(QWK::WindowAgent::Base::Maximize, maxButton);
agent->setSystemButton(QWK::WindowAgentBase::WindowIcon, myTitleBar->iconButton());
agent->setSystemButton(QWK::WindowAgentBase::Minimize, myTitleBar->minButton());
agent->setSystemButton(QWK::WindowAgentBase::Maximize, myTitleBar->maxButton());
agent->setSystemButton(QWK::WindowAgentBase::Close, myTitleBar->closeButton());
```

Set hit-test visible hint to let `WidgetWindowAgent` know the widgets that desire to receive mouse events. 
Set hit-test visible hint to let `WidgetWindowAgent` know the widgets that desire to receive mouse events.

```c++
agent->setHitTestVisible(myTitleBar->menuBar(), true);
```

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.

### Qt Quick Application

TODO
Make sure you have registered QWK into QtQuick:

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

int main(int argc, char *argv[])
{
    // ...
    QQmlApplicationEngine engine;
    // ...
    QWK::registerTypes(&engine);
    // ...
}
```

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

```qml
import QtQuick 2.15
import QtQuick.Window 2.15
import QWindowKit 1.0

Window {
    id: window
    visible: false // We hide it first, so we can move the window to our desired position silently.
    Component.onCompleted: {
        windowAgent.setup(window)
        window.visible = true
    }
    WindowAgent {
      // ...
    }
}
```

You can omit the version number or use "auto" instead of "1.0" for the module URI if you are using Qt6.

### Learn More

@@ -143,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.