操作接口。更多...

#include <Operate.h>

类 COperate 继承关系图:

[图例]

COperate 的协作图:

[图例]

Public 类型
enum class	SecurityLevel { No , Secure , NonSecureAuthentication , SecureChannel , Normal = SecureChannel , SecureAuthentication , Risky }

信号
void	sigRunning ()
	开始成功信号。仅由插件触发。

void	sigStop ()
	通知用户停止。仅由插件触发。当从插件中需要停止时触发。例如：对端断开连接、重置连接或者连接出错。当应用接收到此信号后，调用 Stop() 关闭连接。

void	sigFinished ()
	断开连接成功信号。仅由插件触发

void	sigViewerFocusIn (QWidget *pView)
	视图获得焦点

void	sigUpdateName (const QString &szName)

void	sigUpdateParameters (COperate *pOperate)
	更新参数，通知应用程序保存或显示参数

void	sigError (const int nError, const QString &szError)
	当有错误产生时触发。

void	sigInformation (const QString &szInfo)
	中主窗口中显示信息

void	sigShowMessageBox (const QString &title, const QString &message, const QMessageBox::Icon &icon=QMessageBox::Information)
	从后台线程中触发在主线程中显示消息对话框(QMessageBox)，不阻塞后台线程

void	sigClipBoardChanged ()

Public 成员函数
	COperate (CPlugin *plugin)

virtual QWidget *	GetViewer ()=0
	得到显示视图

virtual int	OpenDialogSettings (QWidget *parent=nullptr)
	打开设置对话框

virtual QMenu *	GetMenu (QWidget *parent=nullptr)
	Get menu

virtual CStats *	GetStats ()

virtual SecurityLevel	GetSecurityLevel ()

virtual QString	GetSecurityLevelString ()

virtual QColor	GetSecurityLevelColor ()

virtual int	Start ()=0
	开始

virtual int	Stop ()=0
	关闭

属性
virtual const QString	Id ()
	Identity

virtual const QString	Name ()
	Name

virtual const QString	Description ()
	Description

virtual const QString	Protocol () const
	Protocol

virtual const qint16	Version () const =0
	Version

virtual const QIcon	Icon () const
	Icon

virtual const QString	GetTypeName () const
	Get type name

静态 Public 成员函数
static QString	GetSecurityLevelString (SecurityLevel level)

static QColor	GetSecurityLevelColor (SecurityLevel level)

Protected 成员函数
virtual Q_INVOKABLE int	Initial ()
	Initial parameters and resource

virtual Q_INVOKABLE int	Clean ()
	Clean parameters and resource

virtual Q_INVOKABLE int	SetGlobalParameters (CParameterPlugin *pPara)=0
	应用插件全局参数

Q_INVOKABLE CPlugin *	GetPlugin () const
	Get plugin

静态 Protected 成员函数
static QObject *	createObject (const QString &className, QObject *parent=NULL)

Protected 属性
QMenu	m_Menu

QAction *	m_pActionSettings

Private 槽
void	slotUpdateName ()

virtual void	slotBlockShowWidget (const QString &className, int &nRet, void *pContext)
	阻塞后台线程，并在前台线程中显示窗口。

virtual void	slotBlockShowMessageBox (const QString &szTitle, const QString &szMessage, QMessageBox::StandardButtons buttons, QMessageBox::StandardButton &nRet, bool &checkBox, QString szCheckBoxContext=QString())
	阻塞后台线程，并在前台线程中显示消息对话框(QMessageBox)

virtual void	slotBlockInputDialog (const QString &szTitle, const QString &szLable, const QString &szMessage, QString &szText)
	Block background threads and display input dialogs in foreground threads (QInputDialog)

virtual void	slotSetClipboard (QMimeData *data)

virtual void	slotSettings ()

Private 成员函数
virtual QDialog *	OnOpenDialogSettings (QWidget *parent=nullptr)=0
	得到设置对话框

Private 属性
CPlugin *	m_pPlugin

加载和保存参数
QString	m_szSettings

virtual QString	GetSettingsFile ()

virtual int	SetSettingsFile (const QString &szFile)

virtual int	Load (QSettings &set)
	加载参数

virtual int	Save (QSettings &set)
	保存参数

virtual Q_INVOKABLE int	Load (QString szFile=QString())
	从文件中加载参数

virtual Q_INVOKABLE int	Save (QString szFile=QString())
	保存参数到文件中

详细描述

操作接口。

注解

此接口仅由是用户使用。它由插件实现。
它的实例在主线程（界面线程）中。

类图：

序列图：

已经提供以下类型的基本实现：

