Dtk::Core::DConfig类 参考

配置策略提供的接口类 更多...

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

信号
void	valueChanged (const QString &key)

Public 成员函数
	DConfig (const QString &name, const QString &subpath=QString(), QObject *parent=nullptr)
	构造配置策略提供的对象 name 配置文件名 subpath 配置文件对应的子目录 parent 父对象
	DConfig (DConfigBackend *backend, const QString &name, const QString &subpath=QString(), QObject *parent=nullptr)
QString	backendName () const
	DConfig::backendName 更多...
QStringList	keyList () const
	获得所有可用的配置项名称 更多...
bool	isValid () const
	判断此后端是否可用 更多...
QVariant	value (const QString &key, const QVariant &fallback=QVariant()) const
	根据配置项名称获得对应值 更多...
void	setValue (const QString &key, const QVariant &value)
	根据配置项名称设置其值 更多...
void	reset (const QString &key)
	设置其配置项对应的默认值，此值为经过override机制覆盖后的值，不一定为此配置文件中meta中定义的值 更多...
QString	name () const
	返回配置文件名称 更多...
QString	subpath () const
	返回配置文件对应的子目录 更多...

静态 Public 成员函数
static DConfig *	create (const QString &appId, const QString &name, const QString &subpath=QString(), QObject *parent=nullptr)
	构造配置策略提供的对象, 指定配置所属的应用Id appId name subpath parent 更多...
static DConfig *	create (DConfigBackend *backend, const QString &appId, const QString &name, const QString &subpath=QString(), QObject *parent=nullptr)

属性
QStringList	keyList

额外继承的成员函数
Protected 成员函数 继承自 Dtk::Core::DObject
	DObject (DObject *parent=nullptr)
	只有在不需要数据成员的派生类中才会使用 parent 父类指针
	DObject (DObjectPrivate &dd, DObject *parent=nullptr)
	在派生类中比较常用的构造函数 dd 私有类对象
Protected 属性 继承自 Dtk::Core::DObject
QScopedPointer< DObjectPrivate >	d_d_ptr

详细描述

配置策略提供的接口类

\inmodule dtkcore

此接口规范定义了开发库所提供的关于配置文件读写的相关接口， 如果应用程序所使用的开发库实现了此规范，则程序应当优先使用开发库提供的接口。

成员函数说明

backendName()

QString Dtk::Core::DConfig::backendName

(

)

const

DConfig::backendName

返回

配置策略后端名称

注解

调用者只能用DConfig访问DConfigBackend对象，所以不返回DConfigBackend对象。

create()

DConfig * Dtk::Core::DConfig::create ( const QString &  appId, const QString &  name, const QString &  subpath = QString(), QObject *  parent = nullptr  )

static

构造配置策略提供的对象, 指定配置所属的应用Id appId name subpath parent

返回

构造的配置策略对象，由调用者释放

isValid()

bool Dtk::Core::DConfig::isValid

(

)

const

判断此后端是否可用

返回

keyList()

QStringList Dtk::Core::DConfig::keyList

(

)

const

获得所有可用的配置项名称

返回

配置项名称集合

name()

QString Dtk::Core::DConfig::name

(

)

const

返回配置文件名称

返回

reset()

void Dtk::Core::DConfig::reset

(

const QString &

key

)

设置其配置项对应的默认值，此值为经过override机制覆盖后的值，不一定为此配置文件中meta中定义的值

参数

配置项名称

setValue()

void Dtk::Core::DConfig::setValue	(	const QString &	key,
		const QVariant &	value
	)

根据配置项名称设置其值

参数

配置项名称
需要更新的值

subpath()

QString Dtk::Core::DConfig::subpath

(

)

const

返回配置文件对应的子目录

返回

value()

QVariant Dtk::Core::DConfig::value	(	const QString &	key,
		const QVariant &	fallback = QVariant()
	)		const

根据配置项名称获得对应值

参数

key	配置项名称
fallback	没有获取到配置项值后提供的默认值

返回

---

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

• src/dconfig.h
• src/dconfig.cpp