CPluginWebBrowser Class Reference

Inheritance diagram for CPluginWebBrowser:

Collaboration diagram for CPluginWebBrowser:

Public Member Functions
	CPluginWebBrowser (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	DisplayName () const override
	The plugin display name.
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.
virtual Q_INVOKABLE COperate *	CreateOperate (const QString &szId, CParameterPlugin *para)
	New COperate instance.
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()

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

Additional Inherited Members
Public Types inherited from CPlugin
enum class	TYPE {   RemoteDesktop , Terminal , Client , Service ,   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 5 of file PluginWebBrowser.h.

Constructor & Destructor Documentation

~CPluginWebBrowser()

CPluginWebBrowser::~CPluginWebBrowser ( )

virtual

Definition at line 15 of file PluginWebBrowser.cpp.

Member Function Documentation

CreateOperate()

COperate * CPluginWebBrowser::CreateOperate ( const QString &  szId, CParameterPlugin *  para  )

virtual

New COperate instance.

[CPlugin CreateOperate]

Only is called by CManager

COperate* CManager::CreateOperate(const QString& id)
{
    COperate* pOperate = nullptr;
    auto it = m_Plugins.find(id);
    if(m_Plugins.end() != it)
    {
        bool bRet = 0;
        qDebug(log) << "CreateOperate id:" << id;
        auto plugin = it.value();
        if(plugin) {
            //p = plugin->CreateOperate(id);
            bRet = QMetaObject::invokeMethod(
                plugin,
                "CreateOperate",
                Qt::DirectConnection,
                Q_RETURN_ARG(COperate*, pOperate),
                Q_ARG(QString, id),
                Q_ARG(CParameterPlugin*, m_pParameterPlugin));
            if(!bRet) {
                qCritical(log) << "Create COperate fail.";
                return nullptr;
            }
        }
    }
    return pOperate;
}

Returns

Return COperate pointer, the owner is caller

Note

The function new object pointer, the caller must delete it when don't use it.

Parameters

szId

See also

CManager::CreateOperate CManager::LoadOperate

Reimplemented from CPlugin.

Definition at line 90 of file PluginWebBrowser.cpp.

Description()

const QString CPluginWebBrowser::Description ( ) const

overridevirtual

Plugin description.

Implements CPlugin.

Definition at line 40 of file PluginWebBrowser.cpp.

Details()

const QString CPluginWebBrowser::Details ( ) const

overridevirtual

Display more information in About dialog or log.

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

See also

CPluginFreeRDP::Details()

Reimplemented from CPlugin.

Definition at line 62 of file PluginWebBrowser.cpp.

DisplayName()

const QString CPluginWebBrowser::DisplayName ( ) const

overridevirtual

The plugin display name.

Reimplemented from CPlugin.

Definition at line 35 of file PluginWebBrowser.cpp.

GetSettingsWidget()

QWidget * CPluginWebBrowser::GetSettingsWidget ( QWidget *  parent )

overrideprotectedvirtual

Get the widget to set global parameters for the plugin.

Returns

Sets the parameters widget. Returns nullptr if no parameters are needed. This widget belongs to the caller.

Note

The widget must be a derivative of CParameterUI. Eg: CParameterPluginUI

Usage:

    foreach(auto plugin, m_Plugins) {
        if(!plugin) continue;
        QWidget* pSettings = nullptr;
        bool bRet = QMetaObject::invokeMethod(
            plugin,
            "GetSettingsWidget",
            Qt::DirectConnection,
            Q_RETURN_ARG(QWidget*, pSettings),
            Q_ARG(QWidget*, parent));
        if(!bRet) {
            qCritical(log) << "Call CPlugin::GetSettingsWidget() fail.";
            continue;
        }
        if(!pSettings) continue;
        lstWidget.push_back(pSettings);
    }

See also

CManager::GetSettingsWidgets

Reimplemented from CPlugin.

Definition at line 80 of file PluginWebBrowser.cpp.

Icon()

const QIcon CPluginWebBrowser::Icon ( ) const

overridevirtual

Implements CPlugin.

Definition at line 50 of file PluginWebBrowser.cpp.

Name()

const QString CPluginWebBrowser::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 30 of file PluginWebBrowser.cpp.

OnCreateOperate()

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

overrideprotectedvirtual

Implements CPlugin.

Definition at line 55 of file PluginWebBrowser.cpp.

Protocol()

const QString CPluginWebBrowser::Protocol ( ) const

overridevirtual

Plugin Protocol.

Implements CPlugin.

Definition at line 25 of file PluginWebBrowser.cpp.

Type()

const CPluginWebBrowser::TYPE CPluginWebBrowser::Type ( ) const

overridevirtual

Implements CPlugin.

Definition at line 20 of file PluginWebBrowser.cpp.

Version()

const QString CPluginWebBrowser::Version ( ) const

overridevirtual

Version.

Implements CPlugin.

Definition at line 45 of file PluginWebBrowser.cpp.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/WebBrowser/PluginWebBrowser.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/WebBrowser/PluginWebBrowser.cpp