操作参数接口。仅在插件内有效。更多...

#include <ParameterOperate.h>

类 CParameterOperate 继承关系图:

[图例]

CParameterOperate 的协作图:

[图例]

信号
void	sigSetGlobalParameters ()
	仅由此类使用

void	sigNameChanged (const QString &name=QString())

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

Public 成员函数
	CParameterOperate (QObject *parent=nullptr, const QString &szPrefix=QString())

CParameterPlugin *	GetGlobalParameters ()
	Get CParameterPlugin

int	SetGlobalParameters (CParameterPlugin *p)

const QString	GetName () const

void	SetName (const QString &szName)

Public 成员函数继承自 CParameter
	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 QSettings

virtual int	Save (QSettings &set, bool bForce=true)
	Save to QSettings

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

Protected 槽
virtual void	slotSetGlobalParameters ()
	设置 CParameterPlugin 后调用，用于初始化与 CParameterPlugin 有关的操作。

Protected 成员函数
QByteArray	PasswordSum (const std::string &password, const std::string &key)

int	LoadPassword (const QString &szTitle, const QString &szKey, QString &password, QSettings &set)

int	SavePassword (const QString &szKey, const QString &password, QSettings &set, bool bSave=false)

virtual int	OnLoad (QSettings &set) override

virtual int	OnSave (QSettings &set) override

Protected 成员函数继承自 CParameter
virtual bool	OnCheckValidity ()
	检查参数是否有效

int	SetModified (bool bModified=true)
	在设置参数时，如果有修改，则调用。

bool	GetModified ()
	参数是否有修改

Private 属性
CParameterOperate *	m_Parent

CParameterPlugin *	m_pParameterPlugin

QString	m_szName

额外继承的成员函数
属性继承自 CParameter
bool	Modified

详细描述

操作参数接口。仅在插件内有效。

注解

仅在插件中实现和使用
应用程序不能访问，只能通过 COperate::OpenDialogSettings 进行设置。
插件通过 COperateDesktop::GetParameter()、COperateTerminal::GetParameter()　等访问操作参数
使用连接基础参数
需要访问全局参数 (CParameterPlugin) 的分类，需要从此类派生。通过调用 CParameterOperate::GetGlobalParameters() 访问全局参数 (CParameterPlugin)

设置和得到全局参数。需要操作全局参数的参数应该从此类派生。

使用全局参数(CParameterPlugin)

为操作参数(CParameterOperate 或其派生类)设置全局参数(CParameterPlugin)

如果操作参数 ( CParameterOperate 或其派生类 ) 需要全局参数 (CParameterPlugin) 。
- 请在 COperate 派生类的构造函数中实例化操作参数。例如：
  CParameterFreeRDP m_ParameterFreeRdp;
  
  CParameterFreeRDP
  [Declare CParameterFreeRDP]
  Definition ParameterFreeRDP.h:11
- 调用 COperateDesktop::SetParameter 设置参数指针。例如：
  int COperateFreeRDP::Initial()
  
  {
  
  qDebug(log) << Q_FUNC_INFO;
  
  int nRet = 0;
  
  nRet = COperateDesktop::Initial();
  
  if(nRet) return nRet;
  
  nRet = SetParameter(&m_ParameterFreeRdp);
  
  return nRet;
  
  }
  
  COperateDesktop::Initial
  virtual int Initial() override
  Initial parameters and resource
  Definition OperateDesktop.cpp:168
  
  COperateFreeRDP::Initial
  virtual int Initial() override
  [Set the parameter]
  Definition OperateFreeRDP.cpp:33
