DtkCore
DTK Core module
信号 | Public 成员函数 | 静态 Public 成员函数 | 属性 | 所有成员列表
Dtk::Core::DConfig类 参考

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

#include <dconfig.h>

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

信号

void valueChanged (const QString &key)
 

Public 成员函数

 DConfig (const QString &name, const QString &subpath=QString(), QObject *parent=nullptr)
 
 DConfig (DConfigBackend *backend, const QString &name, const QString &subpath=QString(), QObject *parent=nullptr)
 
QString backendName () const
 配置策略后端名称 更多...
 
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。 更多...
 
static DConfig * create (DConfigBackend *backend, const QString &appId, const QString &name, const QString &subpath=QString(), QObject *parent=nullptr)
 构造配置策略提供的对象,指定配置所属的应用Id。 更多...
 

属性

QStringList keyList
 获得所有可用的配置项名称 更多...
 

额外继承的成员函数

- Protected 成员函数 继承自 Dtk::Core::DObject
 DObject (DObject *parent=nullptr)
 
 DObject (DObjectPrivate &dd, DObject *parent=nullptr)
 
- Protected 属性 继承自 Dtk::Core::DObject
QScopedPointer< DObjectPrivate > d_d_ptr
 

详细描述

配置策略提供的接口类

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

成员函数说明

◆ backendName()

QString Dtk::Core::DConfig::backendName ( ) const

配置策略后端名称

返回
配置策略后端名称
注解
调用者只能用DConfig访问DConfigBackend对象,所以不返回DConfigBackend对象。

◆ create() [1/2]

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

构造配置策略提供的对象,指定配置所属的应用Id。

参数
[in]appId配置文件所属的应用Id,为空时默认为本应用Id
[in]name配置文件名
[in]subpath配置文件对应的子目录
[in]parent父对象
返回
构造的配置策略对象,由调用者释放

◆ create() [2/2]

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

构造配置策略提供的对象,指定配置所属的应用Id。

参数
[in]backend调用者继承于DConfigBackend的配置策略后端
[in]appId配置文件所属的应用Id,为空时默认为本应用Id
[in]name配置文件名
[in]subpath配置文件对应的子目录
[in]parent父对象
返回
构造的配置策略对象,由调用者释放

◆ reset()

void Dtk::Core::DConfig::reset ( const QString &  key)

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

参数
[in]key配置项名称

◆ setValue()

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

根据配置项名称设置其值

参数
[in]key配置项名称
[in]value需要更新的值

◆ value()

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

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

参数
[in]key配置项名称
[in]fallback没有获取到配置项值后提供的默认值

属性说明

◆ keyList

QStringList Dtk::Core::DConfig::keyList
read

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

返回
配置项名称集合
该类的文档由以下文件生成: