File transfer operate interface. More...

#include <OperateFileTransfer.h>

Inheritance diagram for COperateFileTransfer:

[legend]

Collaboration diagram for COperateFileTransfer:

[legend]

Public Member Functions
	COperateFileTransfer (CPlugin *plugin)

virtual Q_INVOKABLE CBackend *	InstanceBackend ()
	New CBackend.

virtual const QString	Id () override

virtual const QString	Name () override
	Name.

virtual const QString	Description () override
	Description.

virtual const QString	Protocol () const override

virtual const qint16	Version () const override

virtual QWidget *	GetViewer () override
	Get Viewer.

virtual int	Start () override
	Start.

virtual int	Stop () override
	Stop.

CParameterFileTransfer *	GetParameter ()

Public Member Functions inherited from COperate
	COperate (CPlugin *plugin)

virtual int	OpenDialogSettings (QWidget *parent=nullptr)
	Open settings dialog.

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

virtual const QIcon	Icon () const

virtual const QString	GetTypeName () const

virtual QString	GetSettingsFile ()

virtual int	SetSettingsFile (const QString &szFile)

virtual CStats *	GetStats ()
	Get statistics.

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

Protected Member Functions
virtual int	SetGlobalParameters (CParameterPlugin *pPara) override
	Apply the global parameters of the plug-in.

virtual int	Load (QSettings &set) override
	Load parameters.

virtual int	Save (QSettings &set) override
	Save parameters.

virtual int	Initial () override
	Initial parameters and resource.

virtual int	Clean () override
	Clean parameters and resource.

Protected Member Functions inherited from COperate
Q_INVOKABLE CPlugin *	GetPlugin () const
	Get plugin.

virtual Q_INVOKABLE int	Load (QString szFile=QString())
	Load parameters from file.

virtual Q_INVOKABLE int	Save (QString szFile=QString())
	Save parameters to file.

Private Slots
void	slotCopyUrlToClipboard (const QString &szPath)

Private Member Functions
virtual QDialog *	OnOpenDialogSettings (QWidget *parent) override
	Open settgins dialog.

Private Attributes
CFrmFileTransfer *	m_frmFileTransfer

CParameterFileTransfer	m_Parameter

CBackendThread *	m_pThread

Additional Inherited Members
Signals inherited from COperate
void	sigViewerFocusIn (QWidget *pView)
	The view is focus.

void	sigFullScreen (bool bFullScreen)
	Full screen.

void	sigUpdateName (const QString &szName)

void	sigUpdateParameters (COperate *pOperate)
	Update parameters, notify application to save or show parameters.

void	sigError (const int nError, const QString &szError)
	Triggered when an error is generated.

void	sigInformation (const QString &szInfo)
	Show information in main windows.

void	sigShowMessageBox (const QString &title, const QString &message, const QMessageBox::Icon &icon=QMessageBox::Information)
	Trigger the display of a message dialog (QMessageBox) in the main thread from a background thread without blocking the background thread.

void	sigClipBoardChanged ()

void	sigSecurityLevel ()
	Triggered when the security level changes.

void	sigRunning ()
	Start success signal.

void	sigStop ()
	Notify the user to stop.

void	sigFinished ()
	Successful disconnection signal.

Protected Slots inherited from COperate
void	slotUpdateName ()

void	slotSetSecurityLevel (CSecurityLevel::Levels level)

Static Protected Member Functions inherited from COperate
static QObject *	createObject (const QString &className, QObject *parent=NULL)
	Create Object.

Protected Attributes inherited from COperate
QMenu	m_Menu

QAction *	m_pActionSettings

Detailed Description

File transfer operate interface.

Definition at line 13 of file OperateFileTransfer.h.

Constructor & Destructor Documentation

◆ ~COperateFileTransfer()

COperateFileTransfer::~COperateFileTransfer ( )

virtual

Definition at line 30 of file OperateFileTransfer.cpp.

Member Function Documentation

◆ Clean()

int COperateFileTransfer::Clean ( )

overrideprotectedvirtual

Clean parameters and resource.

See also: CManager::DeleteOperate

Reimplemented from COperate.

Definition at line 78 of file OperateFileTransfer.cpp.

◆ Description()

const QString COperateFileTransfer::Description ( )

overridevirtual

Description.

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;
}

See also: COperateDesktop::Description()

Reimplemented from COperate.

Definition at line 161 of file OperateFileTransfer.cpp.

◆ GetParameter()

CParameterFileTransfer * COperateFileTransfer::GetParameter ( )

Definition at line 40 of file OperateFileTransfer.cpp.

◆ GetViewer()

QWidget * COperateFileTransfer::GetViewer ( )

overridevirtual

Get Viewer.

Returns: QWidget*: the ownership is a instance of this class or its derivative class

Note: If you implement the view yourself, you need to disable the view at the beginning and allow the view after sigRun.

