Inheritance diagram for COperateTemplateBase:

[legend]

Collaboration diagram for COperateTemplateBase:

[legend]

Public Member Functions
	COperateTemplateBase (CPlugin *plugin)

virtual CParameterTemplateBase *	GetParameter () const
	Get parameter.

virtual const qint16	Version () const override

virtual QWidget *	GetViewer () override
	Get Viewer.

virtual int	Start () override
	Start.

virtual int	Stop () override
	Stop.

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	Id ()

virtual const QString	Name ()
	Name.

virtual const QString	Description ()
	Description.

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 CStats *	GetStats ()
	Get statistics.

virtual CSecurityLevel::Levels	GetSecurityLevel () const
	Get Security Level.

Protected Member Functions
virtual int	SetPluginParameters (CParameterPlugin *pPara) override
	Apply the parameters of the plug-in.

virtual Q_INVOKABLE CBackend *	InstanceBackend ()

virtual Q_INVOKABLE int	Initial () override
	Initial parameters and resource.

virtual Q_INVOKABLE int	Clean () override
	Clean parameters and resource.

virtual int	Load (QSettings &set) override
	Load parameters.

virtual int	Save (QSettings &set) override
	Save parameters.

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.

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

Private Attributes
CParameterTemplateBase *	m_pPara

CFrmViewerTemplateBase *	m_pViewer

CBackendThread *	m_pThread

Additional Inherited Members
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.

Protected Slots inherited from COperate
void	slotUpdateName ()

void	slotSetSecurityLevel (CSecurityLevel::Levels level)

Static Protected Member Functions inherited from COperate
static QObject *	createObject (const QString &className, QObject *parent=NULL)
	Create Object.

Protected Attributes inherited from COperate
QMenu	m_Menu

QAction *	m_pActionSettings

Detailed Description

Definition at line 11 of file OperateTemplateBase.h.

Constructor & Destructor Documentation

◆ ~COperateTemplateBase()

COperateTemplateBase::~COperateTemplateBase ( )

virtual

Definition at line 22 of file OperateTemplateBase.cpp.

Member Function Documentation

◆ Clean()

int COperateTemplateBase::Clean ( )

overrideprotectedvirtual

Clean parameters and resource.

See also: CManager::DeleteOperate

Reimplemented from COperate.

Definition at line 128 of file OperateTemplateBase.cpp.

◆ GetParameter()

CParameterTemplateBase * COperateTemplateBase::GetParameter ( ) const

virtual

Get parameter.

Definition at line 34 of file OperateTemplateBase.cpp.

◆ GetViewer()

QWidget * COperateTemplateBase::GetViewer ( )

overridevirtual

Get Viewer.

Returns: QWidget*: the ownership is a instance of this class or its derivative class

Note: If you implement the view yourself, you need to disable the view at the beginning and allow the view after sigRun.

See also: sigRunning CFrmViewer::CFrmViewer

Implements COperate.

Definition at line 45 of file OperateTemplateBase.cpp.

◆ Initial()

int COperateTemplateBase::Initial ( )

overrideprotectedvirtual

Initial parameters and resource.

Note: Call before Load()

See also: CManager::CreateOperate Load

Reimplemented from COperate.

Definition at line 114 of file OperateTemplateBase.cpp.

◆ InstanceBackend()

CBackend * COperateTemplateBase::InstanceBackend ( )

protectedvirtual

Definition at line 76 of file OperateTemplateBase.cpp.

◆ Load()

int COperateTemplateBase::Load ( QSettings & set )

overrideprotectedvirtual

Load parameters.

Implements COperate.

Definition at line 96 of file OperateTemplateBase.cpp.

◆ OnOpenDialogSettings()

QDialog * COperateTemplateBase::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 91 of file OperateTemplateBase.cpp.

◆ Save()

int COperateTemplateBase::Save ( QSettings & set )

overrideprotectedvirtual

Save parameters.

Implements COperate.

Definition at line 106 of file OperateTemplateBase.cpp.

◆ SetPluginParameters()

int COperateTemplateBase::SetPluginParameters ( CParameterPlugin * pPara )

overrideprotectedvirtual

Apply the parameters of the plug-in.

Note: Call CParameterOperate::SetPluginParameters to set the global parameters for the operation parameters, and connect the signals related to the global parameters.

int COperateDesktop::SetPluginParameters(CParameterPlugin *pPara)
{
    if(GetParameter()) {
        GetParameter()->SetPluginParameters(pPara);
 
        if(pPara) {
            bool check = connect(pPara, SIGNAL(sigNameStylesChanged()),
                                 this, SLOT(slotUpdateName()));
            Q_ASSERT(check);
        }
 
        LoadAdaptWindows();
        return 0;
    } else {
        QString szMsg = "There is not parameters! "
                        "please first create parameters, "
                        "then call SetParameter() in the ";
        szMsg += metaObject()->className() + QString("::")
                 + metaObject()->className();
        szMsg += QString("() or ") + metaObject()->className()
                 + QString("::") + "Initial()";
        szMsg += " to set the parameters pointer. "
                 "Default set CParameterClient for the parameters of operate "
                 "(CParameterOperate or its derived classes) "
                 "See CManager::CreateOperate. "
                 "If you are sure the parameter of operate "
                 "does not need CParameterClient. "
                 "Please overload the SetPluginParameters() in the ";
        szMsg += QString(metaObject()->className()) + " . don't set it";
        qCritical(log) << szMsg.toStdString().c_str();
        Q_ASSERT(false);
    }
    return -1;
}

See also: CManager::CreateOperate CParameterPlugin

Implements COperate.

Definition at line 81 of file OperateTemplateBase.cpp.

◆ Start()

int COperateTemplateBase::Start ( )

overridevirtual

Start.

Note: Only call by user, The plugin don't call it. When plugin is started, it emit sigRunning()

See also: sigRunning()

Implements COperate.

Definition at line 50 of file OperateTemplateBase.cpp.

◆ Stop()

int COperateTemplateBase::Stop ( )

overridevirtual

Stop.

Note: Only call by user, The plugin don't call it. When plugin is stopped, it emit sigFinished(). The caller receive the signal, then delete the object.

See also: sigFinished()

Implements COperate.

Definition at line 63 of file OperateTemplateBase.cpp.

◆ Version()

const qint16 COperateTemplateBase::Version ( ) const

overridevirtual

Implements COperate.

Definition at line 39 of file OperateTemplateBase.cpp.

Member Data Documentation

◆ m_pPara

CParameterTemplateBase* COperateTemplateBase::m_pPara

private

Definition at line 42 of file OperateTemplateBase.h.

◆ m_pThread

CBackendThread* COperateTemplateBase::m_pThread

private

Definition at line 44 of file OperateTemplateBase.h.

◆ m_pViewer

CFrmViewerTemplateBase* COperateTemplateBase::m_pViewer

private

Definition at line 43 of file OperateTemplateBase.h.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/Template/Base/OperateTemplateBase.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/Template/Base/OperateTemplateBase.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~COperateTemplateBase()

Member Function Documentation

◆ Clean()

◆ GetParameter()

◆ GetViewer()

◆ Initial()

◆ InstanceBackend()

◆ Load()

◆ OnOpenDialogSettings()

◆ Save()

◆ SetPluginParameters()

◆ Start()

◆ Stop()

◆ Version()

Member Data Documentation

◆ m_pPara

◆ m_pThread

◆ m_pViewer