Dtk::Core::DSettingsOption类 参考

DSettingsOption是DSettings的基本单元,用于存放一对键-值数据。 更多...

#include <dsettingsoption.h>

类 Dtk::Core::DSettingsOption 继承关系图:

Public 槽
void	setValue (QVariant value)
	设置选项的当前值. 更多...
void	setData (const QString &dataType, QVariant value)
	为选项添加自定义属性 更多...

信号
void	valueChanged (QVariant value)
	选项的数据变化时发出改信息 更多...
void	dataChanged (const QString &dataType, QVariant value)
	选项的附件的额外数据变化时发出改信息，可以看作这个值的属性发生变化。 更多...

Public 成员函数
	DSettingsOption (QObject *parent=Q_NULLPTR)
	DSettingsOption构造函数
QPointer< DSettingsGroup >	parentGroup () const
	当前选项的直接上级组 更多...
void	setParentGroup (QPointer< DSettingsGroup > parentGroup)
	修改当前选项的上级组 更多...
QString	key () const
	当前选项的键值 更多...
QString	name () const
	当前选项的名称 更多...
bool	canReset () const
	选项是否可以重置,如果可以重置,在调用reset方法后,选项的值会变成初始值。 更多...
QVariant	defaultValue () const
	选项的默认值 更多...
QVariant	value () const
	选项的当前值 更多...
QVariant	data (const QString &dataType) const
	选项的附件data,用于未选项设置一些额外的辅助属性。 更多...
QString	viewType () const
	选项的控件类型 更多...
bool	isHidden () const
	检查选项是否会在界面上显示 更多...

静态 Public 成员函数
static QPointer< DSettingsOption >	fromJson (const QString &prefixKey, const QJsonObject &json)
	从json对象中反序列化出一个选项对象 更多...

属性
QVariant	value

详细描述

DSettingsOption是DSettings的基本单元,用于存放一对键-值数据。

成员函数说明

canReset()

bool Dtk::Core::DSettingsOption::canReset

(

)

const

选项是否可以重置,如果可以重置,在调用reset方法后,选项的值会变成初始值。

返回

如果可以重置则为true

data()

QVariant Dtk::Core::DSettingsOption::data

(

const QString &

dataType

)

const

选项的附件data,用于未选项设置一些额外的辅助属性。

参数

[in]

dataType

数据类型

返回

数据类型对应的数据.

参见

QObject::property

Dtk::Core::DSettingsOption::setData

dataChanged

void Dtk::Core::DSettingsOption::dataChanged ( const QString &  dataType, QVariant  value  )

signal

选项的附件的额外数据变化时发出改信息，可以看作这个值的属性发生变化。

参数

[in]	dataType	改变的数据类型
[in]	value	发生改变的数据

defaultValue()

QVariant Dtk::Core::DSettingsOption::defaultValue

(

)

const

选项的默认值

返回

返回选项的默认值

fromJson()

static QPointer< DSettingsOption > Dtk::Core::DSettingsOption::fromJson ( const QString &  prefixKey, const QJsonObject &  json  )

static

从json对象中反序列化出一个选项对象

参数

[in]	prefixKey	选项的前缀
[in]	json	待反序列化的json对象

返回

返回解析完成后的 option 数据

isHidden()

bool Dtk::Core::DSettingsOption::isHidden

(

)

const

检查选项是否会在界面上显示

返回

如果显示则返回true,否则返回false。

key()

QString Dtk::Core::DSettingsOption::key

(

)

const

当前选项的键值

返回

返回当前选项的键值

name()

QString Dtk::Core::DSettingsOption::name

(

)

const

当前选项的名称

返回

返回当前选项的名称

parentGroup()

QPointer< DSettingsGroup > Dtk::Core::DSettingsOption::parentGroup

(

)

const

当前选项的直接上级组

返回

返回当前选项的直接上级组

setData

void Dtk::Core::DSettingsOption::setData ( const QString &  dataType, QVariant  value  )

slot

为选项添加自定义属性

参数

[in]	dataType	选项的扎属性数据id,对每个选项必须唯一
[in]	value	选项id对应的值

参见

Dtk::Core::DSettingsOption::data

setParentGroup()

void Dtk::Core::DSettingsOption::setParentGroup

(

QPointer< DSettingsGroup >

parentGroup

)

修改当前选项的上级组

参数

[in]

parentGroup

上级组

setValue

void Dtk::Core::DSettingsOption::setValue ( QVariant  value )

slot

设置选项的当前值.

参数

[in]

value

选项的当前值

value()

QVariant Dtk::Core::DSettingsOption::value

(

)

const

选项的当前值

返回

返回选项的当前值

valueChanged

void Dtk::Core::DSettingsOption::valueChanged ( QVariant  value )

signal

选项的数据变化时发出改信息

参数

[in]

value

发生改变的数据

viewType()

QString Dtk::Core::DSettingsOption::viewType

(

)

const

选项的控件类型

返回

返回选项的控件类型

参见

Dtk::Widget::DSettingsWidgetFactory

---

该类的文档由以下文件生成:

• include/settings/dsettingsoption.h
• docs/settings/dsettingsoption.zh_CN.dox