Debian Codegraph @

docs/settings/dsettingsoption.zh_CN.dox

raw
1 /*!
2 @~chinese
3 @file include/settings/dsettingsoption.h
4 @ingroup dsettings
5
6 @class Dtk::Core::DSettingsOption dsettingsoption.h
7 @brief DSettingsOption是DSettings的基本单元,用于存放一对键-值数据。
8
9 @fn Dtk::Core::DSettingsOption::DSettingsOption(QObject *parent = Q_NULLPTR)
10 @brief DSettingsOption构造函数
11
12 @fn QPointer<DSettingsGroup> Dtk::Core::DSettingsOption::parentGroup() const
13 @brief 当前选项的直接上级组
14 @return 返回当前选项的直接上级组
15
16 @fn void Dtk::Core::DSettingsOption::setParentGroup(QPointer<DSettingsGroup> parentGroup)
17 @brief 修改当前选项的上级组
18 @param[in] parentGroup 上级组
19
20 @fn QString Dtk::Core::DSettingsOption::key() const
21 @brief 当前选项的键值
22 @return 返回当前选项的键值
23
24 @fn QString Dtk::Core::DSettingsOption::name() const
25 @brief 当前选项的名称
26 @return 返回当前选项的名称
27
28 @fn bool Dtk::Core::DSettingsOption::canReset() const
29 @brief 选项是否可以重置,如果可以重置,在调用reset方法后,选项的值会变成初始值。
30 @return 如果可以重置则为true
31
32 @fn QVariant Dtk::Core::DSettingsOption::defaultValue() const
33 @brief 选项的默认值
34 @return 返回选项的默认值
35
36 @fn QVariant Dtk::Core::DSettingsOption::value() const
37 @brief 选项的当前值
38 @return 返回选项的当前值
39
40 @fn QVariant Dtk::Core::DSettingsOption::data(const QString &dataType) const
41 @param[in] dataType 数据类型
42 @brief 选项的附件data,用于未选项设置一些额外的辅助属性。
43 @return 数据类型对应的数据.
44 @sa QObject::property
45 @sa Dtk::Core::DSettingsOption::setData
46
47 @fn QString Dtk::Core::DSettingsOption::viewType() const
48 @brief 选项的控件类型
49 @return 返回选项的控件类型
50 @sa Dtk::Widget::DSettingsWidgetFactory
51
52 @fn bool Dtk::Core::DSettingsOption::isHidden() const
53 @brief 检查选项是否会在界面上显示
54 @return 如果显示则返回true,否则返回false。
55
56 @fn static QPointer<DSettingsOption> Dtk::Core::DSettingsOption::fromJson(const QString &prefixKey, const QJsonObject &json)
57 @brief 从json对象中反序列化出一个选项对象
58 @param[in] prefixKey 选项的前缀
59 @param[in] json 待反序列化的json对象
60 @return 返回解析完成后的 `option` 数据
61
62 @fn void Dtk::Core::DSettingsOption::setValue(QVariant value)
63 @brief 设置选项的当前值.
64 @param[in] value 选项的当前值
65
66 @fn void Dtk::Core::DSettingsOption::setData(const QString &dataType, QVariant value)
67 @brief 为选项添加自定义属性
68 @param[in] dataType 选项的扎属性数据id,对每个选项必须唯一
69 @param[in] value 选项id对应的值
70 @sa Dtk::Core::DSettingsOption::data
71
72 @fn void Dtk::Core::DSettingsOption::parseJson(const QString &prefixKey, const QJsonObject &option)
73 @brief 从json对象中反序列化,并设置自身的值。
74 @param[in] prefixKey 选项的前缀
75 @param[in] option 待反序列化的json对象
76 @sa QPointer<DSettingsOption> Dtk::Core::DSettingsOption::fromJson(const QString &prefixKey, const QJsonObject &json)
77
78 @fn void Dtk::Core::DSettingsOption::valueChanged(QVariant value)
79 @brief 选项的数据变化时发出改信息
80 @param[in] value 发生改变的数据
81
82 @fn void Dtk::Core::DSettingsOption::dataChanged(const QString &dataType, QVariant value);
83 @brief 选项的附件的额外数据变化时发出改信息,可以看作这个值的属性发生变化。
84 @param[in] dataType 改变的数据类型
85 @param[in] value 发生改变的数据
86
87 */