The connector interface of the plug-in, which is only used by the plug-in. More...

#include <ConnecterConnect.h>

Inheritance diagram for CConnecterConnect:

Public Slots
virtual int	Connect () override

virtual int	DisConnect () override
	emit sigDisconnected() in here

Public Slots inherited from CConnecter
virtual int	Connect ()=0
	Start connect.

virtual int	DisConnect ()=0
	Close connect.

Signals
void	sigOpenConnect (CConnecterConnect *)

void	sigCloseconnect (CConnecterConnect *)

Signals inherited from CConnecter
void	sigConnected ()
	Successful connection signal.

void	sigDisconnect ()
	Notify the user to disconnect.

void	sigDisconnected ()
	Successful disconnection signal.

void	sigViewerFocusIn (QWidget *pView)
	The view is focus.

void	sigUpdateName (const QString &szName)

void	sigUpdateParameters (CConnecter *pConnecter)
	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 ()

Public Member Functions
	CConnecterConnect (CPluginClient *plugin)

virtual const QString	Id () override
	Identity.

virtual const QString	Name () override
	Display order:

virtual const QString	Description () override
	Description.

virtual CConnect *	InstanceConnect ()=0
	New connect.

virtual CParameterBase *	GetParameter ()
	Get parameter.

virtual int	SetParameter (CParameterBase *p)

Public Member Functions inherited from CConnecter
	CConnecter (CPluginClient *plugin)

virtual const QString	Protocol () const
	Protocol.

virtual qint16	Version ()=0
	Version.

virtual const QIcon	Icon () const
	Icon.

virtual QWidget *	GetViewer ()=0
	Get Viewer.

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

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

virtual QString	GetSettingsFile ()

virtual int	SetSettingsFile (const QString &szFile)

Protected Member Functions
virtual QString	ServerName ()
	Current connect server name (remote desktop name, if not present, then IP:PORT).

Protected Member Functions inherited from CConnecter
virtual Q_INVOKABLE int	Initial ()
	Initial parameters and resource.

virtual Q_INVOKABLE int	Clean ()
	Clean parameters and resource.

virtual int	SetParameter (CParameter *p)
	Set parameters.

CParameter *	GetParameter ()

Q_INVOKABLE CPluginClient *	GetPlugClient () const

virtual int	Load (QSettings &set)
	Load parameters.

virtual int	Save (QSettings &set)
	Save parameters.

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
virtual void	slotSetServerName (const QString &szName)

Private Member Functions
virtual int	SetParameterClient (CParameterClient *pPara) override
	Set CParameterClient.

Private Attributes
CConnect *	m_pConnect

QString	m_szServerName

Additional Inherited Members
Static Protected Member Functions inherited from CConnecter
static QObject *	createObject (const QString &className, QObject *parent=NULL)

Protected Attributes inherited from CConnecter
QMenu	m_Menu

QAction *	m_pSettings

Detailed Description

The connector interface of the plug-in, which is only used by the plug-in.

All plug-in connectors that require CConnect need to derive from this interface.

Default instance CConnect, and call CConnect::Connect() and CConnect::Disconnect()
The plugin interface is derived from CPluginClientThread, Implements a background thread to handle multiple connections.
The plugin interface is not derived from CPluginClientThread, Implements handle a connection in main thread.

See also: CConnect

Definition at line 34 of file ConnecterConnect.h.

Constructor & Destructor Documentation

◆ ~CConnecterConnect()

CConnecterConnect::~CConnecterConnect ( )

virtual

Definition at line 14 of file ConnecterConnect.cpp.

Member Function Documentation

◆ Connect

int CConnecterConnect::Connect ( )

overridevirtualslot

Call CConnect::Connect() synchronously, then sigConnected() is triggered in this function
Asynchronous call to CConnect::Connect() triggers sigConnected() in CConnect

Definition at line 194 of file ConnecterConnect.cpp.

◆ Description()

const QString CConnecterConnect::Description ( )

overridevirtual

Description.

Reimplemented from CConnecter.

Definition at line 65 of file ConnecterConnect.cpp.

◆ DisConnect

int CConnecterConnect::DisConnect ( )

overridevirtualslot

emit sigDisconnected() in here

See also: CManageConnect::slotDisconnect()

Definition at line 215 of file ConnecterConnect.cpp.

◆ GetParameter()

CParameterBase * CConnecterConnect::GetParameter ( )

virtual

Get parameter.

Definition at line 119 of file ConnecterConnect.cpp.

◆ Id()

const QString CConnecterConnect::Id ( )

overridevirtual

Identity.

Reimplemented from CConnecter.

Reimplemented in CConnecterVnc, and CConnecterWakeOnLan.

Definition at line 19 of file ConnecterConnect.cpp.

◆ InstanceConnect()

virtual CConnect * CConnecterConnect::InstanceConnect ( )

pure virtual

New connect.

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

Implemented in CConnecterFreeRDP, CConnecterLibVNCServer, CConnecterPlayer, CConnecterVnc, and CConnecterWakeOnLan.

◆ Name()

const QString CConnecterConnect::Name ( )

overridevirtual

Display order:

User parameter Name()
if enable, Server name
Host and port

See also: ServerName()

Reimplemented from CConnecter.

Reimplemented in CConnecterWakeOnLan.

Definition at line 51 of file ConnecterConnect.cpp.

◆ ServerName()

QString CConnecterConnect::ServerName ( )

protectedvirtual

Current connect server name (remote desktop name, if not present, then IP:PORT).

eg: Server name or Ip:Port

Returns: Current connect server name.

Reimplemented in CConnecterThread, and CConnecterVnc.

Definition at line 234 of file ConnecterConnect.cpp.

◆ SetParameter()

int CConnecterConnect::SetParameter ( CParameterBase * p )

virtual

Definition at line 124 of file ConnecterConnect.cpp.

◆ SetParameterClient()

int CConnecterConnect::SetParameterClient ( CParameterClient * pPara )

overrideprivatevirtual

Set CParameterClient.

Note: If CParameterConnecter isn't need CParameterClient. please overload this function.

See also: CClient::CreateConnecter CParameterConnecter CParameterClient

Reimplemented from CConnecter.

Reimplemented in CConnecterWakeOnLan.

Definition at line 157 of file ConnecterConnect.cpp.

◆ slotSetServerName

void CConnecterConnect::slotSetServerName ( const QString & szName )

privatevirtualslot

Note: The slot only is used by CConnectDesktop::SetConnecter()

Definition at line 248 of file ConnecterConnect.cpp.

Member Data Documentation

◆ m_pConnect

CConnect* CConnecterConnect::m_pConnect

private

Definition at line 132 of file ConnecterConnect.h.

◆ m_szServerName

QString CConnecterConnect::m_szServerName

private

Definition at line 133 of file ConnecterConnect.h.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Client/ConnecterConnect.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Client/ConnecterConnect.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~CConnecterConnect()

Member Function Documentation

◆ Connect

◆ Description()

◆ DisConnect

◆ GetParameter()

◆ Id()

◆ InstanceConnect()

◆ Name()

◆ ServerName()

◆ SetParameter()

◆ SetParameterClient()

◆ slotSetServerName

Member Data Documentation

◆ m_pConnect

◆ m_szServerName