CParameter类 参考

参数接口 更多...

#include <Parameter.h>

类 CParameter 继承关系图:

信号
void	sigChanged ()
	当参数改变时，触发 通常如果需要，则相应的参数会对应一个改变事件。

Public 成员函数
	CParameter (QObject *parent=nullptr, const QString &szPrefix=QString())
virtual int	Load (QString szFile=QString())
	Load from file
virtual int	Save (QString szFile=QString(), bool bForce=true)
	Save to file
virtual int	Load (QSettings &set)
	Load from storage
virtual int	Save (QSettings &set, bool bForce=true)
	Save to storage
virtual bool	CheckValidity ()
	检查参数是否有效，以决定是否使用或者保存参数。 派生类一般只要重载 OnCheckValidity() ，用于检查参数。

Protected 成员函数
virtual int	OnLoad (QSettings &set)=0
virtual int	OnSave (QSettings &set)=0
virtual bool	OnCheckValidity ()
	检查参数是否有效
int	SetModified (bool bModified=true)
	在设置参数时，如果有修改，则调用。
bool	GetModified ()
	参数是否有修改

属性
bool	Modified

Private 成员函数
int	AddCategory (CParameter *p)
	此类及其派生类的实例做为实例的成员
QString	GetPrefix () const
int	SetPrefix (const QString &szPrefix)

Private 属性
QString	m_szPrefix
bool	m_bModified
	标识参数是否有修改。如果 false，则保存文件时，不保存
QVector< CParameter * >	m_Category
	类别

详细描述

参数接口

参数分类使用

因为可能会有很多参数，所以需要按参数类型分类来管理。每个分类可以从此类派生出一个单独的类。 然后每个分类再做为参数的成员变量。

例如：
连接参数包括以下几种类型：

• 视频参数

  class CParameterVideo : public CParameter

• 音频参数

  class CParameterAudio : public CParameter

那么连接参数可以是以上类型的集合：

class CParameterConnect : public CParameter
{
public:
    explicit CParameterConnect(CParameter *parent = nullptr);
 
    CParameterVideo m_Video;
    CParameterAudio m_Audio;
};
 
CParameterConnect::CParameterConnect(CParameter *parent = nullptr)
 : CParameter(parent),
   m_Video(this),
   m_Audio(this)
{}

注解

当成员实例化时，必须设置构造函数的参数 parent 为 this

CParameter 接口功能

• 从存储中加载和保存参数
  • 如果要自动嵌套调用 CParameter 类型成员的 OnXXX 函数（例如: OnLoad)， 在成员实例化时，设置构造函数的 parent 为 CParameter(一般用this） 类型实例。
  • 如果要自己控制 CParameter 类型成员的 OnXXX 函数（例如: OnLoad)， 在成员实例化时，设置构造函数的 parent 为空或者设置为非 CParameter 类型实例。
• 当派生类设置参数时，需要调用 SetModified 。标志参数已改变。
• 检查参数的有效性。调用 CheckValidity()

在文件 Parameter.h 第 168 行定义.

构造及析构函数说明

CParameter()

CParameter::CParameter ( QObject *  parent = nullptr, const QString &  szPrefix = QString()  )

explicit

参数

parent

为 CParameter 实例，则自动调用 CParameter 类型成员的 OnXXX 函数。 为空或者非 CParameter 实例，则不调用 CParameter 类型成员的 OnXXX 函数

参见

Load(QSettings &set) Save(QSettings &set, bool bForce = true)

~CParameter()

CParameter::~CParameter ( )

virtual

在文件 Parameter.cpp 第 19 行定义.

成员函数说明

AddCategory()

int CParameter::AddCategory ( CParameter *  p )

private

此类及其派生类的实例做为实例的成员

在文件 Parameter.cpp 第 130 行定义.

CheckValidity()

bool CParameter::CheckValidity ( )

virtual

检查参数是否有效，以决定是否使用或者保存参数。 派生类一般只要重载 OnCheckValidity() ，用于检查参数。

例如：用于在参数设置对话框时，需要先检查参数是否完成或者有效，才能确定保存。

在文件 Parameter.cpp 第 99 行定义.

GetModified()

bool CParameter::GetModified ( )

protected

参数是否有修改

GetModified

返回

• true: modified
• false: no modified

在文件 Parameter.cpp 第 117 行定义.

GetPrefix()

QString CParameter::GetPrefix ( ) const

private

在文件 Parameter.cpp 第 22 行定义.

Load() [1/2]

int CParameter::Load ( QSettings &  set )

virtual

Load from storage

被 CParameterTerminal 重载.

在文件 Parameter.cpp 第 56 行定义.

Load() [2/2]

int CParameter::Load ( QString  szFile = QString() )

virtual

Load from file

在文件 Parameter.cpp 第 33 行定义.

OnCheckValidity()

bool CParameter::OnCheckValidity ( )

protectedvirtual

检查参数是否有效

返回

• true: 有效
• false: 无效

被 CParameterVnc , 以及 CParameterWakeOnLan 重载.

在文件 Parameter.cpp 第 111 行定义.

OnLoad()

virtual int CParameter::OnLoad ( QSettings &  set )

protectedpure virtual

在 CParameterClient, CParameterNet , 以及 CParameterWakeOnLan 内被实现.

OnSave()

virtual int CParameter::OnSave ( QSettings &  set )

protectedpure virtual

在 CParameterClient 内被实现.

Save() [1/2]

int CParameter::Save ( QSettings &  set, bool  bForce = true  )

virtual

Save to storage

在文件 Parameter.cpp 第 77 行定义.

Save() [2/2]

int CParameter::Save ( QString  szFile = QString(), bool  bForce = true  )

virtual

Save to file

在文件 Parameter.cpp 第 44 行定义.

SetModified()

int CParameter::SetModified ( bool  bModified = true )

protected

在设置参数时，如果有修改，则调用。

参数

bModified

在文件 Parameter.cpp 第 122 行定义.

SetPrefix()

int CParameter::SetPrefix ( const QString &  szPrefix )

private

在文件 Parameter.cpp 第 27 行定义.

类成员变量说明

m_bModified

bool CParameter::m_bModified

private

标识参数是否有修改。如果 false，则保存文件时，不保存

在文件 Parameter.h 第 296 行定义.

m_Category

QVector<CParameter*> CParameter::m_Category

private

类别

在文件 Parameter.h 第 302 行定义.

m_szPrefix

QString CParameter::m_szPrefix

private

在文件 Parameter.h 第 288 行定义.

属性说明

Modified

bool CParameter::Modified

readwrite

在文件 Parameter.h 第 171 行定义.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Client/Parameter.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Client/Parameter.cpp