远程桌面类： COperateDesktop
工具类：
- 非阻塞模型（在主线程）： COperateWakeOnLan
控制台类： COperateTerminal
文件传输： COperateFileTransfer
服务类： COperateService

参见: CPlugin

在文件 Operate.h 第 50 行定义.

成员枚举类型说明

◆ SecurityLevel

enum class COperate::SecurityLevel

strong

在文件 Operate.h 第 119 行定义.

构造及析构函数说明

◆ ~COperate()

COperate::~COperate ( )

virtual

在文件 Operate.cpp 第 28 行定义.

成员函数说明

◆ Clean()

int COperate::Clean ( )

protectedvirtual

Clean parameters and resource

参见: CManager::DeleteOperate

被 COperateFileTransfer, COperateFreeRDP, COperateLibVNCServer, COperatePlayer, CScreenCapture, COperateSSH, COperateVnc, COperateWakeOnLan, COperateDesktop , 以及 COperateTerminal 重载.

在文件 Operate.cpp 第 247 行定义.

◆ createObject()

QObject * COperate::createObject	(	const QString &	className,
		QObject *	parent = `NULL`
	)

staticprotected

在文件 Operate.cpp 第 284 行定义.

◆ Description()

const QString COperate::Description ( )

virtual

Description

被 COperateFileTransfer, COperateRawStream, COperateSerialPort, COperateSSH, COperateTelnet, CTerminal, COperateDesktop , 以及 COperateTerminal 重载.

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

◆ GetMenu()

QMenu * COperate::GetMenu ( QWidget * parent = nullptr )

virtual

Get menu

在文件 Operate.cpp 第 107 行定义.

◆ GetPlugin()

CPlugin * COperate::GetPlugin ( ) const

protected

Get plugin

参见: CManager::DeleteOperate

在文件 Operate.cpp 第 259 行定义.

◆ GetSecurityLevel()

COperate::SecurityLevel COperate::GetSecurityLevel ( )

virtual

在文件 Operate.cpp 第 119 行定义.

◆ GetSecurityLevelColor() [1/2]

QColor COperate::GetSecurityLevelColor ( )

virtual

在文件 Operate.cpp 第 150 行定义.

◆ GetSecurityLevelColor() [2/2]

QColor COperate::GetSecurityLevelColor ( SecurityLevel level )

static

在文件 Operate.cpp 第 155 行定义.

◆ GetSecurityLevelString() [1/2]

QString COperate::GetSecurityLevelString ( )

virtual

在文件 Operate.cpp 第 124 行定义.

◆ GetSecurityLevelString() [2/2]

QString COperate::GetSecurityLevelString ( SecurityLevel level )

static

在文件 Operate.cpp 第 129 行定义.

◆ GetSettingsFile()

QString COperate::GetSettingsFile ( )

virtual

在文件 Operate.cpp 第 174 行定义.

◆ GetStats()

CStats * COperate::GetStats ( )

virtual

在文件 Operate.cpp 第 114 行定义.

◆ GetTypeName()

const QString COperate::GetTypeName ( ) const

virtual

Get type name

在文件 Operate.cpp 第 76 行定义.

◆ GetViewer()

virtual QWidget * COperate::GetViewer ( )

pure virtual

得到显示视图

返回: QWidget*: 视图指针。它的所有者是本类或其派生类的实例

注解: 如果自己实现视图，则需要在开始时禁用视图，在　sigRunning　后允许视图。

参见: sigRunning CFrmViewer::CFrmViewer

在 COperateFileTransfer, CScreenCapture, COperateWakeOnLan, COperateDesktop , 以及 COperateTerminal 内被实现.

◆ Icon()

const QIcon COperate::Icon ( ) const

virtual

Icon

在文件 Operate.cpp 第 82 行定义.

◆ Id()

const QString COperate::Id ( )

virtual

Identity

被 COperateFileTransfer, COperateRawStream, COperateSSH, COperateTelnet, COperateVnc, COperateWakeOnLan, COperateDesktop , 以及 COperateTerminal 重载.

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

◆ Initial()

int COperate::Initial ( )

protectedvirtual

Initial parameters and resource

参见: CManager::CreateOperate

被 COperateFileTransfer, COperateFreeRDP, COperateLibVNCServer, COperatePlayer, CScreenCapture, COperateSSH, CTerminal, COperateVnc, COperateWakeOnLan, COperateDesktop , 以及 COperateTerminal 重载.

在文件 Operate.cpp 第 230 行定义.

◆ Load() [1/2]

int COperate::Load ( QSettings & set )

protectedvirtual

加载参数

被 COperateFileTransfer, COperateWakeOnLan, COperateDesktop , 以及 COperateTerminal 重载.

