Terminal operate interface. More...

#include <OperateTerminal.h>

Inheritance diagram for COperateTerminal:

[legend]

Collaboration diagram for COperateTerminal:

[legend]

Public Slots
virtual int	Start () override

virtual int	Stop () override

Public Member Functions
	COperateTerminal (CPlugin *parent)

virtual Q_INVOKABLE CBackend *	InstanceBackend ()=0
	New CBackend.

virtual CParameterTerminalBase *	GetParameter () const
	Get parameters.

virtual int	SetParameter (CParameterTerminalBase *pPara)
	Set parameter pointer.

virtual const QString	Id () override

virtual const QString	Name () override
	Name.

virtual const QString	Description () override
	Description.

virtual const qint16	Version () const override

CStats *	GetStats () override
	Get statistics.

QWidget *	GetViewer () override
	Get Viewer.

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 QString	Protocol () const

virtual const QIcon	Icon () const

virtual const QString	GetTypeName () const

virtual QString	GetSettingsFile ()

virtual int	SetSettingsFile (const QString &szFile)

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

virtual int	Start ()=0
	Start.

virtual int	Stop ()=0
	Stop.

Static Public Member Functions
static const QString	Details ()

Protected Slots
void	slotUpdateParameter (COperate *pOperate)

Protected Slots inherited from COperate
void	slotUpdateName ()

void	slotSetSecurityLevel (CSecurityLevel::Levels level)

Protected Member Functions
virtual int	Initial () override
	Initial parameters and resource.

virtual int	Clean () override
	Clean parameters and resource.

virtual int	SetGlobalParameters (CParameterPlugin *pPara) override
	Set Global Parameters.

int	WriteTerminal (const char *buf, int len)

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

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

virtual void	SetShotcuts (bool bEnable=true)

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.

Protected Attributes
QTermWidget *	m_pTerminal

CBackendThread *	m_pThread

QAction *	m_pActionOpenWithSystem

QAction *	m_pActionFind

Protected Attributes inherited from COperate
QMenu	m_Menu

QAction *	m_pActionSettings

Private Slots
void	slotZoomReset ()

void	slotCustomContextMenu (const QPoint &pos)

void	slotActivateUrl (const QUrl &url, bool fromContextMenu)

void	slotTermKeyPressed (QKeyEvent *e)

void	slotFocusIn ()

void	slotFocusOut ()

Private Attributes
CParameterTerminalBase *	m_pParameters

QAction *	m_pEditCopy

QAction *	m_pEditPaste

QAction *	m_pZoomIn

QAction *	m_pZoomOut

QAction *	m_pZoomOriginal

QAction *	m_pClear

CStats	m_Stats

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.

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

Detailed Description

Terminal operate interface.

Definition at line 25 of file OperateTerminal.h.

Constructor & Destructor Documentation

◆ ~COperateTerminal()

COperateTerminal::~COperateTerminal ( )

overridevirtual

Definition at line 82 of file OperateTerminal.cpp.

Member Function Documentation

◆ Clean()

int COperateTerminal::Clean ( )

overrideprotectedvirtual

Clean parameters and resource.

See also: CManager::DeleteOperate

Reimplemented from COperate.

Reimplemented in COperateSSH.

Definition at line 244 of file OperateTerminal.cpp.

◆ Description()

const QString COperateTerminal::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.

Reimplemented in COperateRawStream, COperateSerialPort, COperateSSH, COperateTelnet, and CTerminal.

Definition at line 116 of file OperateTerminal.cpp.

◆ Details()

const QString COperateTerminal::Details ( )

static

Definition at line 153 of file OperateTerminal.cpp.

◆ GetParameter()

CParameterTerminalBase * COperateTerminal::GetParameter ( ) const

virtual

Get parameters.

Definition at line 278 of file OperateTerminal.cpp.

◆ GetStats()

CStats * COperateTerminal::GetStats ( )

overridevirtual

Get statistics.

If so, its derived class needs to overload this function to provide statistical information.

Returns: Statistics pointer

Reimplemented from COperate.

Reimplemented in CTerminal.

Definition at line 168 of file OperateTerminal.cpp.

◆ GetViewer()

QWidget * COperateTerminal::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 163 of file OperateTerminal.cpp.

◆ Id()

const QString COperateTerminal::Id ( )

overridevirtual

Reimplemented from COperate.

Definition at line 92 of file OperateTerminal.cpp.

◆ Initial()

int COperateTerminal::Initial ( )

overrideprotectedvirtual

Initial parameters and resource.

Note: Call before Load()

See also: CManager::CreateOperate Load

Reimplemented from COperate.

Reimplemented in COperateSSH, and CTerminal.

Definition at line 193 of file OperateTerminal.cpp.

◆ InstanceBackend()

virtual Q_INVOKABLE CBackend * COperateTerminal::InstanceBackend ( )

pure virtual

New CBackend.

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

Implemented in COperateRawStream, COperateSerialPort, COperateSSH, COperateTelnet, and CTerminal.

◆ Load()

int COperateTerminal::Load ( QSettings & set )

overrideprotectedvirtual

Load parameters.

Implements COperate.

Definition at line 173 of file OperateTerminal.cpp.

◆ Name()

const QString COperateTerminal::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.

Reimplemented in COperateRawStream, COperateSerialPort, COperateSSH, COperateTelnet, and CTerminal.

Definition at line 106 of file OperateTerminal.cpp.

◆ Save()

int COperateTerminal::Save ( QSettings & set )

overrideprotectedvirtual

Save parameters.

Implements COperate.