See also: sigRunning CFrmViewer::CFrmViewer

Implements COperate.

Definition at line 50 of file OperateFileTransfer.cpp.

◆ Id()

const QString COperateFileTransfer::Id ( )

overridevirtual

Reimplemented from COperate.

Definition at line 204 of file OperateFileTransfer.cpp.

◆ Initial()

int COperateFileTransfer::Initial ( )

overrideprotectedvirtual

Initial parameters and resource.

Note: Call before Load()

See also: CManager::CreateOperate Load

Reimplemented from COperate.

Definition at line 55 of file OperateFileTransfer.cpp.

◆ InstanceBackend()

CBackend * COperateFileTransfer::InstanceBackend ( )

virtual

New CBackend.

the ownership is caller. if don't use, the caller must delete it.

Definition at line 35 of file OperateFileTransfer.cpp.

◆ Load()

int COperateFileTransfer::Load ( QSettings & set )

overrideprotectedvirtual

Load parameters.

Implements COperate.

Definition at line 123 of file OperateFileTransfer.cpp.

◆ Name()

const QString COperateFileTransfer::Name ( )

overridevirtual

Name.

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;
}

See also: COperateDesktop::Name()

Reimplemented from COperate.

Definition at line 137 of file OperateFileTransfer.cpp.

◆ OnOpenDialogSettings()

QDialog * COperateFileTransfer::OnOpenDialogSettings ( QWidget * parent )

overrideprivatevirtual

Open settgins dialog.

Parameters

parent the parent windows of the dialog of return

Returns: QDialog*: then QDialog must be allocated in heap memory, the ownership is caller.

See also: OpenDialogSettings

Implements COperate.

Definition at line 118 of file OperateFileTransfer.cpp.

◆ Protocol()

const QString COperateFileTransfer::Protocol ( ) const

overridevirtual

Reimplemented from COperate.

Definition at line 193 of file OperateFileTransfer.cpp.

◆ Save()

int COperateFileTransfer::Save ( QSettings & set )

overrideprotectedvirtual

Save parameters.

Implements COperate.

Definition at line 130 of file OperateFileTransfer.cpp.

◆ SetGlobalParameters()

int COperateFileTransfer::SetGlobalParameters ( CParameterPlugin * pPara )

overrideprotectedvirtual

Apply the global parameters of the plug-in.

Note: Call CParameterOperate::SetGlobalParameters to set the global parameters for the operation parameters, and connect the signals related to the global parameters.

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;
}

See also: CManager::CreateOperate CParameterPlugin

Implements COperate.

Definition at line 113 of file OperateFileTransfer.cpp.

◆ slotCopyUrlToClipboard

void COperateFileTransfer::slotCopyUrlToClipboard ( const QString & szPath )

privateslot

Definition at line 227 of file OperateFileTransfer.cpp.

◆ Start()

int COperateFileTransfer::Start ( )

overridevirtual

Start.

Note: Only call by user, The plugin don't call it. When plugin is started, it emit sigRunning()

See also: sigRunning()

Implements COperate.

Definition at line 89 of file OperateFileTransfer.cpp.

◆ Stop()

int COperateFileTransfer::Stop ( )

overridevirtual

Stop.

Note: Only call by user, The plugin don't call it. When plugin is stopped, it emit sigFinished(). The caller receive the signal, then delete the object.

See also: sigFinished()

Implements COperate.

Definition at line 101 of file OperateFileTransfer.cpp.

◆ Version()

const qint16 COperateFileTransfer::Version ( ) const

overridevirtual

Implements COperate.

Definition at line 45 of file OperateFileTransfer.cpp.

Member Data Documentation

◆ m_frmFileTransfer

CFrmFileTransfer* COperateFileTransfer::m_frmFileTransfer

private

Definition at line 53 of file OperateFileTransfer.h.

◆ m_Parameter

CParameterFileTransfer COperateFileTransfer::m_Parameter

private

Definition at line 54 of file OperateFileTransfer.h.

◆ m_pThread

CBackendThread* COperateFileTransfer::m_pThread

private

Definition at line 55 of file OperateFileTransfer.h.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/FileTransfer/OperateFileTransfer.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/FileTransfer/OperateFileTransfer.cpp

Public Member Functions

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~COperateFileTransfer()

Member Function Documentation

◆ Clean()

◆ Description()

◆ GetParameter()

◆ GetViewer()

◆ Id()

◆ Initial()

◆ InstanceBackend()

◆ Load()

◆ Name()

◆ OnOpenDialogSettings()

◆ Protocol()

◆ Save()

◆ SetGlobalParameters()

◆ slotCopyUrlToClipboard

◆ Start()

◆ Stop()

◆ Version()

Member Data Documentation

◆ m_frmFileTransfer

◆ m_Parameter

◆ m_pThread