From 6f98dd8930c8c0e0935fce2d9e7a2fea7028b4a0 Mon Sep 17 00:00:00 2001 From: Yuhang Zhao <2546789017@qq.com> Date: Wed, 12 May 2021 08:55:44 +0800 Subject: [PATCH] Update README.md Signed-off-by: Yuhang Zhao <2546789017@qq.com> --- README.md | 7 ++++++- README_unix.md | 7 ++++++- README_win32.md | 7 ++++++- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fd054e8..7f19596 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ int main(int argc, char *argv[]) { Please refer to [the QWidget example](/examples/QWidget/main.cpp) for more detailed information. -### Ignore areas and etc +### Some details ```cpp // Only **TOP LEVEL** QWidgets and QWindows are supported. @@ -60,6 +60,11 @@ win->setMinimumSize(800, 540); FramelessWindowsManager::addIgnoreObject(win, ui->pushButton_minimize); ``` +## IMPORTANT NOTES + +- For [QDockWidget](https://doc.qt.io/qt-6/qdockwidget.html), it supports set a custom title bar widget officially, no need to use this library, and this library is known to be not working well for QDockWidgets. Please refer to for more details. +- Only top level windows ([QWindow](https://doc.qt.io/qt-6/qwindow.html) and [QWidget](https://doc.qt.io/qt-6/qwidget.html)) are supported. + ## Supported Platforms ### Win32 diff --git a/README_unix.md b/README_unix.md index 0071d76..f78b86c 100644 --- a/README_unix.md +++ b/README_unix.md @@ -22,12 +22,17 @@ helper.removeWindowFrame(&widget); widget.show(); ``` -### Ignore areas and etc +### Some details ```cpp helper.setIgnoreAreas(&widget, {{0, 0, 30, 40}, {40, 0, 30, 40}}); ``` +## IMPORTANT NOTES + +- For [QDockWidget](https://doc.qt.io/qt-6/qdockwidget.html), it supports set a custom title bar widget officially, no need to use this library, and this library is known to be not working well for QDockWidgets. Please refer to for more details. +- Only top level windows ([QWindow](https://doc.qt.io/qt-6/qwindow.html) and [QWidget](https://doc.qt.io/qt-6/qwidget.html)) are supported. + ## Requirements | Component | Requirement | Additional Information | diff --git a/README_win32.md b/README_win32.md index 05291ad..5968f44 100644 --- a/README_win32.md +++ b/README_win32.md @@ -28,7 +28,7 @@ widget.show(); Please refer to [the QWidget example](/examples/QWidget/main.cpp) for more detailed information. -### Ignore areas and etc +### Some details ```cpp QWindow *win = widget.windowHandle(); @@ -46,6 +46,11 @@ WinNativeEventFilter::setIgnoredObjects(win, {ui->minimizeBtn, ui->closeBtn}); win->setFlag(Qt::MSWindowsFixedSizeDialogHint); ``` +## IMPORTANT NOTES + +- For [QDockWidget](https://doc.qt.io/qt-6/qdockwidget.html), it supports set a custom title bar widget officially, no need to use this library, and this library is known to be not working well for QDockWidgets. Please refer to for more details. +- Only top level windows ([QWindow](https://doc.qt.io/qt-6/qwindow.html) and [QWidget](https://doc.qt.io/qt-6/qwidget.html)) are supported. + ## Supported Platforms Windows 7 ~ 10, 32 bit & 64 bit.