From 40de8507c452d86b136ff842bb184b8ca8b3e7a6 Mon Sep 17 00:00:00 2001 From: Sine Striker <trueful@163.com> Date: 周二, 19 12月 2023 20:41:22 +0800 Subject: [PATCH] Update README --- docs/images/win11.png | 0 docs/images/win10.png | 0 README.md | 53 +++++++++++++++++++++++++++-------------------------- 3 files changed, 27 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 5780868..556e78b 100644 --- a/README.md +++ b/README.md @@ -5,32 +5,27 @@ 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 | -|:---------------------------------:|:-------------------------------:|:---------------------------------:| -|  |  |  | - -### Windows 11 Snap Layout - - - -## 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) + + +### Windows 10 (And 7, Vista) + + +### MacOS & Linux + +| MacOS | Linux (Ubuntu 20.04) | +|:-------------------------------:|:---------------------------------:| +|  |  | ## 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. \ No newline at end of file diff --git a/docs/images/win10.png b/docs/images/win10.png index cc327b0..7975626 100644 --- a/docs/images/win10.png +++ b/docs/images/win10.png Binary files differ diff --git a/docs/images/win11.png b/docs/images/win11.png index 3daf45d..5cca0b5 100644 --- a/docs/images/win11.png +++ b/docs/images/win11.png Binary files differ -- Gitblit v1.9.1