类 COperateFtpServer 继承关系图:

[图例]

COperateFtpServer 的协作图:

[图例]

Public 成员函数
	COperateFtpServer (CPlugin *plugin)

virtual const QString	Name () override
	名称

virtual const QString	Description () override
	描述

virtual const qint16	Version () const override
	版本

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

virtual int	Start () override
	开始

virtual int	Stop () override
	关闭

QSharedPointer< CParameterFtpServer >	GetParameter () const

Public 成员函数继承自 COperate
	COperate (CPlugin *plugin)

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

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

virtual const QString	Id ()
	标识

virtual const QString	Protocol () const
	协议

virtual const QIcon	Icon () const
	图标

virtual const QString	GetTypeName () const
	类型名

virtual QString	GetSettingsFile ()

virtual int	SetSettingsFile (const QString &szFile)

virtual CStats *	GetStats ()
	得到统计信息。如果有，其派生类则需要重载此函数提供统计信息。

virtual CSecurityLevel::Levels	GetSecurityLevel () const
	Get Security Level

Protected 成员函数
virtual Q_INVOKABLE CBackend *	InstanceBackend ()

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

virtual int	Initial () override
	Initial parameters and resource

virtual int	Clean () override
	Clean parameters and resource

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

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

Protected 成员函数继承自 COperate
Q_INVOKABLE CPlugin *	GetPlugin () const
	Get plugin

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

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

Private 槽
void	slotStart (bool checked)

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

Private 属性
CBackendThread *	m_pThread

QSharedPointer< CParameterFtpServer >	m_Para

CFrmMain *	m_pView

QAction *	m_pStart

友元
class	CFrmMain

额外继承的成员函数
信号继承自 COperate
void	sigViewerFocusIn (QWidget *pView)
	视图获得焦点

void	sigFullScreen (bool bFullScreen)
	全屏。由操作触发

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 ()

void	sigSecurityLevel ()
	当安全级别改变时触发。其派生类不要直接触发，需要使用 slotSetSecurityLevel 触发

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

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

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

Protected 槽继承自 COperate
void	slotUpdateName ()

void	slotSetSecurityLevel (CSecurityLevel::Levels level)

静态 Protected 成员函数继承自 COperate
static QObject *	createObject (const QString &className, QObject *parent=NULL)
	Create Object

Protected 属性继承自 COperate
QMenu	m_Menu

QAction *	m_pActionSettings

详细描述

在文件 OperateFtpServer.h 第 10 行定义.

构造及析构函数说明

◆ ~COperateFtpServer()

COperateFtpServer::~COperateFtpServer ( )

在文件 OperateFtpServer.cpp 第 21 行定义.

成员函数说明

◆ Clean()

int COperateFtpServer::Clean ( )

overrideprotectedvirtual

Clean parameters and resource

参见: CManager::DeleteOperate

重载 COperate .

在文件 OperateFtpServer.cpp 第 157 行定义.

◆ Description()

const QString COperateFtpServer::Description ( )

overridevirtual

描述

