Global parameters of plugins. More...

#include <ParameterPlugin.h>

Inheritance diagram for CParameterPlugin:

[legend]

Collaboration diagram for CParameterPlugin:

[legend]

Public Types
enum class	PromptType { No , First }
enum class	NameStyle { Protocol = 0x01 , ServerName = 0x02 , SecurityLevel =0x04 }

Signals
void	sigCaptureAllKeyboard ()
void	sigPromptAdministratorPrivilege ()
void	sigEncryptKeyChanged ()
void	sigSavePasswordChanged (bool AutoSavePassword)
void	sigPromptTypeChanged (PromptType PromptType)
void	sigPromptCountChanged (int PromptCount)
void	sigViewPassowrdChanged (bool ViewPassowrd)
void	sigNameStylesChanged ()
void	sigAdaptWindowsChanged ()
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
	CParameterPlugin (QObject *parent=nullptr)
CParameterGlobal *	GetGlobalParameters ()
	Get global parameters.
bool	GetCaptureAllKeyboard () const
void	SetCaptureAllKeyboard (bool bCapture)
bool	GetDesktopShortcutsScript () const
void	SetDesktopShortcutsScript (bool newDesktopShortcutsScript)
QString	GetDisableDesktopShortcutsScript () const
void	SetDisableDesktopShortcutsScript (const QString &newDisableDesktopShortcutsScript)
QString	GetRestoreDesktopShortcutsScript () const
void	SetRestoreDesktopShortcutsScript (const QString &newRestoreDesktopShortcutsScript)
bool	GetEnableLocalInputMethod () const
void	SetEnableLocalInputMethod (bool enable)
bool	GetPromptAdministratorPrivilege ()
void	SetPromptAdministratorPrivilege (bool bShow)
bool	GetEnableSystemUserToUser () const
void	SetEnableSystemUserToUser (bool enable)
const QString &	GetEncryptKey () const
void	SetEncryptKey (const QString &newPassword)
const bool &	GetSavePassword () const
void	SetSavePassword (bool NewAutoSavePassword)
PromptType	GetPromptType () const
void	SetPromptType (PromptType NewPromptType)
int	GetPromptCount () const
void	SetPromptCount (int NewPromptCount)
bool	GetViewPassowrd () const
void	SetViewPassowrd (bool NewViewPassowrd)
bool	GetUseSystemCredential () const
void	SetUseSystemCredential (bool newUseSystemCredential)
	Q_FLAG (NameStyles)
