Dtk::Core::DConfigMeta类 参考

提供配置文件的原型和覆盖机制的访问接口 更多...

#include <dconfigfile.h>

Public 成员函数
virtual DConfigFile::Version	version () const =0
	返回配置版本信息
virtual void	setVersion (quint16 major, quint16 minor)=0
	设置配置版本信息
virtual bool	load (const QString &localPrefix=QString())=0
	解析配置文件
virtual bool	load (QIODevice *meta, const QList< QIODevice * > &overrides)=0
	解析配置文件流
virtual QStringList	keyList () const =0
	返回配置内容的所有配置项
virtual DConfigFile::Flags	flags (const QString &key) const =0
	返回指定配置项的特性
virtual DConfigFile::Permissions	permissions (const QString &key) const =0
	返回指定配置项的权限
virtual DConfigFile::Visibility	visibility (const QString &key) const =0
	返回指定配置项的可见性
virtual int	serial (const QString &key) const =0
	返回配置项的单调递增值
virtual QString	displayName (const QString &key, const QLocale &locale)=0
	返回指定配置项的显示名
virtual QString	description (const QString &key, const QLocale &locale)=0
	返回指定配置项的描述信息
virtual QString	metaPath (const QString &localPrefix=QString(), bool *useAppId=nullptr) const =0
	返回描述文件的路径
virtual QStringList	allOverrideDirs (const bool useAppId, const QString &prefix=QString()) const =0
	获得前缀为 prefix 目录的所有需要查找的覆盖机制目录
virtual QVariant	value (const QString &key) const =0
	meta初始值经过覆盖机制覆盖后的原始值

静态 Public 成员函数
static QStringList	genericMetaDirs (const QString &localPrefix=QString())
static QStringList	applicationMetaDirs (const QString &localPrefix, const QString &appId)

详细描述

提供配置文件的原型和覆盖机制的访问接口

成员函数说明

allOverrideDirs()

QStringList Dtk::Core::DConfigMeta::allOverrideDirs ( const bool  useAppId, const QString &  prefix = QString()  ) const

pure virtual

获得前缀为 prefix 目录的所有需要查找的覆盖机制目录

参数

[in]	useAppId	是否不使用通用目录
[in]	prefix	目录的应用或公共库的所有覆盖机制目录

返回

description()

QString Dtk::Core::DConfigMeta::description ( const QString &  key, const QLocale &  locale  )

pure virtual

返回指定配置项的描述信息

参数

[in]	key	配置项名称
[in]	locale	为语言版本

返回

displayName()

QString Dtk::Core::DConfigMeta::displayName ( const QString &  key, const QLocale &  locale  )

pure virtual

返回指定配置项的显示名

参数

[in]	key	配置项名称
[in]	locale	为语言版本

返回

flags()

DConfigFile::Flags Dtk::Core::DConfigMeta::flags ( const QString &  key ) const

pure virtual

返回指定配置项的特性

参数

[in]

key

配置项名称, NoOverride为此配置项不可被覆盖, Global为忽略用户身份

返回

keyList()

QStringList Dtk::Core::DConfigMeta::keyList ( ) const

pure virtual

返回配置内容的所有配置项

返回

load() [1/2]

bool Dtk::Core::DConfigMeta::load ( const QString &  localPrefix = QString() )

pure virtual

解析配置文件

参数

[in]

localPrefix

为目录前缀

返回

load() [2/2]

bool Dtk::Core::DConfigMeta::load ( QIODevice *  meta, const QList< QIODevice * > &  overrides  )

pure virtual

解析配置文件流

参数

[in]	meta	为原型流
[in]	overrides	为覆盖机制查找的文件流

返回

metaPath()

QString Dtk::Core::DConfigMeta::metaPath ( const QString &  localPrefix = QString(), bool *  useAppId = nullptr  ) const

pure virtual

返回描述文件的路径

参数

[in]	localPrefix	目录的所有需要查找的覆盖机制目录
[in]	useAppId	是否不使用通用目录

返回

permissions()

DConfigFile::Permissions Dtk::Core::DConfigMeta::permissions ( const QString &  key ) const

pure virtual

返回指定配置项的权限

参数

[in]

key

配置项名称

返回

serial()

int Dtk::Core::DConfigMeta::serial ( const QString &  key ) const

pure virtual

返回配置项的单调递增值

参数

[in]

key

配置项名称

返回

-1为无效值,表明没有配置此项

setVersion()

void Dtk::Core::DConfigMeta::setVersion ( quint16  major, quint16  minor  )

pure virtual

设置配置版本信息

参数

[in]	major	主板本号
[in]	minor	次版本号

value()

QVariant DConfigMeta::value ( const QString &  key ) const

pure virtual

meta初始值经过覆盖机制覆盖后的原始值

参数

[in]

key

配置项名称

返回

version()

DConfigFile::Version Dtk::Core::DConfigMeta::version ( ) const

pure virtual

返回配置版本信息

返回

visibility()

DConfigFile::Visibility Dtk::Core::DConfigMeta::visibility ( const QString &  key ) const

pure virtual

返回指定配置项的可见性

参数

[in]

key

配置项名称

返回

---

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

• include/global/dconfigfile.h
• docs/global/dconfigfile.zh_CN.dox