From 1d128b98cb7d9f57b65b426b401c66f06f6e7d77 Mon Sep 17 00:00:00 2001
From: SineStriker <trueful@163.com>
Date: 周一, 18 12月 2023 21:33:41 +0800
Subject: [PATCH] Update README
---
README.md | 46 ++++++++++++++++++++++++++++++++++------------
1 files changed, 34 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 760f6f0..7c720dd 100644
--- a/README.md
+++ b/README.md
@@ -88,25 +88,47 @@
## Quick Start
-### Initialization
+### Qt Widgets Application
-First of all, you're supposed to add the following code in your `main` function in a very early stage (MUST before the construction of any `Q(Gui|Core)Application` objects).
+First, setup `WidgetWindowAgent` for your QWidget instance. (Each widget needs its own agent.)
```c++
-int main(int argc, char *argv[]) {
-#ifdef Q_OS_WINDOWS
- QCoreApplication::setAttribute(Qt::AA_DontCreateNativeWidgetSiblings);
-#elif defined(Q_OS_MAC)
-# if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
- qputenv("QT_MAC_WANTS_LAYER", "1");
-# endif
-#endif
+auto w = new MyWidget();
+auto agent = new WidgetWindowAgent(w);
+agent->setup(w);
+```
+
+You can also initialize the agent in the widget constructor.
+
+```c++
+MyWidget::MyWidget(QWidget *parent) {
+ // ...
+ auto agent = new WidgetWindowAgent(w);
+ agent->setup(w);
}
```
-### Qt Widgets Application
+Then, construct your titlebar widget, without which the window is lacking in basic interaction feature. You can use the [`WindowBar`](examples/shared/widgetframe/windowbar.h) provided by `WidgetFrame` in the examples as the container for your titlebar components.
-TODO
+```c++
+auto titleLabel = new QLabel();
+auto menuBar = new QMenuBar();
+
+auto windowBar = new QWK::WindowBar();
+windowBar->setMenuBar(menuBar);
+windowBar->setTitleLabel(titleLabel);
+windowBar->setHostWidget(this);
+
+auto iconButton = new QPushButton("馃槃");
+auto minButton = new QPushButton("鈹�");
+auto maxButton = new QPushButton("鈻�");
+auto closeButton = new QPushButton("鉁�");
+agent->setSystemButton(QWK::WindowAgentBase::WindowIcon, iconButton);
+agent->setSystemButton(QWK::WindowAgentBase::Minimize, minButton);
+agent->setSystemButton(QWK::WindowAgentBase::Maximize, maxButton);
+agent->setSystemButton(QWK::WindowAgentBase::Close, closeButton);
+
+```
### Qt Quick Application
--
Gitblit v1.9.1