NameStyles	GetNameStyles () const
void	SetNameStyles (const NameStyles &newNameStyles)
CFrmViewer::ADAPT_WINDOWS	GetAdaptWindows ()
void	SetAdaptWindows (CFrmViewer::ADAPT_WINDOWS aw)
bool	GetEnableSetPluginsPath () const
void	SetEnableSetPluginsPath (bool newEnableSetPluginsPath)
QStringList	GetPluginsPath () const
void	SetPluginsPath (const QStringList &newPluginsPath)
bool	GetOnlyLoadInWhitelist () const
void	SetOnlyLoadInWhitelist (bool newOnlyLoadInWhitelist)
Public Member Functions inherited from CParameter
	CParameter (QObject *parent, 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.

Public Attributes
CParameterFilter	m_WhiteList
CParameterFilter	m_BlackList
Initial values for plugin parameters
CParameterRecord	m_Record
CParameterMediaDevices	m_MediaDevices

Protected Member Functions
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.

Properties
QString	EncryptKey
bool	SavePassword
PromptType	PromptType
int	PromptCount
bool	ViewPassowrd
CFrmViewer::ADAPT_WINDOWS	AdaptWindows
Properties inherited from CParameter
bool	Modified

Private Attributes
CParameterGlobal *	m_pGlobalParameter
bool	m_bCaptureAllKeyboard
bool	m_bDesktopShortcutsScript
QString	m_szDisableDesktopShortcutsScript
QString	m_szRestoreDesktopShortcutsScript
bool	m_bEnableLocalInputMethod
bool	m_bPromptAdministratorPrivilege
bool	m_bEnableSystemUserToUser
QString	m_szEncryptKey
bool	m_bSavePassword
PromptType	m_PromptType
int	m_nPromptCount
bool	m_bViewPassowrd
bool	m_bUseSystemCredential
NameStyles	m_NameStyles
CFrmViewer::ADAPT_WINDOWS	m_AdaptWindows
bool	m_bEnableSetPluginsPath
QStringList	m_szPluginsPath
bool	m_bOnlyLoadInWhitelist

Detailed Description

Global parameters of plugins.

The parameters is valid in the CManager and plugin.
The application cannot access it, but the application can be set it via CManager::GetSettingsWidgets() .
The plugin can be accessed via CParameterOperate::GetPluginParameters().

See also: COperate::SetPluginParameters CParameterGlobal

Definition at line 35 of file ParameterPlugin.h.

Member Enumeration Documentation

◆ NameStyle

enum class CParameterPlugin::NameStyle

strong

Definition at line 168 of file ParameterPlugin.h.

◆ PromptType

enum class CParameterPlugin::PromptType

strong

Definition at line 128 of file ParameterPlugin.h.

Constructor & Destructor Documentation

◆ CParameterPlugin()

CParameterPlugin::CParameterPlugin ( QObject * parent = nullptr )

explicit

Definition at line 9 of file ParameterPlugin.cpp.

◆ ~CParameterPlugin()

CParameterPlugin::~CParameterPlugin ( )

virtual

Definition at line 36 of file ParameterPlugin.cpp.

Member Function Documentation

◆ GetAdaptWindows()

CFrmViewer::ADAPT_WINDOWS CParameterPlugin::GetAdaptWindows ( )

Definition at line 309 of file ParameterPlugin.cpp.

◆ GetCaptureAllKeyboard()

bool CParameterPlugin::GetCaptureAllKeyboard ( ) const

Definition at line 119 of file ParameterPlugin.cpp.

◆ GetDesktopShortcutsScript()

bool CParameterPlugin::GetDesktopShortcutsScript ( ) const

Definition at line 133 of file ParameterPlugin.cpp.

◆ GetDisableDesktopShortcutsScript()

QString CParameterPlugin::GetDisableDesktopShortcutsScript ( ) const

Definition at line 159 of file ParameterPlugin.cpp.

◆ GetEnableLocalInputMethod()

bool CParameterPlugin::GetEnableLocalInputMethod ( ) const

Definition at line 172 of file ParameterPlugin.cpp.

◆ GetEnableSetPluginsPath()

bool CParameterPlugin::GetEnableSetPluginsPath ( ) const

Definition at line 323 of file ParameterPlugin.cpp.

◆ GetEnableSystemUserToUser()

bool CParameterPlugin::GetEnableSystemUserToUser ( ) const

Definition at line 199 of file ParameterPlugin.cpp.

◆ GetEncryptKey()

const QString & CParameterPlugin::GetEncryptKey ( ) const

Definition at line 212 of file ParameterPlugin.cpp.

◆ GetGlobalParameters()

CParameterGlobal * CParameterPlugin::GetGlobalParameters ( )

Get global parameters.

The global parameters is valid in both the application and the Client and the plugin.

Definition at line 44 of file ParameterPlugin.cpp.

◆ GetNameStyles()

CParameterPlugin::NameStyles CParameterPlugin::GetNameStyles ( ) const

Definition at line 295 of file ParameterPlugin.cpp.

◆ GetOnlyLoadInWhitelist()

bool CParameterPlugin::GetOnlyLoadInWhitelist ( ) const

Definition at line 346 of file ParameterPlugin.cpp.

◆ GetPluginsPath()

QStringList CParameterPlugin::GetPluginsPath ( ) const

Definition at line 336 of file ParameterPlugin.cpp.

◆ GetPromptAdministratorPrivilege()

bool CParameterPlugin::GetPromptAdministratorPrivilege ( )

Definition at line 185 of file ParameterPlugin.cpp.

◆ GetPromptCount()

int CParameterPlugin::GetPromptCount ( ) const

Definition at line 254 of file ParameterPlugin.cpp.

◆ GetPromptType()

CParameterPlugin::PromptType CParameterPlugin::GetPromptType ( ) const

Definition at line 240 of file ParameterPlugin.cpp.

◆ GetRestoreDesktopShortcutsScript()

QString CParameterPlugin::GetRestoreDesktopShortcutsScript ( ) const

Definition at line 146 of file ParameterPlugin.cpp.

◆ GetSavePassword()

const bool & CParameterPlugin::GetSavePassword ( ) const

Definition at line 226 of file ParameterPlugin.cpp.

◆ GetUseSystemCredential()

bool CParameterPlugin::GetUseSystemCredential ( ) const

Definition at line 282 of file ParameterPlugin.cpp.

◆ GetViewPassowrd()

bool CParameterPlugin::GetViewPassowrd ( ) const

Definition at line 268 of file ParameterPlugin.cpp.

◆ OnLoad()

int CParameterPlugin::OnLoad ( QSettings & set )

overrideprotectedvirtual

See also: CClient::LoadSettings

Implements CParameter.

Definition at line 49 of file ParameterPlugin.cpp.

◆ OnSave()

int CParameterPlugin::OnSave ( QSettings & set )

overrideprotectedvirtual

See also: CClient::SaveSettings

Implements CParameter.

Definition at line 94 of file ParameterPlugin.cpp.

◆ SetAdaptWindows()

void CParameterPlugin::SetAdaptWindows ( CFrmViewer::ADAPT_WINDOWS aw )

Definition at line 314 of file ParameterPlugin.cpp.

◆ SetCaptureAllKeyboard()

void CParameterPlugin::SetCaptureAllKeyboard ( bool bCapture )

Definition at line 124 of file ParameterPlugin.cpp.

◆ SetDesktopShortcutsScript()

void CParameterPlugin::SetDesktopShortcutsScript ( bool newDesktopShortcutsScript )

Definition at line 138 of file ParameterPlugin.cpp.

◆ SetDisableDesktopShortcutsScript()

void CParameterPlugin::SetDisableDesktopShortcutsScript ( const QString & newDisableDesktopShortcutsScript )

Definition at line 164 of file ParameterPlugin.cpp.

◆ SetEnableLocalInputMethod()

void CParameterPlugin::SetEnableLocalInputMethod ( bool enable )

Definition at line 177 of file ParameterPlugin.cpp.

◆ SetEnableSetPluginsPath()

void CParameterPlugin::SetEnableSetPluginsPath ( bool newEnableSetPluginsPath )

Definition at line 328 of file ParameterPlugin.cpp.

◆ SetEnableSystemUserToUser()

void CParameterPlugin::SetEnableSystemUserToUser ( bool enable )

Definition at line 204 of file ParameterPlugin.cpp.

◆ SetEncryptKey()

void CParameterPlugin::SetEncryptKey ( const QString & newPassword )

Definition at line 217 of file ParameterPlugin.cpp.

◆ SetNameStyles()

void CParameterPlugin::SetNameStyles ( const NameStyles & newNameStyles )

Definition at line 300 of file ParameterPlugin.cpp.

◆ SetOnlyLoadInWhitelist()

void CParameterPlugin::SetOnlyLoadInWhitelist ( bool newOnlyLoadInWhitelist )

Definition at line 351 of file ParameterPlugin.cpp.

◆ SetPluginsPath()

void CParameterPlugin::SetPluginsPath ( const QStringList & newPluginsPath )

Definition at line 341 of file ParameterPlugin.cpp.

◆ SetPromptAdministratorPrivilege()

void CParameterPlugin::SetPromptAdministratorPrivilege ( bool bShow )

Definition at line 190 of file ParameterPlugin.cpp.

◆ SetPromptCount()

void CParameterPlugin::SetPromptCount ( int NewPromptCount )

Definition at line 259 of file ParameterPlugin.cpp.

◆ SetPromptType()

void CParameterPlugin::SetPromptType ( PromptType NewPromptType )

Definition at line 245 of file ParameterPlugin.cpp.

◆ SetRestoreDesktopShortcutsScript()

void CParameterPlugin::SetRestoreDesktopShortcutsScript ( const QString & newRestoreDesktopShortcutsScript )

Definition at line 151 of file ParameterPlugin.cpp.

◆ SetSavePassword()

void CParameterPlugin::SetSavePassword ( bool NewAutoSavePassword )

Definition at line 231 of file ParameterPlugin.cpp.

◆ SetUseSystemCredential()

void CParameterPlugin::SetUseSystemCredential ( bool newUseSystemCredential )

Definition at line 287 of file ParameterPlugin.cpp.

◆ SetViewPassowrd()

void CParameterPlugin::SetViewPassowrd ( bool NewViewPassowrd )

Definition at line 273 of file ParameterPlugin.cpp.

Member Data Documentation

◆ m_AdaptWindows

CFrmViewer::ADAPT_WINDOWS CParameterPlugin::m_AdaptWindows

private

Definition at line 190 of file ParameterPlugin.h.

◆ m_bCaptureAllKeyboard

bool CParameterPlugin::m_bCaptureAllKeyboard

private

Definition at line 68 of file ParameterPlugin.h.

◆ m_bDesktopShortcutsScript

bool CParameterPlugin::m_bDesktopShortcutsScript

private

Definition at line 74 of file ParameterPlugin.h.

◆ m_bEnableLocalInputMethod

bool CParameterPlugin::m_bEnableLocalInputMethod

private

Definition at line 90 of file ParameterPlugin.h.

◆ m_bEnableSetPluginsPath

bool CParameterPlugin::m_bEnableSetPluginsPath

private

Definition at line 197 of file ParameterPlugin.h.

◆ m_bEnableSystemUserToUser

bool CParameterPlugin::m_bEnableSystemUserToUser

private

Definition at line 105 of file ParameterPlugin.h.

◆ m_BlackList

CParameterFilter CParameterPlugin::m_BlackList

Definition at line 205 of file ParameterPlugin.h.

◆ m_bOnlyLoadInWhitelist

bool CParameterPlugin::m_bOnlyLoadInWhitelist

private

Definition at line 208 of file ParameterPlugin.h.

◆ m_bPromptAdministratorPrivilege

bool CParameterPlugin::m_bPromptAdministratorPrivilege

private

Definition at line 98 of file ParameterPlugin.h.

◆ m_bSavePassword

bool CParameterPlugin::m_bSavePassword

private

Definition at line 124 of file ParameterPlugin.h.

◆ m_bUseSystemCredential

bool CParameterPlugin::m_bUseSystemCredential

private

Definition at line 164 of file ParameterPlugin.h.

◆ m_bViewPassowrd

bool CParameterPlugin::m_bViewPassowrd

private

Definition at line 157 of file ParameterPlugin.h.

◆ m_MediaDevices

CParameterMediaDevices CParameterPlugin::m_MediaDevices

Definition at line 215 of file ParameterPlugin.h.

◆ m_NameStyles

NameStyles CParameterPlugin::m_NameStyles

private

Definition at line 181 of file ParameterPlugin.h.

◆ m_nPromptCount

int CParameterPlugin::m_nPromptCount

private

Definition at line 148 of file ParameterPlugin.h.

◆ m_pGlobalParameter

CParameterGlobal* CParameterPlugin::m_pGlobalParameter

private

Definition at line 50 of file ParameterPlugin.h.

◆ m_PromptType

PromptType CParameterPlugin::m_PromptType

private

Definition at line 139 of file ParameterPlugin.h.

◆ m_Record

CParameterRecord CParameterPlugin::m_Record

Definition at line 214 of file ParameterPlugin.h.

◆ m_szDisableDesktopShortcutsScript

QString CParameterPlugin::m_szDisableDesktopShortcutsScript

private

Definition at line 79 of file ParameterPlugin.h.

◆ m_szEncryptKey

QString CParameterPlugin::m_szEncryptKey

private

Definition at line 114 of file ParameterPlugin.h.

◆ m_szPluginsPath

QStringList CParameterPlugin::m_szPluginsPath

private

Definition at line 207 of file ParameterPlugin.h.

◆ m_szRestoreDesktopShortcutsScript

QString CParameterPlugin::m_szRestoreDesktopShortcutsScript

private

Definition at line 84 of file ParameterPlugin.h.

◆ m_WhiteList

CParameterFilter CParameterPlugin::m_WhiteList

Definition at line 204 of file ParameterPlugin.h.

Property Documentation

◆ AdaptWindows

CFrmViewer::ADAPT_WINDOWS CParameterPlugin::AdaptWindows

readwrite

Definition at line 191 of file ParameterPlugin.h.

◆ EncryptKey

QString CParameterPlugin::EncryptKey

readwrite

Definition at line 115 of file ParameterPlugin.h.

◆ PromptCount

int CParameterPlugin::PromptCount

readwrite

Definition at line 149 of file ParameterPlugin.h.

◆ PromptType

PromptType CParameterPlugin::PromptType

readwrite

Definition at line 140 of file ParameterPlugin.h.

◆ SavePassword

bool CParameterPlugin::SavePassword

readwrite

Definition at line 125 of file ParameterPlugin.h.

◆ ViewPassowrd

bool CParameterPlugin::ViewPassowrd

readwrite

Definition at line 158 of file ParameterPlugin.h.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/ParameterCompone/ParameterPlugin.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/ParameterCompone/ParameterPlugin.cpp

Public Types

Signals

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ NameStyle

◆ PromptType

Constructor & Destructor Documentation

◆ CParameterPlugin()

◆ ~CParameterPlugin()

Member Function Documentation

◆ GetAdaptWindows()

◆ GetCaptureAllKeyboard()

◆ GetDesktopShortcutsScript()

◆ GetDisableDesktopShortcutsScript()

◆ GetEnableLocalInputMethod()

◆ GetEnableSetPluginsPath()

◆ GetEnableSystemUserToUser()

◆ GetEncryptKey()

◆ GetGlobalParameters()

◆ GetNameStyles()

◆ GetOnlyLoadInWhitelist()

◆ GetPluginsPath()

◆ GetPromptAdministratorPrivilege()

◆ GetPromptCount()

◆ GetPromptType()

◆ GetRestoreDesktopShortcutsScript()

◆ GetSavePassword()

◆ GetUseSystemCredential()

◆ GetViewPassowrd()

◆ OnLoad()

◆ OnSave()

◆ SetAdaptWindows()

◆ SetCaptureAllKeyboard()

◆ SetDesktopShortcutsScript()

◆ SetDisableDesktopShortcutsScript()

◆ SetEnableLocalInputMethod()

◆ SetEnableSetPluginsPath()

◆ SetEnableSystemUserToUser()

◆ SetEncryptKey()

◆ SetNameStyles()

◆ SetOnlyLoadInWhitelist()

◆ SetPluginsPath()

◆ SetPromptAdministratorPrivilege()

◆ SetPromptCount()

◆ SetPromptType()

◆ SetRestoreDesktopShortcutsScript()

◆ SetSavePassword()

◆ SetUseSystemCredential()

◆ SetViewPassowrd()

Member Data Documentation

◆ m_AdaptWindows

◆ m_bCaptureAllKeyboard

◆ m_bDesktopShortcutsScript

◆ m_bEnableLocalInputMethod

◆ m_bEnableSetPluginsPath

◆ m_bEnableSystemUserToUser

◆ m_BlackList

◆ m_bOnlyLoadInWhitelist

◆ m_bPromptAdministratorPrivilege

◆ m_bSavePassword

◆ m_bUseSystemCredential

◆ m_bViewPassowrd

◆ m_MediaDevices

◆ m_NameStyles

◆ m_nPromptCount

◆ m_pGlobalParameter

◆ m_PromptType

◆ m_Record

◆ m_szDisableDesktopShortcutsScript

◆ m_szEncryptKey

◆ m_szPluginsPath

◆ m_szRestoreDesktopShortcutsScript

◆ m_WhiteList

Property Documentation

◆ AdaptWindows