const QString COperateDesktop::Description()
{
    QString szDescription;
    if(!Name().isEmpty())
        szDescription = tr("Name: ") + Name() + "\n";
    
    if(!GetTypeName().isEmpty())
        szDescription += tr("Type: ") + GetTypeName() + "\n";
    
    if(!Protocol().isEmpty()) {
        szDescription += tr("Protocol: ") + Protocol();
#ifdef DEBUG
        if(!GetPlugin()->DisplayName().isEmpty())
            szDescription += " - " + GetPlugin()->DisplayName();
#endif
        szDescription += "\n";
    }
    
    if(!ServerName().isEmpty())
        szDescription += tr("Server name: ") + ServerName() + "\n";
    
    if(GetParameter()) {
        if(!GetParameter()->m_Net.GetHost().isEmpty())
            szDescription += tr("Server address: ") + GetParameter()->m_Net.GetHost() + ":"
                             + QString::number(GetParameter()->m_Net.GetPort()) + "\n";
        
        QString szProxy(tr("Proxy") + " ");
        auto &proxy = GetParameter()->m_Proxy;
        switch(proxy.GetUsedType()) {
        case CParameterProxy::TYPE::SSHTunnel:
        {
            auto &sshNet = proxy.m_SSH.m_Net;
            szProxy += "(" + tr("SSH tunnel") + "): " + sshNet.GetHost() + ":"
                       + QString::number(sshNet.GetPort());
            break;
        }
        case CParameterProxy::TYPE::SockesV5:
        {
            auto &sockesV5 = proxy.m_SockesV5;
            szProxy += "(" + tr("Sockes v5") + "): " + sockesV5.GetHost() + ":"
                       + QString::number(sockesV5.GetPort());
            break;
        }
        default:
            szProxy.clear();
            break;
        }
        
        if(!szProxy.isEmpty())
            szDescription += szProxy + "\n";
    }
 
    CSecurityLevel sl(GetSecurityLevel());
    if(!(GetSecurityLevel() & CSecurityLevel::Level::No)) {
        szDescription += tr("Security level: ");
        if(!sl.GetUnicodeIcon().isEmpty())
            szDescription += sl.GetUnicodeIcon() + " ";
        szDescription += sl.GetString() + "\n";
    }
 
    if(!GetPlugin()->Description().isEmpty())
        szDescription += tr("Description: ") + GetPlugin()->Description();
    
    return szDescription;
}

参见: COperateDesktop::Description()

重载 COperate .

在文件 OperateFtpServer.cpp 第 228 行定义.

◆ GetParameter()

QSharedPointer< CParameterFtpServer > COperateFtpServer::GetParameter ( ) const

在文件 OperateFtpServer.cpp 第 165 行定义.

◆ GetViewer()

QWidget * COperateFtpServer::GetViewer ( )

overridevirtual

得到显示视图

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

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

参见: sigRunning CFrmViewer::CFrmViewer

实现了 COperate.

在文件 OperateFtpServer.cpp 第 31 行定义.

◆ Initial()

int COperateFtpServer::Initial ( )

overrideprotectedvirtual

Initial parameters and resource

注解: Call before Load()

参见: CManager::CreateOperate Load

重载 COperate .

在文件 OperateFtpServer.cpp 第 123 行定义.

◆ InstanceBackend()

CBackend * COperateFtpServer::InstanceBackend ( )

protectedvirtual

在文件 OperateFtpServer.cpp 第 52 行定义.

◆ Load()

int COperateFtpServer::Load ( QSettings & set )

overrideprotectedvirtual

加载参数

实现了 COperate.

在文件 OperateFtpServer.cpp 第 109 行定义.

◆ Name()

const QString COperateFtpServer::Name ( )

overridevirtual

名称

const QString COperateDesktop::Name()
{
    QString szName;
    // Show the name of parameter
    if(GetParameter() && !(GetParameter()->GetName().isEmpty()))
        szName += GetParameter()->GetName();
    else {
        // Show the prefix of protocol
        if(GetParameter() && GetParameter()->GetGlobalParameters()
            && (GetParameter()->GetGlobalParameters()->GetNameStyles()
                & CParameterPlugin::NameStyle::Protocol)
            && !Protocol().isEmpty())
            szName = Protocol() + ":";
        // Show the server name
        szName += ServerName();
    }
 
    // Show the prefix of security level
    QString szSecurityLevel;
    CSecurityLevel sl(GetSecurityLevel());
    if((GetParameter()->GetGlobalParameters()->GetNameStyles()
         & CParameterPlugin::NameStyle::SecurityLevel)
        && !(GetSecurityLevel() & CSecurityLevel::Level::No)
        && !sl.GetUnicodeIcon().isEmpty())
        szSecurityLevel = sl.GetUnicodeIcon().left(2);
 
    return szSecurityLevel + szName;
}

参见: COperateDesktop::Name()

重载 COperate .

在文件 OperateFtpServer.cpp 第 205 行定义.

◆ OnOpenDialogSettings()

QDialog * COperateFtpServer::OnOpenDialogSettings ( QWidget * parent )

overrideprivatevirtual

得到设置对话框

参数

parent 返回窗口的父窗口

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

参见: OpenDialogSettings

实现了 COperate.

在文件 OperateFtpServer.cpp 第 103 行定义.

◆ Save()