在文件 Operate.cpp 第 216 行定义.

◆ Load() [2/2]

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

protectedvirtual

从文件中加载参数

参见: CManger::LoadOperate

在文件 Operate.cpp 第 192 行定义.

◆ Name()

const QString COperate::Name ( )

virtual

Name

被 COperateFileTransfer, COperateRawStream, COperateSerialPort, COperateSSH, COperateTelnet, CTerminal, COperateWakeOnLan, COperateDesktop , 以及 COperateTerminal 重载.

在文件 Operate.cpp 第 41 行定义.

◆ OnOpenDialogSettings()

virtual QDialog * COperate::OnOpenDialogSettings ( QWidget * parent = nullptr )

privatepure virtual

得到设置对话框

参数

parent 返回窗口的父窗口

返回: QDialog*: 对话框必须在堆内存中分配，它的所有者是调用者。

参见: OpenDialogSettings

在 COperateFileTransfer, COperateFreeRDP, COperateLibVNCServer, COperatePlayer, COperateRawStream, CScreenCapture, COperateSerialPort, COperateSSH, COperateTelnet, CTerminal, COperateWakeOnLan , 以及 COperateVnc 内被实现.

◆ OpenDialogSettings()

int COperate::OpenDialogSettings ( QWidget * parent = nullptr )

virtual

打开设置对话框

参数

parent

返回

DialogCode

QDialog::Accepted: 接收
QDialog::Rejected: 拒绝
-1: 错误

在文件 Operate.cpp 第 87 行定义.

◆ Protocol()

const QString COperate::Protocol ( ) const

virtual

Protocol

被 COperateFileTransfer 重载.

在文件 Operate.cpp 第 71 行定义.

◆ Save() [1/2]

int COperate::Save ( QSettings & set )

protectedvirtual

保存参数

被 COperateFileTransfer, COperateWakeOnLan, COperateDesktop , 以及 COperateTerminal 重载.

在文件 Operate.cpp 第 223 行定义.

◆ Save() [2/2]

int COperate::Save ( QString szFile = QString() )

protectedvirtual

保存参数到文件中

参数

szFile 文件名。

参见: CManger::SaveOperate

在文件 Operate.cpp 第 204 行定义.

◆ SetGlobalParameters()

int COperate::SetGlobalParameters ( CParameterPlugin * pPara )

protectedpure virtual

应用插件全局参数

注解: 如果不需要插件的全局参数，请在派生类中重载它，并忽略。

在 COperateFileTransfer, CScreenCapture, COperateWakeOnLan, COperateDesktop , 以及 COperateTerminal 内被实现.

在文件 Operate.cpp 第 264 行定义.

◆ SetSettingsFile()

int COperate::SetSettingsFile ( const QString & szFile )

virtual

在文件 Operate.cpp 第 186 行定义.

◆ sigFinished

void COperate::sigFinished ( )

signal

断开连接成功信号。仅由插件触发

参见: Disconnect()

◆ sigInformation

void COperate::sigInformation ( const QString & szInfo )

signal

中主窗口中显示信息

注解: 它与 sigShowMessageBox 的区别是 sigShowMessageBox 用对话框显示

参见: sigShowMessageBox MainWindow::slotInformation()

◆ sigRunning

void COperate::sigRunning ( )

signal

开始成功信号。仅由插件触发。

应用程序需要在此时设置视图属性 Enabled 为 true 。允许接收键盘和鼠标事件。
如果插件自己实现视图（非　CFrmView），设置视图属性 Enabled 为 true 。允许接收键盘和鼠标事件。

参见: MainWindow::slotRunning() GetViewer() CFrmViewer::CFrmViewer

◆ sigShowMessageBox

void COperate::sigShowMessageBox	(	const QString &	title,
		const QString &	message,
		const QMessageBox::Icon &	icon = `QMessageBox::Information`
	)

signal

从后台线程中触发在主线程中显示消息对话框(QMessageBox)，不阻塞后台线程

注解: 它与 sigInformation 区别是，sigInformation 不用对话框显示

参见: sigInformation Connect::SetConnecter MainWindow::slotShowMessageBox

◆ sigUpdateName

void COperate::sigUpdateName ( const QString & szName )

signal

注解: 名称更新。此信号仅由本类触发

◆ sigUpdateParameters

void COperate::sigUpdateParameters ( COperate * pOperate )

signal

更新参数，通知应用程序保存或显示参数

注解: 插件不要直接使用它，请用 CParameter::sigChanged 触发此信号

参见: COperateDesktop::SetParameter

◆ slotBlockInputDialog

void COperate::slotBlockInputDialog	(	const QString &	szTitle,
		const QString &	szLable,
		const QString &	szMessage,
		QString &	szText
	)

