Debian Codegraph @

docs/settings/dsettingsgroup.zh_CN.dox

raw
1 /*!
2 @~chinese
3 @file include/settings/dsettingsgroup.h
4 @ingroup dsettings
5
6 @class Dtk::Core::DSettingsGroup dsettingsgroup.h
7 @brief 一组DSettings选项的集合,也可以包含子组。
8
9 @fn Dtk::Core::DSettingsGroup::DSettingsGroup(QObject *parent = Q_NULLPTR)
10 @brief DSettingsGroup构造函数
11
12 @fn QPointer<DSettingsGroup> Dtk::Core::DSettingsGroup::parentGroup() const
13 @brief 获取当前组的父组
14 @return
15
16 @fn void Dtk::Core::DSettingsGroup::setParentGroup(QPointer< DSettingsGroup > parentGroup)
17 @brief 设置当前组的父组为 `parentGroup`
18
19 @fn QString Dtk::Core::DSettingsGroup::key() const
20 @brief 返回这个组的键,会包含全部的父组的键
21 @return 返回这个组的键,会包含全部的父组的键
22
23 @fn QString Dtk::Core::DSettingsGroup::name() const
24 @brief 返回这个组名称,它可能被翻译。
25 @return 返回这个组名称
26
27 @fn bool Dtk::Core::DSettingsGroup::isHidden() const
28 @brief 检查这个选项组是否会在界面上显示
29 @return true 表示则这个选项组会显示出来
30
31 @fn QPointer<DSettingsGroup> Dtk::Core::DSettingsGroup::childGroup(const QString &groupKey) const
32 @brief 返回给定键在选项组中对应的子组。`groupKey`子组的键
33 @return 返回子组的指针
34
35 @fn QPointer<DSettingsOption> Dtk::Core::DSettingsGroup::option(const QString &key) const
36 @brief 根据键值获取选项。`key`选项的完整键
37 @return 返回对应键值选项指针
38
39 @fn QList<QPointer<DSettingsGroup> > Dtk::Core::DSettingsGroup::childGroups() const
40 @brief 列出组下面所有的直接子组。
41 @return 返回所有子组指针列表
42
43 @fn QList<QPointer<DSettingsOption> > Dtk::Core::DSettingsGroup::childOptions() const
44 @brief 列出组下面所有的直接选项。
45 @return 返回所有子选项指针列表
46
47 @fn QList<QPointer<DSettingsOption> > Dtk::Core::DSettingsGroup::options() const
48 @brief 列出组下面所有的选项。
49 @return 返回所有选项指针列表
50
51 @fn QPointer<DSettingsGroup> Dtk::Core::DSettingsGroup::fromJson(const QString &prefixKey, const QJsonObject &group)
52 @brief 将json对象转化为DSettingsGroup。`prefixKey` 组键值前缀 `group` 待反序列化的json对象
53 @return 返回解析json后的组指针
54 @sa QPointer Dtk::Core::DSettingsOption
55
56 @fn void Dtk::Core::DSettingsGroup::parseJson(const QString &prefixKey, const QJsonObject &group)
57 @brief 将json对象转化为DSettingsGroup。`prefixKey` 组键值前缀 `group` 待反序列化的json对象
58 @sa QPointer<DSettingsOption> Dtk::Core::DSettingsGroup::fromJson(const QString &prefixKey, const QJsonObject &json)
59
60 */