COperateSerialPort Class Reference

Inheritance diagram for COperateSerialPort:

Collaboration diagram for COperateSerialPort:

Public Member Functions
	COperateSerialPort (CPlugin *plugin)
const QString	Name () override
	Name.
const QString	Description () override
	Description.
virtual int	Start () override
virtual int	Stop () override
virtual CBackend *	InstanceBackend () override
	New CBackend.
Public Member Functions inherited from COperateTerminal
	COperateTerminal (CPlugin *parent)
virtual CParameterTerminalBase *	GetParameter () const
	Get parameters.
virtual int	SetParameter (CParameterTerminalBase *pPara)
	Set parameter pointer.
virtual const QString	Id () override
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.

Private Slots
void	slotReadyRead ()

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

Private Attributes
CParameterSerialPort	m_Parameter
QSerialPort	m_SerialPort

Additional Inherited Members
Public Slots inherited from COperateTerminal
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 Public Member Functions inherited from COperateTerminal
static const QString	Details ()
Protected Slots inherited from COperateTerminal
void	slotUpdateParameter (COperate *pOperate)
Protected Slots inherited from COperate
void	slotUpdateName ()
void	slotSetSecurityLevel (CSecurityLevel::Levels level)
Protected Member Functions inherited from COperateTerminal
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.
Static Protected Member Functions inherited from COperate
static QObject *	createObject (const QString &className, QObject *parent=NULL)
	Create Object.
Protected Attributes inherited from COperateTerminal
QTermWidget *	m_pTerminal
CBackendThread *	m_pThread
QAction *	m_pActionOpenWithSystem
QAction *	m_pActionFind
Protected Attributes inherited from COperate
QMenu	m_Menu
QAction *	m_pActionSettings

Detailed Description

Definition at line 8 of file OperateSerialPort.h.

Constructor & Destructor Documentation

~COperateSerialPort()

COperateSerialPort::~COperateSerialPort ( )

virtual

Definition at line 15 of file OperateSerialPort.cpp.

Member Function Documentation

Description()

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

Definition at line 133 of file OperateSerialPort.cpp.

InstanceBackend()

CBackend * COperateSerialPort::InstanceBackend ( )

overridevirtual

New CBackend.

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

Implements COperateTerminal.

Definition at line 23 of file OperateSerialPort.cpp.

Name()

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

Definition at line 118 of file OperateSerialPort.cpp.

OnOpenDialogSettings()

QDialog * COperateSerialPort::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 18 of file OperateSerialPort.cpp.

slotReadyRead

void COperateSerialPort::slotReadyRead ( )

privateslot

Definition at line 108 of file OperateSerialPort.cpp.

Start()

int COperateSerialPort::Start ( )

overridevirtual

Reimplemented from COperateTerminal.

Definition at line 28 of file OperateSerialPort.cpp.

Stop()

int COperateSerialPort::Stop ( )

overridevirtual

Reimplemented from COperateTerminal.

Definition at line 98 of file OperateSerialPort.cpp.

Member Data Documentation

m_Parameter

CParameterSerialPort COperateSerialPort::m_Parameter

private

Definition at line 33 of file OperateSerialPort.h.

m_SerialPort

QSerialPort COperateSerialPort::m_SerialPort

private

Definition at line 34 of file OperateSerialPort.h.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/SerialPort/OperateSerialPort.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/SerialPort/OperateSerialPort.cpp