privatevirtualslot

Block background threads and display input dialogs in foreground threads (QInputDialog)

参见: CConnecter::sigBlockInputDialog() SetConnecter

在文件 Operate.cpp 第 374 行定义.

◆ slotBlockShowMessageBox

void COperate::slotBlockShowMessageBox	(	const QString &	szTitle,
		const QString &	szMessage,
		QMessageBox::StandardButtons	buttons,
		QMessageBox::StandardButton &	nRet,
		bool &	checkBox,
		QString	szCheckBoxContext = `QString()`
	)

privatevirtualslot

阻塞后台线程，并在前台线程中显示消息对话框(QMessageBox)

参见: CConnect::sigBlockShowMessageBox

在文件 Operate.cpp 第 353 行定义.

◆ slotBlockShowWidget

void COperate::slotBlockShowWidget	(	const QString &	className,
		int &	nRet,
		void *	pContext
	)

privatevirtualslot

阻塞后台线程，并在前台线程中显示窗口。

参见: CConnect::sigBlockShowWidget()

在文件 Operate.cpp 第 314 行定义.

◆ slotSetClipboard

void COperate::slotSetClipboard ( QMimeData * data )

privatevirtualslot

注解: 仅由 CBackendDesktop::SetConnect() 使用

在文件 Operate.cpp 第 389 行定义.

◆ slotSettings

void COperate::slotSettings ( )

privatevirtualslot

在文件 Operate.cpp 第 252 行定义.

◆ slotUpdateName

void COperate::slotUpdateName ( )

privateslot

在文件 Operate.cpp 第 279 行定义.

◆ Start()

virtual int COperate::Start ( )

pure virtual

开始

注解: 仅由用户调用，插件不能直接调用此函数。插件开始成功后，触发信号 sigRunning()

参见: sigRunning()

在 COperateFileTransfer 内被实现.

◆ Stop()

virtual int COperate::Stop ( )

pure virtual

关闭

注解: 仅由用户调用，插件不能直接调用此函数。插件停止成功后，触发信号 sigFinished()。调用者收到信号后，删除对象

参见: sigFinished()

在 COperateFileTransfer 内被实现.

◆ Version()

virtual const qint16 COperate::Version ( ) const

pure virtual

Version

在 COperateFileTransfer, COperateFreeRDP, COperateLibVNCServer, COperatePlayer, CScreenCapture, COperateVnc, COperateWakeOnLan, COperateDesktop , 以及 COperateTerminal 内被实现.

类成员变量说明

◆ m_Menu

QMenu COperate::m_Menu

protected

在文件 Operate.h 第 412 行定义.

◆ m_pActionSettings

QAction* COperate::m_pActionSettings

protected

在文件 Operate.h 第 413 行定义.

◆ m_pPlugin

CPlugin* COperate::m_pPlugin

private

在文件 Operate.h 第 418 行定义.

◆ m_szSettings

QString COperate::m_szSettings

private

在文件 Operate.h 第 326 行定义.

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

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

Public 类型

信号

Public 成员函数

静态 Public 成员函数

Protected 成员函数

静态 Protected 成员函数

Protected 属性

Private 槽

Private 成员函数

Private 属性

加载和保存参数

详细描述

成员枚举类型说明

◆ SecurityLevel

构造及析构函数说明

◆ ~COperate()

成员函数说明

◆ Clean()

◆ createObject()

◆ Description()

◆ GetMenu()

◆ GetPlugin()

◆ GetSecurityLevel()

◆ GetSecurityLevelColor() [1/2]

◆ GetSecurityLevelColor() [2/2]

◆ GetSecurityLevelString() [1/2]

◆ GetSecurityLevelString() [2/2]

◆ GetSettingsFile()

◆ GetStats()

◆ GetTypeName()

◆ GetViewer()

◆ Icon()

◆ Id()

◆ Initial()

◆ Load() [1/2]

◆ Load() [2/2]

◆ Name()

◆ OnOpenDialogSettings()

◆ OpenDialogSettings()

◆ Protocol()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetGlobalParameters()

◆ SetSettingsFile()

◆ sigFinished

◆ sigInformation

◆ sigRunning

◆ sigShowMessageBox

◆ sigUpdateName

◆ sigUpdateParameters

◆ slotBlockInputDialog

◆ slotBlockShowMessageBox

◆ slotBlockShowWidget

◆ slotSetClipboard

◆ slotSettings

◆ slotUpdateName

◆ Start()

◆ Stop()

◆ Version()

类成员变量说明

◆ m_Menu

◆ m_pActionSettings

◆ m_pPlugin

◆ m_szSettings