- 默认会自动为操作参数设置 CParameterPlugin 。详见: CPlugin::CreateOperate 。
  COperate* CPlugin::CreateOperate(
  
  const QString &szId, CParameterPlugin* para)
  
  {
  
  COperate* p = OnCreateOperate(szId);
  
  if(p) {
  
  int nRet = 0;
  
  //nRet = p->Initial();
  
  bool bRet = QMetaObject::invokeMethod(
  
  p,
  
  "Initial",
  
  Qt::DirectConnection,
  
  Q_RETURN_ARG(int, nRet));
  
  if(!bRet) {
  
  qCritical(log) << "Call p->Initial() fail.";
  
  return nullptr;
  
  }
  
  if(nRet) {
  
  qCritical(log) << "Operate initial fail" << nRet;
  
  DeleteOperate(p);
  
  return nullptr;
  
  }
  
  //nRet = p->SetGlobalParameters(para);
  
  bRet = QMetaObject::invokeMethod(
  
  p,
  
  "SetGlobalParameters",
  
  Qt::DirectConnection,
  
  Q_RETURN_ARG(int, nRet),
  
  Q_ARG(CParameterPlugin*, para));
  
  if(!bRet) {
  
  qCritical(log) << "Call p->SetParameterClient(para) fail.";
  
  return nullptr;
  
  }
  
  if(nRet) {
  
  qCritical(log) << "SetParameterClient fail" << nRet;
  
  DeleteOperate(p);
  
  return nullptr;
  
  }
  
  }
  
  return p;
  
  }
  
  COperate
  操作接口。
  Definition Operate.h:51
  
  CParameterPlugin
  插件的全局参数。
  Definition ParameterPlugin.h:30
  
  CPlugin::CreateOperate
  virtual Q_INVOKABLE COperate * CreateOperate(const QString &szId, CParameterPlugin *para)
  新建 COperate 实例。仅由 CClient 调用
  Definition Plugin.cpp:84
- 如果参数不需要 CParameterPlugin ，那请在 COperate 派生类重载 COperate::SetGlobalParameters 不设置它。

在操作参数 ( CParameterOperate 或其派生类 ) 中使用全局参数 (CParameterPlugin)

在操作参数 ( CParameterOperate 或其派生类 ) 使用 CParameterOperate::GetGlobalParameters() 来得到全局参数 (CParameterPlugin) 。
操作参数 ( CParameterOperate 或其派生类 ) 使用全局参数 (CParameterPlugin) 的值做为其初始值。请重载 CParameterOperate::slotSetGlobalParameters 并在其中初始化相关的值。
例如：是否保存密码以 CParameterPlugin 的成员值做为其初始化值。
void CParameterUser::slotSetGlobalParameters()

{

if(!GetGlobalParameters()) {

QString szErr = "The CParameterClient is null";

qCritical(log) << szErr;

Q_ASSERT_X(false, "CParameterUser", szErr.toStdString().c_str());

return;

}

if(GetGlobalParameters())

{

if(GetGlobalParameters()->GetEnableSystemUserToUser())

SetUser(RabbitCommon::CTools::GetCurrentUser());

SetSavePassword(GetGlobalParameters()->GetSavePassword());

SetSavePassphrase(GetGlobalParameters()->GetSavePassword());

}

return;

}

CParameterOperate::GetGlobalParameters
CParameterPlugin * GetGlobalParameters()
Get CParameterPlugin
Definition ParameterOperate.cpp:32

CParameterUser::slotSetGlobalParameters
virtual void slotSetGlobalParameters() override
Initialize this parameter based on the global parameter
Definition ParameterUser.cpp:183

操作参数分类使用

因为可能会有很多参数，所以需要按参数类型分类。每个分类可以从此类派生出一个单独的类。
因为操作参数都有一些基本的参数（例如网络地址等），所以这些基本参数放入 CParameterBase 。而每个分类做为它的成员变量。

例如：
操作参数包括以下几种类型：

基本参数
class CParameterBase : public CParameterOperate

CParameterBase
连接基础参数接口。包括基本参数（网络参数等）。所有插件的连接参数都应从此类派生。
Definition ParameterBase.h:45

CParameterOperate
操作参数接口。仅在插件内有效。
Definition ParameterOperate.h:210
用户参数
class CParameterUser : public CParameterOperate

CParameterUser
用户名与验证方式。此类仅在插件内有效。它的界面是 CParameterUserUI
Definition ParameterUser.h:23
视频参数
class CParameterVideo : public CParameter

CParameter
参数接口
Definition Parameter.h:209
音频参数
class CParameterAudio : public CParameter

其中 CParameterBase ， CParameterUser 它需要全局参数，所以必须从 CParameterOperate 派生。其它的类型则不需要全局参数的，从 CParameter 派生。

那么操作参数可以是以上类型的集合：

class CParameterBase : public CParameterOperate
{
public:
    explicit CParameterBase(CParameterOperate *parent = nullptr);
 
    CParameterUser m_User;
    CParameterVideo m_Video;
    CParameterAudio m_Audio;
};
 
CParameterBase::CParameterBase(CParameterOperate *parent = nullptr)
 : CParameterOperate(parent),
   m_User(this, "Host"),
   m_Video(this),
   m_Audio(this)
{}

注解

