CParameterConnecter Class Reference

the parameters of connecter interface. More...

#include <ParameterConnecter.h>

Inheritance diagram for CParameterConnecter:

Signals
void	sigSetParameterClient ()
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
	CParameterConnecter (QObject *parent=nullptr, const QString &szPrefix=QString())
CParameterClient *	GetParameterClient ()
	Get CParameterClient.
int	SetParameterClient (CParameterClient *p)
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 storage.
virtual int	Save (QSettings &set, bool bForce=true)
	Save to storage.
virtual bool	CheckValidity ()
	Check whether the parameter is valid to decide whether to use or save the parameter.

Protected Slots
virtual void	slotSetParameterClient ()
	Call after set CParameterClient.

Protected Member Functions
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)
Protected Member Functions inherited from CParameter
virtual int	OnLoad (QSettings &set)=0
virtual int	OnSave (QSettings &set)=0
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
CParameterConnecter *	m_Parent
CParameterClient *	m_pParameterClient

Additional Inherited Members
Properties inherited from CParameter
bool	Modified

Detailed Description

the parameters of connecter interface.

It only valid in plugin.

Note

• The interface only is implemented and used by plugin.
• The application cannot access it directly, it can only be set via CConnecter::OpenDialogSettings.
• The plugin can access via CConnecterThread::GetParameter
• Need access the client parameters(CParameterClient), must be derived from the class. Access the client parameters(CParameterClient) via CParameterConnecter::GetParameterClient()
• Use connecter parameter

Use CParameterClient

Set CParameterClient for CParameterConnecter

• If the parameters of connecter(CParameterConnecter or it's derived class) requires a CParameterClient.
  • Please instantiate the parameters of connecter in the constructor of the CConnecter or it's derived class. ag:

        CParameterFreeRDP m_ParameterFreeRdp;

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

    CConnecterFreeRDP::CConnecterFreeRDP(CPluginClient *plugin)
        : CConnecterThread(plugin)
    {
        qDebug(log) << Q_FUNC_INFO;
        //WLog_SetLogLevel(WLog_GetRoot(), WLOG_TRACE);
     
        // 在 freerdp_client_context_free 中释放
        //m_ParameterFreeRdp.m_pSettings = freerdp_settings_new(0);
    }

  • Default set the CParameterClient for the parameters of connecter. See: CClient::CreateConnecter .

    CConnecter* CClient::CreateConnecter(const QString& id)
    {
        CConnecter* pConnecter = nullptr;
        auto it = m_Plugins.find(id);
        if(m_Plugins.end() != it)
        {
            bool bRet = 0;
            qDebug(log) << "CreateConnecter id:" << id;
            auto plugin = it.value();
            if(plugin) {
                //p = plugin->CreateConnecter(id);
                bRet = QMetaObject::invokeMethod(
                    plugin,
                    "CreateConnecter",
                    Qt::DirectConnection,
                    Q_RETURN_ARG(CConnecter*, pConnecter),
                    Q_ARG(QString, id),
                    Q_ARG(CParameterClient*, m_pParameterClient));
                if(!bRet) {
                    qCritical(log) << "Create CConnecter fail.";
                    return nullptr;
                }
            }
        }
        return pConnecter;
    }

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

Use CParameterClient in CParameterConnecter

• Use CParameterConnecter::GetParameterClient() get CParameterClient in the parameters of connecter(CParameterConnecter or it's derived class)
• The parameters of connecter(CParameterConnecter or it's derived class) use the value of CParameterClient as its initial value.
  Please override CParameterConnecter::slotSetParameterClient and initialize the relevant values in it.
  For example, Whether to save the password with the member value of CParameterClient as its initialization value.

  void CParameterUser::slotSetParameterClient()
  {
      if(!GetParameterClient()) {
          QString szErr = "The CParameterClient is null";
          qCritical(log) << szErr;
          Q_ASSERT_X(false, "CParameterUser", szErr.toStdString().c_str());
          return;
      }
   
      if(GetParameterClient())
      {
          if(GetParameterClient()->GetEnableSystemUserToUser())
              SetUser(RabbitCommon::CTools::GetCurrentUser());
          SetSavePassword(GetParameterClient()->GetSavePassword());
          SetSavePassphrase(GetParameterClient()->GetSavePassword());
      }
   
      return;
  }

  See also

  CParameterUser::OnLoad

CParameterConnecter 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:
Connection parameters include the following categories:

• Base

  class CParameterBase : public CParameterConnecter

• User

  class CParameterUser : public CParameterConnecter

• Video

  class CParameterVideo : public CParameter

• Audio

  class CParameterAudio : public CParameter

CParameterBase, CParameterUser need CFrmParameterClient, so that it must derived from CParameterConnecter. other is derived from CParameter.

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

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

Note

• The connect parameter must be derived from CParameterBase
• When a member is instantiated, the constructor must set the parent to the instance of CParameterConnecter(this).
• Set CParameterClient for CParameterConnecter

See also

CParameterBase CClient::CreateConnecter CConnecter::CConnecter CConnecter::SetParameterClient CConnecter::SetParameter CParameterClient CParameterConnecter::GetParameterClient

Definition at line 255 of file ParameterConnecter.h.

Member Function Documentation

GetParameterClient()

CParameterClient * CParameterConnecter::GetParameterClient

(

)

Get CParameterClient.

Definition at line 32 of file ParameterConnecter.cpp.

LoadPassword()

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

protected

Definition at line 73 of file ParameterConnecter.cpp.

PasswordSum()

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

protected

Definition at line 51 of file ParameterConnecter.cpp.

SavePassword()

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

protected

Definition at line 110 of file ParameterConnecter.cpp.

SetParameterClient()

int CParameterConnecter::SetParameterClient

(

CParameterClient *

p

)

Definition at line 38 of file ParameterConnecter.cpp.

slotSetParameterClient

void CParameterConnecter::slotSetParameterClient ( )

protectedvirtualslot

Call after set CParameterClient.

Used to initialize operations related to CParameterClient.

Use CParameterClient in CParameterConnecter

Reimplemented in CParameterBase.

Definition at line 46 of file ParameterConnecter.cpp.

Member Data Documentation

m_Parent

CParameterConnecter* CParameterConnecter::m_Parent

private

Definition at line 291 of file ParameterConnecter.h.

m_pParameterClient

CParameterClient* CParameterConnecter::m_pParameterClient

private

See also

CClient::CreateConnecter CConnecter::SetParameterClient

Definition at line 295 of file ParameterConnecter.h.

---

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

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