Definition at line 183 of file OperateTerminal.cpp.

◆ SetGlobalParameters()

int COperateTerminal::SetGlobalParameters ( CParameterPlugin * pPara )

overrideprotectedvirtual

Set Global Parameters.

Parameters

pPara

Returns

Implements COperate.

Definition at line 379 of file OperateTerminal.cpp.

◆ SetParameter()

int COperateTerminal::SetParameter ( CParameterTerminalBase * pPara )

virtual

Set parameter pointer.

Note: Establish the parameter object first, and then calls this function in the constructor or Initial() to set the parameter pointer

Reimplemented in CTerminal.

Definition at line 283 of file OperateTerminal.cpp.

◆ SetShotcuts()

void COperateTerminal::SetShotcuts ( bool bEnable = true )

protectedvirtual

Definition at line 425 of file OperateTerminal.cpp.

◆ slotActivateUrl

void COperateTerminal::slotActivateUrl	(	const QUrl &	url,
		bool	fromContextMenu
	)

privateslot

Definition at line 356 of file OperateTerminal.cpp.

◆ slotCustomContextMenu

void COperateTerminal::slotCustomContextMenu ( const QPoint & pos )

privateslot

Definition at line 345 of file OperateTerminal.cpp.

◆ slotFocusIn

void COperateTerminal::slotFocusIn ( )

privateslot

Definition at line 368 of file OperateTerminal.cpp.

◆ slotFocusOut

void COperateTerminal::slotFocusOut ( )

privateslot

Definition at line 374 of file OperateTerminal.cpp.

◆ slotTermKeyPressed

void COperateTerminal::slotTermKeyPressed ( QKeyEvent * e )

privateslot

Definition at line 363 of file OperateTerminal.cpp.

◆ slotUpdateParameter

void COperateTerminal::slotUpdateParameter ( COperate * pOperate )

protectedslot

Definition at line 306 of file OperateTerminal.cpp.

◆ slotZoomReset

void COperateTerminal::slotZoomReset ( )

privateslot

Definition at line 337 of file OperateTerminal.cpp.

◆ Start

int COperateTerminal::Start ( )

overridevirtualslot

Definition at line 251 of file OperateTerminal.cpp.

◆ Stop

int COperateTerminal::Stop ( )

overridevirtualslot

Definition at line 265 of file OperateTerminal.cpp.

◆ Version()

const qint16 COperateTerminal::Version ( ) const

overridevirtual

Implements COperate.

Definition at line 148 of file OperateTerminal.cpp.

◆ WriteTerminal()

int COperateTerminal::WriteTerminal	(	const char *	buf,
		int	len
	)

protected

Definition at line 412 of file OperateTerminal.cpp.

Member Data Documentation

◆ m_pActionFind

QAction* COperateTerminal::m_pActionFind

protected

Definition at line 95 of file OperateTerminal.h.

◆ m_pActionOpenWithSystem

QAction* COperateTerminal::m_pActionOpenWithSystem

protected

Definition at line 94 of file OperateTerminal.h.

◆ m_pClear

QAction* COperateTerminal::m_pClear

private

Definition at line 105 of file OperateTerminal.h.

◆ m_pEditCopy

QAction* COperateTerminal::m_pEditCopy

private

Definition at line 100 of file OperateTerminal.h.

◆ m_pEditPaste

QAction* COperateTerminal::m_pEditPaste

private

Definition at line 101 of file OperateTerminal.h.

◆ m_pParameters

CParameterTerminalBase* COperateTerminal::m_pParameters

private

Definition at line 98 of file OperateTerminal.h.

◆ m_pTerminal

QTermWidget* COperateTerminal::m_pTerminal

protected

Definition at line 92 of file OperateTerminal.h.

◆ m_pThread

CBackendThread* COperateTerminal::m_pThread

protected

Definition at line 93 of file OperateTerminal.h.

◆ m_pZoomIn

QAction* COperateTerminal::m_pZoomIn

private

Definition at line 102 of file OperateTerminal.h.

◆ m_pZoomOriginal

QAction* COperateTerminal::m_pZoomOriginal

private

Definition at line 104 of file OperateTerminal.h.

◆ m_pZoomOut

QAction* COperateTerminal::m_pZoomOut

private

Definition at line 103 of file OperateTerminal.h.

◆ m_Stats

CStats COperateTerminal::m_Stats

private

Definition at line 107 of file OperateTerminal.h.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/Terminal/OperateTerminal.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/Terminal/OperateTerminal.cpp

Public Slots

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Private Slots

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~COperateTerminal()

Member Function Documentation

◆ Clean()

◆ Description()

◆ Details()

◆ GetParameter()

◆ GetStats()

◆ GetViewer()

◆ Id()

◆ Initial()

◆ InstanceBackend()

◆ Load()

◆ Name()

◆ Save()

◆ SetGlobalParameters()

◆ SetParameter()

◆ SetShotcuts()

◆ slotActivateUrl

◆ slotCustomContextMenu

◆ slotFocusIn

◆ slotFocusOut

◆ slotTermKeyPressed

◆ slotUpdateParameter

◆ slotZoomReset

◆ Start

◆ Stop

◆ Version()

◆ WriteTerminal()

Member Data Documentation

◆ m_pActionFind

◆ m_pActionOpenWithSystem

◆ m_pClear

◆ m_pEditCopy

◆ m_pEditPaste

◆ m_pParameters

◆ m_pTerminal

◆ m_pThread

◆ m_pZoomIn

◆ m_pZoomOriginal

◆ m_pZoomOut

◆ m_Stats