CPluginService Class Reference

The service plugin interface. More...

#include <PluginService.h>

Inheritance diagram for CPluginService:

Collaboration diagram for CPluginService:

Public Member Functions
	CPluginService (QObject *parent=nullptr)
virtual const QString	Id () const
	ID. Default: Protocol() + "_" + Name()
virtual const QString	Protocol () const =0
	Plugin Protocol.
virtual const QString	Name () const =0
	This name must be the same as the project name (${PROJECT_NAME}).
virtual const QString	DisplayName () const
	The plugin display name.
virtual const QString	Description () const =0
	Plugin description.
virtual const QIcon	Icon () const
virtual void	Start ()
	Start a Service.
virtual void	Stop ()
virtual CService *	NewService ()=0
	New service.
int	InitTranslator ()

Private Attributes
QSharedPointer< CService >	m_Service
QTranslator	m_Translator

Detailed Description

The service plugin interface.

The interface only is implemented and used by plugin.

See also

CService CServiceManager

Definition at line 26 of file PluginService.h.

Constructor & Destructor Documentation

CPluginService()

CPluginService::CPluginService ( QObject *  parent = nullptr )

explicit

Definition at line 15 of file PluginService.cpp.

~CPluginService()

CPluginService::~CPluginService ( )

virtual

Definition at line 19 of file PluginService.cpp.

Member Function Documentation

Description()

virtual const QString CPluginService::Description ( ) const

pure virtual

Plugin description.

Implemented in CPluginServiceFreeRDP, CPluginServiceLibVNCServer, CPluginServiceRabbitVNC, and CPluginServiceTigerVNC.

DisplayName()

const QString CPluginService::DisplayName ( ) const

virtual

The plugin display name.

Reimplemented in CPluginServiceFreeRDP, CPluginServiceRabbitVNC, and CPluginServiceTigerVNC.

Definition at line 48 of file PluginService.cpp.

Icon()

const QIcon CPluginService::Icon ( ) const

virtual

Definition at line 43 of file PluginService.cpp.

Id()

const QString CPluginService::Id ( ) const

virtual

ID. Default: Protocol() + "_" + Name()

Definition at line 38 of file PluginService.cpp.

InitTranslator()

int CPluginService::InitTranslator

(

)

Definition at line 25 of file PluginService.cpp.

Name()

virtual const QString CPluginService::Name ( ) const

pure virtual

This name must be the same as the project name (${PROJECT_NAME}).

The translation file (${PROJECT_NAME}_*.ts)) name is associated with it.

Implemented in CPluginServiceFreeRDP, CPluginServiceLibVNCServer, CPluginServiceRabbitVNC, and CPluginServiceTigerVNC.

NewService()

virtual CService * CPluginService::NewService ( )

pure virtual

New service.

Implemented in CPluginServiceFreeRDP, CPluginServiceLibVNCServer, CPluginServiceRabbitVNC, and CPluginServiceTigerVNC.

Protocol()

virtual const QString CPluginService::Protocol ( ) const

pure virtual

Plugin Protocol.

Implemented in CPluginServiceFreeRDP, CPluginServiceLibVNCServer, CPluginServiceRabbitVNC, and CPluginServiceTigerVNC.

Start()

void CPluginService::Start ( )

virtual

Start a Service.

See also

CService

Reimplemented in CPluginServiceThread.

Definition at line 53 of file PluginService.cpp.

Stop()

void CPluginService::Stop ( )

virtual

Definition at line 61 of file PluginService.cpp.

Member Data Documentation

m_Service

QSharedPointer<CService> CPluginService::m_Service

private

Definition at line 65 of file PluginService.h.

m_Translator

QTranslator CPluginService::m_Translator

private

Definition at line 66 of file PluginService.h.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Service/PluginService.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Service/PluginService.cpp