需要全局参数的操作参数必须从 CParameterOperate 派生，否则可以从 CParameter 派生
当成员实例化时
- CParameterUser 必须设置构造函数的参数 parent 为 CParameterOperate 的实例（一般设置为 this）。
- m_Video ， m_Audio 必须设置构造函数的参数 parent 为 CParameter 或其派生类的实例（一般设置为 this）。
为操作参数(CParameterOperate 或其派生类)设置全局参数(CParameterPlugin)

参见: CParameterOperate CParameterPlugin CManager::CreateOperate CPlugin::CreateOperate COperate::SetGlobalParameters COperateDesktop::SetParameter CParameterOperate::GetGlobalParameters

在文件 ParameterOperate.h 第 209 行定义.

成员函数说明

◆ GetGlobalParameters()

CParameterPlugin * CParameterOperate::GetGlobalParameters ( )

Get CParameterPlugin

在文件 ParameterOperate.cpp 第 32 行定义.

◆ GetName()

const QString CParameterOperate::GetName ( ) const

在文件 ParameterOperate.cpp 第 158 行定义.

◆ LoadPassword()

int CParameterOperate::LoadPassword	(	const QString &	szTitle,
		const QString &	szKey,
		QString &	password,
		QSettings &	set
	)

protected

在文件 ParameterOperate.cpp 第 73 行定义.

◆ OnLoad()

int CParameterOperate::OnLoad ( QSettings & set )

overrideprotectedvirtual

实现了 CParameter.

被 CParameterWakeOnLan , 以及 CParameterNet 重载.

在文件 ParameterOperate.cpp 第 172 行定义.

◆ OnSave()

int CParameterOperate::OnSave ( QSettings & set )

overrideprotectedvirtual

实现了 CParameter.

在文件 ParameterOperate.cpp 第 178 行定义.

◆ PasswordSum()

QByteArray CParameterOperate::PasswordSum	(	const std::string &	password,
		const std::string &	key
	)

protected

在文件 ParameterOperate.cpp 第 51 行定义.

◆ SavePassword()

int CParameterOperate::SavePassword	(	const QString &	szKey,
		const QString &	password,
		QSettings &	set,
		bool	bSave = `false`
	)

protected

在文件 ParameterOperate.cpp 第 110 行定义.

◆ SetGlobalParameters()

int CParameterOperate::SetGlobalParameters ( CParameterPlugin * p )

在文件 ParameterOperate.cpp 第 38 行定义.

◆ SetName()

void CParameterOperate::SetName ( const QString & szName )

在文件 ParameterOperate.cpp 第 163 行定义.

◆ sigSetGlobalParameters

void CParameterOperate::sigSetGlobalParameters ( )

signal

仅由此类使用

参见: slotSetGlobalParameters

◆ slotSetGlobalParameters

void CParameterOperate::slotSetGlobalParameters ( )

protectedvirtualslot

设置 CParameterPlugin 后调用，用于初始化与 CParameterPlugin 有关的操作。

在操作参数 ( CParameterOperate 或其派生类 ) 中使用全局参数 (CParameterPlugin)

被 CParameterBase 重载.

在文件 ParameterOperate.cpp 第 46 行定义.

类成员变量说明

◆ m_Parent

CParameterOperate* CParameterOperate::m_Parent

private

在文件 ParameterOperate.h 第 256 行定义.

◆ m_pParameterPlugin

CParameterPlugin* CParameterOperate::m_pParameterPlugin

private

参见: CManager::CreateConnecter COperate::SetGlobalParameters

在文件 ParameterOperate.h 第 260 行定义.

◆ m_szName

QString CParameterOperate::m_szName

private

在文件 ParameterOperate.h 第 262 行定义.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/ParameterOperate.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/ParameterOperate.cpp

信号

Public 成员函数

Protected 槽

Protected 成员函数

Private 属性

额外继承的成员函数

详细描述

使用全局参数(CParameterPlugin)

为操作参数(CParameterOperate 或其派生类)设置全局参数(CParameterPlugin)

在操作参数 ( CParameterOperate 或其派生类 ) 中使用全局参数 (CParameterPlugin)

操作参数分类使用

成员函数说明

◆ GetGlobalParameters()

◆ GetName()

◆ LoadPassword()

◆ OnLoad()

◆ OnSave()

◆ PasswordSum()

◆ SavePassword()

◆ SetGlobalParameters()

◆ SetName()

◆ sigSetGlobalParameters

◆ slotSetGlobalParameters

类成员变量说明

◆ m_Parent

◆ m_pParameterPlugin

◆ m_szName