DtkCore
DTK Core module
Public 成员函数 | 所有成员列表
Dtk::Core::DConfigMeta类 参考abstract

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

#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初始值经过覆盖机制覆盖后的原始值 更多...
 

详细描述

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

成员函数说明

◆ 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配置项名称
返回
该类的文档由以下文件生成: