CParameterOperate Class Reference

Operational parameter interface. More...

#include <ParameterOperate.h>

Inheritance diagram for CParameterOperate:

Collaboration diagram for CParameterOperate:

Signals
void	sigSetGlobalParameters ()
	Only used by this class.
void	sigNameChanged (const QString &name=QString())
Signals inherited from CParameter
void	sigChanged ()
	emit when the parameter changes Usually if required, the corresponding parameter corresponds to a change event.

Public Member Functions
	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)
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)
Public Member Functions inherited from 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 ()
	Check whether the parameter is valid to decide whether to use or save the parameter.

Protected Slots
virtual void	slotSetGlobalParameters ()
	Call after set CParameterPlugin.

Protected Member Functions
QByteArray	PasswordSum (const std::string &password, const std::string &key)
virtual int	OnLoad (QSettings &set) override
virtual int	OnSave (QSettings &set) override
Protected Member Functions inherited from CParameter
virtual bool	OnCheckValidity ()
	Check validity.
int	SetModified (bool bModified=true)
	When setting parameters, if there is a modification, it is called.
bool	GetModified ()
	Whether the parameters have been modified.

Private Attributes
CParameterOperate *	m_Parent
CParameterPlugin *	m_pParameterPlugin
QString	m_szName

Additional Inherited Members
Properties inherited from CParameter
bool	Modified

Detailed Description

Operational parameter interface.

Valid only within the plugin.

Note

• The interface only is implemented and used by plugin.
• The application cannot access it directly, it can only be set via COperate::OpenDialogSettings.
• The plugin can access via COperateDesktop::GetParameter(), COperateTerminal::GetParameter() etc
• Need access the global parameters (CParameterPlugin), must be derived from the class. Access the global parameters (CParameterPlugin) via CParameterOperate::GetGlobalParameters()
• Use connecter parameter

Set and get global parameters. Parameters that need to manipulate global parameters should be derived from this class.

Use CParameterPlugin

Set CParameterPlugin for CParameterOperate

• If the parameters of operate(CParameterOperate or it's derived class) requires a CParameterPlugin.
  • Please instantiate the parameters of operate in the constructor of the COperate or it's derived class. ag:

        CParameterFreeRDP m_ParameterFreeRdp;

  • Call COperateDesktop::SetParameter to set the parameters. ag:

    int COperateFreeRDP::Initial()
    {
        qDebug(log) << Q_FUNC_INFO;
        int nRet = 0;
        nRet = COperateDesktop::Initial();
        if(nRet) return nRet;
        nRet = SetParameter(&m_ParameterFreeRdp);
        return nRet;
    }

  • Default set the CParameterPlugin for the parameters of operate. See: 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;
    }

  • If you are sure to the parameter does not need CParameterPlugin. please overload the COperate::SetGlobalParameters in the COperate derived class, don't set it.

Use CParameterPlugin in CParameterOperate

• Use CParameterOperate::GetGlobalParameters() get CParameterPlugin in the parameters of operate(CParameterOperate or it's derived class)
• The parameters of operate(CParameterOperate or it's derived class) use the value of CParameterPlugin as its initial value.
  Please override CParameterOperate::slotSetGlobalParameters and initialize the relevant values in it.
  For example, Whether to save the password with the member value of CParameterPlugin as its initialization value.

  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 category

Because there may be many parameters, it is necessary to classify them by parameter category. Each category can derive a separate class from this class. Each category is then used as a member variable in the derived classes of this class.

For example:
Operate parameters include the following categories:

• Base

  class CParameterBase : public CParameterOperate

• User

  class CParameterUser : public CParameterOperate

• Video

  class CParameterVideo : public CParameter

• Audio

  class CParameterAudio : public CParameter

CParameterBase, CParameterUser need global parameters, so that it must derived from CParameterOperate. other is derived from CParameter.

Then the operate parameters can be a combination of the above categories:

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)
{}

Note

• The connect parameter must be derived from CParameterOperate
• The operate parameters that require global parameters must be derived from CParameterOperate, otherwise they can be derived from CParameter
• When a member is instantiated, the constructor must set the parent to the instance of CParameterOperate(this).
• Set CParameterPlugin for CParameterOperate

See also

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

Definition at line 209 of file ParameterOperate.h.

Member Function Documentation

GetGlobalParameters()

CParameterPlugin * CParameterOperate::GetGlobalParameters

(

)

Get CParameterPlugin.

Definition at line 32 of file ParameterOperate.cpp.

GetName()

const QString CParameterOperate::GetName

(

)

const

Definition at line 177 of file ParameterOperate.cpp.

LoadPassword()

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

Definition at line 81 of file ParameterOperate.cpp.

OnLoad()

int CParameterOperate::OnLoad ( QSettings &  set )

overrideprotectedvirtual

Implements CParameter.

Reimplemented in CParameterWakeOnLan, and CParameterNet.

Definition at line 191 of file ParameterOperate.cpp.

OnSave()

int CParameterOperate::OnSave ( QSettings &  set )

overrideprotectedvirtual

Implements CParameter.

Definition at line 197 of file ParameterOperate.cpp.

PasswordSum()

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

protected

Definition at line 51 of file ParameterOperate.cpp.

SavePassword()

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

Definition at line 131 of file ParameterOperate.cpp.

SetGlobalParameters()

int CParameterOperate::SetGlobalParameters

(

CParameterPlugin *

p

)

Definition at line 38 of file ParameterOperate.cpp.

SetName()

void CParameterOperate::SetName

(

const QString &

szName

)

Definition at line 182 of file ParameterOperate.cpp.

sigSetGlobalParameters

void CParameterOperate::sigSetGlobalParameters ( )

signal

Only used by this class.

See also

slotSetGlobalParameters

slotSetGlobalParameters

void CParameterOperate::slotSetGlobalParameters ( )

protectedvirtualslot

Call after set CParameterPlugin.

Used to initialize operations related to CParameterPlugin.

Use CParameterPlugin in CParameterOperate

Reimplemented in CParameterBase.

Definition at line 46 of file ParameterOperate.cpp.

Member Data Documentation

m_Parent

CParameterOperate* CParameterOperate::m_Parent

private

Definition at line 257 of file ParameterOperate.h.

m_pParameterPlugin

CParameterPlugin* CParameterOperate::m_pParameterPlugin

private

See also

CManager::CreateConnecter COperate::SetGlobalParameters

Definition at line 261 of file ParameterOperate.h.

m_szName

QString CParameterOperate::m_szName

private

Definition at line 263 of file ParameterOperate.h.

---

The documentation for this class was generated from the following files:

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