From 3a2532b4e9f51dcecf1ea5f8bb894fcb98f8a99b Mon Sep 17 00:00:00 2001 From: ZhangHuaimin Date: Thu, 26 Sep 2024 19:11:15 +0800 Subject: [PATCH] docs: update document. --- README.md | 6 +++--- doc/en/Document.md | 36 ++++++++++++++++++++++++++++++++---- doc/zh_cn/Document.md | 41 ++++++++++++++++++++++++++++++++++------- doc/zh_cn/README.md | 6 +++--- 4 files changed, 72 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 855e247..0765e18 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [中文](./doc/zh_cn/README.md) -`declarative syntax` and `property binding` extension for QWidget. +nwidget is a `header only` library that provides `declarative syntax` and `property binding` extensions to QWidget. [Document](./doc/en/Document.md) @@ -64,12 +64,12 @@ nw::SliderId slider2 = new QSlider; QLayout* layout = nw::VBoxLayout{ nw::Label(label) - .text(nw::asprintf("%d", slider1.value() + slider2.value())), + .text(nw::asprintf("%d", slider1.value() + slider2.value())), // create a binding nw::Slider(slider1).orientation(Qt::Horizontal), nw::Slider(slider2).orientation(Qt::Horizontal), }; -// It also equivalent to the following 3 ways: +// A binding can also be created in one of three ways: label.text() = nw::asprintf("%d", slider1.value() + slider2.value()); nw::asprintf("%d", slider1.value() + slider2.value()) diff --git a/doc/en/Document.md b/doc/en/Document.md index 02662ec..3e91415 100644 --- a/doc/en/Document.md +++ b/doc/en/Document.md @@ -9,6 +9,8 @@ - [Property Binding](#property-binding) - [is\_observable\](#is_observablet) - [is\_same\_property\](#is_same_propertya-b) +- [Helper Method](#helper-method) + - [id\_of，builder\_of, as\_id，as\_builder](#id_ofbuilder_of-as_idas_builder) ## Inclusion @@ -39,10 +41,12 @@ auto* button2 = new QPushButton; button1.setText("Button"); QLayout* layout = nwidget::VBoxLayout{ - button1, // Use existing instance + button1, // Use existing instance new QPushButton, nwidget::PushButton(), nwidget::PushButton(button2).text("Button"), // Set on existing instance + // equivalent to + // as_builder(button2).text("Button") }; ``` @@ -83,6 +87,10 @@ or in code: nwidget::SliderId slider1 = new QSlider; nwidget::SliderId slider2 = new QSlider; nwidget::SliderId slider3 = new QSlider; +// equivalent to +// auto slider1 = nwidget::as_id(new QSlider); +// auto slider2 = nwidget::as_id(new QSlider); +// auto slider3 = nwidget::as_id(new QSlider); slider3.value() = slider1.value() + slider2.value(); ``` @@ -196,9 +204,10 @@ You can use the same instance’s properties in expressions, but need to avoid l ```cpp button.iconSize() -= nwidget::constructor(slider.value(), // < Signal change here is subscribed - button.iconSize() // < Signal change here is ignored - .invoke(&QSize::height)); += nwidget::constructor( + slider.value(), // < Signal change here is subscribed + button.iconSize() // < Signal change here is ignored + .invoke(&QSize::height)); ``` ### is_observable\ @@ -226,3 +235,22 @@ nwidget::is_same_property_v; // true nwidget::is_same_property_v; // false ``` + +## Helper Method + +### id_of，builder_of, as_id，as_builder + +```cpp +class MySlider : public QSlider { ... }; + +using type1 = id_of_t; // nwidget::SliderId +using type2 = id_of_t; // void (void if there is no corresponding builder) +using type3 = id_of_t; // void + +auto slider1 = as_id(new QSlider); // SliderId +auto slider2 = as_id(new MySlider); // SliderId (Use parent class if there is no corresponding xxxId) +``` + +`builder_of`, `as_builder` are used in the same way as in the examples above. + +To make custom types available in these methods, declare the corresponding Id and Builder with `N_REGISTER_ID`, `N_REGISTER_BUILDER`. diff --git a/doc/zh_cn/Document.md b/doc/zh_cn/Document.md index 435533d..82c248d 100644 --- a/doc/zh_cn/Document.md +++ b/doc/zh_cn/Document.md @@ -1,14 +1,16 @@ # 文档 --[引入](#引入) +- [引入](#引入) - [布局语法](#布局语法) - [ForEach](#foreach) - [属性绑定](#属性绑定) - [xxxId](#xxxid) - [Property](#property) - - [属性绑定](#属性绑定) + - [属性绑定](#属性绑定-1) - [is\_observable\](#is_observablet) - [is\_same\_property\](#is_same_propertya-b) +- [辅助方法](#辅助方法) + - [id\_of，builder\_of, as\_id，as\_builder](#id_ofbuilder_of-as_idas_builder) ## 引入 @@ -39,10 +41,12 @@ auto* button2 = new QPushButton; button1.setText("Button"); QLayout* layout = nwidget::VBoxLayout{ - button1, // 使用已有实例 + button1, // 使用已有实例 new QPushButton, nwidget::PushButton(), nwidget::PushButton(button2).text("Button"), // 在已有实例上设置 + // 等价于 + // as_builder(button2).text("Button") }; ``` @@ -83,6 +87,10 @@ QLayout* layout = VBoxLayout{ nwidget::SliderId slider1 = new QSlider; nwidget::SliderId slider2 = new QSlider; nwidget::SliderId slider3 = new QSlider; +// 等价于 +// auto slider1 = nwidget::as_id(new QSlider); +// auto slider2 = nwidget::as_id(new QSlider); +// auto slider3 = nwidget::as_id(new QSlider); slider3.value() = slider1.value() + slider2.value(); ``` @@ -195,10 +203,10 @@ label.text() = nwidget::asprintf("%d, %d", sldier1.value(), sldier2.value()); 你可以在表达式中使用相同实例的相同属性，但应避免循环和在表达式中更新表达式的值： ```cpp -button.iconSize() -= nwidget::constructor(slider.value(), // < 此处变更信号被订阅 - button.iconSize() // < 此处变更信号被忽略 - .invoke(&QSize::height)); +button.iconSize() = nwidget::constructor( + slider.value(), // < 此处变更信号被订阅 + button.iconSize() // < 此处变更信号被忽略 + .invoke(&QSize::height)); ``` ### is_observable\ @@ -226,3 +234,22 @@ nwidget::is_same_property_v; // true nwidget::is_same_property_v; // false ``` + +## 辅助方法 + +### id_of，builder_of, as_id，as_builder + +```cpp +class MySlider : public QSlider { ... }; + +using type1 = id_of_t; // nwidget::SliderId +using type2 = id_of_t; // void（若无对应 xxxId，则为 void） +using type3 = id_of_t; // void + +auto slider1 = as_id(new QSlider); // SliderId +auto slider2 = as_id(new MySlider); // SliderId（若无对应 xxxId，则使用父类） +``` + +`builder_of`、`as_builder` 的使用方法与以上示例相同 + +要使自定义类型可在这些方法中使用，请用 `N_REGISTER_ID`，`N_REGISTER_BUILDER` 声明对应的 Id、Builder diff --git a/doc/zh_cn/README.md b/doc/zh_cn/README.md index 3451530..b06f7b9 100644 --- a/doc/zh_cn/README.md +++ b/doc/zh_cn/README.md @@ -1,6 +1,6 @@ # nwidget -QWidget 的 `声明式语法` 和 `属性绑定` 拓展 +nwidget 是一个 `仅头文件` 库，为QWidget 提供了 `声明式语法` 和 `属性绑定` 的拓展 [文档](Document.md) @@ -62,12 +62,12 @@ nw::SliderId slider2 = new QSlider; QLayout* layout = nw::VBoxLayout{ nw::Label(label) - .text(nw::asprintf("%d", slider1.value() + slider2.value())), + .text(nw::asprintf("%d", slider1.value() + slider2.value())), // 创建绑定 nw::Slider(slider1).orientation(Qt::Horizontal), nw::Slider(slider2).orientation(Qt::Horizontal), }; -// 也等价于以下3种写法： +// 绑定也可通过以下方式创建 label.text() = nw::asprintf("%d", slider1.value() + slider2.value()); nw::asprintf("%d", slider1.value() + slider2.value())