int COperateFtpServer::Save ( QSettings & set )

overrideprotectedvirtual

保存参数

实现了 COperate.

在文件 OperateFtpServer.cpp 第 116 行定义.

◆ SetGlobalParameters()

int COperateFtpServer::SetGlobalParameters ( CParameterPlugin * pPara )

overrideprotectedvirtual

应用插件全局参数

注解: 调用 CParameterOperate::SetGlobalParameters 设置操作参数的全局参数，并连接与全局参数相关的信号

int COperateDesktop::SetGlobalParameters(CParameterPlugin *pPara)
{
    if(GetParameter()) {
        GetParameter()->SetGlobalParameters(pPara);
 
        if(pPara) {
            bool check = connect(pPara, SIGNAL(sigNameStylesChanged()),
                                 this, SLOT(slotUpdateName()));
            Q_ASSERT(check);
        }
 
        LoadAdaptWindows();
        return 0;
    } else {
        QString szMsg = "There is not parameters! "
                        "please first create parameters, "
                        "then call SetParameter() in the ";
        szMsg += metaObject()->className() + QString("::")
                 + metaObject()->className();
        szMsg += QString("() or ") + metaObject()->className()
                 + QString("::") + "Initial()";
        szMsg += " to set the parameters pointer. "
                 "Default set CParameterClient for the parameters of operate "
                 "(CParameterOperate or its derived classes) "
                 "See CManager::CreateOperate. "
                 "If you are sure the parameter of operate "
                 "does not need CParameterClient. "
                 "Please overload the SetGlobalParameters() in the ";
        szMsg += QString(metaObject()->className()) + " . don't set it";
        qCritical(log) << szMsg.toStdString().c_str();
        Q_ASSERT(false);
    }
    return -1;
}

参见: CManager::CreateOperate CParameterPlugin

实现了 COperate.

在文件 OperateFtpServer.cpp 第 70 行定义.

◆ slotStart

void COperateFtpServer::slotStart ( bool checked )

privateslot

在文件 OperateFtpServer.cpp 第 170 行定义.

◆ Start()

int COperateFtpServer::Start ( )

overridevirtual

开始

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

参见: sigRunning()

实现了 COperate.

在文件 OperateFtpServer.cpp 第 36 行定义.

◆ Stop()

int COperateFtpServer::Stop ( )

overridevirtual

关闭

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

参见: sigFinished()

实现了 COperate.

在文件 OperateFtpServer.cpp 第 43 行定义.

◆ Version()

const qint16 COperateFtpServer::Version ( ) const

overridevirtual

版本

实现了 COperate.

在文件 OperateFtpServer.cpp 第 26 行定义.

友元及相关函数文档

◆ CFrmMain

friend class CFrmMain

friend

在文件 OperateFtpServer.h 第 47 行定义.

类成员变量说明

◆ m_Para

QSharedPointer<CParameterFtpServer> COperateFtpServer::m_Para

private

在文件 OperateFtpServer.h 第 44 行定义.

◆ m_pStart

QAction* COperateFtpServer::m_pStart

private

在文件 OperateFtpServer.h 第 46 行定义.

◆ m_pThread

CBackendThread* COperateFtpServer::m_pThread

private

在文件 OperateFtpServer.h 第 43 行定义.

◆ m_pView

CFrmMain* COperateFtpServer::m_pView

private

在文件 OperateFtpServer.h 第 45 行定义.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/FtpServer/OperateFtpServer.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/FtpServer/OperateFtpServer.cpp

Public 成员函数

Protected 成员函数

Private 槽

Private 成员函数

Private 属性

友元

额外继承的成员函数

详细描述

构造及析构函数说明

◆ ~COperateFtpServer()

成员函数说明

◆ Clean()

◆ Description()

◆ GetParameter()

◆ GetViewer()

◆ Initial()

◆ InstanceBackend()

◆ Load()

◆ Name()

◆ OnOpenDialogSettings()

◆ Save()

◆ SetGlobalParameters()

◆ slotStart

◆ Start()

◆ Stop()

◆ Version()

友元及相关函数文档

◆ CFrmMain

类成员变量说明

◆ m_Para

◆ m_pStart

◆ m_pThread

◆ m_pView