CPluginTemplateBase Class Reference

Inheritance diagram for CPluginTemplateBase:

Collaboration diagram for CPluginTemplateBase:

Public Member Functions
	CPluginTemplateBase (QObject *parent=nullptr)
virtual const TYPE	Type () const override
virtual const QString	Protocol () const override
	Plugin Protocol.
virtual const QString	Name () const override
	This name must be the same as the project name (${PROJECT_NAME}). The translation file (${PROJECT_NAME}_*.ts)) name is associated with it.
virtual const QString	Description () const override
	Plugin description.
virtual const QString	Version () const override
	Version.
virtual const QIcon	Icon () const override
virtual const QString	Details () const override
	Display more information in About dialog or log.
Public Member Functions inherited from CPlugin
	CPlugin (QObject *parent=nullptr)
virtual const QString	TypeName (const TYPE t) const
virtual const QString	Id () const
	ID. Default: Type() + ":" + Protocol() + ":" + Name()
virtual const QString	DisplayName () const
	The plugin display name.

Protected Member Functions
virtual COperate *	OnCreateOperate (const QString &szId) override
Protected Member Functions inherited from CPlugin
virtual Q_INVOKABLE COperate *	CreateOperate (const QString &szId, CParameterPlugin *para)
	New COperate instance.
virtual Q_INVOKABLE int	DeleteOperate (COperate *p)
	Delete COperate.
virtual Q_INVOKABLE QWidget *	GetSettingsWidget (QWidget *parent)
	Get the widget to set global parameters for the plugin.

Additional Inherited Members
Public Types inherited from CPlugin
enum class	TYPE {   RemoteDesktop , Terminal , Client , Server ,   FileTransfers , NetworkTools , Tools , Custom = 1000 }
Signals inherited from CPlugin
void	sigNewOperate (COperate *pOperate, bool bOpenSettingsDialog)
	This signal is triggered when a new operate is created in the plugin.

Detailed Description

Definition at line 6 of file PluginTemplateBase.h.

Constructor & Destructor Documentation

~CPluginTemplateBase()

CPluginTemplateBase::~CPluginTemplateBase ( )

virtual

Definition at line 14 of file PluginTemplateBase.cpp.

Member Function Documentation

Description()

const QString CPluginTemplateBase::Description ( ) const

overridevirtual

Plugin description.

Implements CPlugin.

Definition at line 37 of file PluginTemplateBase.cpp.

Details()

const QString CPluginTemplateBase::Details ( ) const

overridevirtual

Display more information in About dialog or log.

eg: Include the plugin depends on the library version and description etc.

See also

CPluginFreeRDP::Details()

Implements CPlugin.

Definition at line 58 of file PluginTemplateBase.cpp.

Icon()

const QIcon CPluginTemplateBase::Icon ( ) const

overridevirtual

Implements CPlugin.

Definition at line 52 of file PluginTemplateBase.cpp.

Name()

const QString CPluginTemplateBase::Name ( ) const

overridevirtual

This name must be the same as the project name (${PROJECT_NAME}). The translation file (${PROJECT_NAME}_*.ts)) name is associated with it.

Implements CPlugin.

Definition at line 31 of file PluginTemplateBase.cpp.

OnCreateOperate()

COperate * CPluginTemplateBase::OnCreateOperate ( const QString &  szId )

overrideprotectedvirtual

Implements CPlugin.

Definition at line 64 of file PluginTemplateBase.cpp.

Protocol()

const QString CPluginTemplateBase::Protocol ( ) const

overridevirtual

Plugin Protocol.

Implements CPlugin.

Definition at line 25 of file PluginTemplateBase.cpp.

Type()

const CPlugin::TYPE CPluginTemplateBase::Type ( ) const

overridevirtual

Implements CPlugin.

Definition at line 19 of file PluginTemplateBase.cpp.

Version()

const QString CPluginTemplateBase::Version ( ) const

overridevirtual

Version.

Implements CPlugin.

Definition at line 43 of file PluginTemplateBase.cpp.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/Template/Base/PluginTemplateBase.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/Template/Base/PluginTemplateBase.cpp