Sine Striker
2024-02-29 1a5462d80b6b07dcb25522e7b187994c7f82506d
README.md
@@ -85,7 +85,10 @@
### 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"
@@ -237,7 +240,8 @@
        window.visible = true
    }
    WindowAgent {
      // ...
        id: windowAgent
        // ...
    }
}
```
@@ -250,6 +254,14 @@
+ QWindowKit Internals [TODO]
+ [FramelessHelper Related](docs/framelesshelper-related.md)
### Vulnerabilities
+ Once you have made the window frameless, it will not be able to switch back to the system border.
+ There must not be any 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.
    + If you want to show a non-modal dialog as a child of a frameless window, you should call `QGuiApplication::setAttribute(Qt::AA_DontCreateNativeWidgetSiblings)` before the dialog constructs or in the very beginning in the main entry.
## TODO
@@ -264,4 +276,12 @@
## 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.**
-->