CBackendTemplateBase Class Reference

Inheritance diagram for CBackendTemplateBase:

Collaboration diagram for CBackendTemplateBase:

Public Member Functions
	CBackendTemplateBase (COperateTemplateBase *pOperate=nullptr, bool bStopSignal=true)
Public Member Functions inherited from CBackend
	CBackend (COperate *pOperate=nullptr, bool bStopSignal=true)
	CBackend.
virtual int	Start ()
	Start.
virtual int	Stop ()
	Stop.
virtual int	WakeUp ()
	Wake up backend thread(background thread).

Protected Member Functions
virtual OnInitReturnValue	OnInit () override
	Initialization.
virtual int	OnClean () override
	Clean.
virtual int	OnProcess () override
	Specific operation processing of plug-in.

Additional Inherited Members
Signals inherited from CBackend
void	sigRunning ()
	Emitted when the plugin is successfully started.
void	sigStop ()
	Notify the user to stop.
void	sigFinished ()
	Successful stopped signal.
void	sigError (const int nError, const QString &szError=QString())
	Triggered when an error is generated.
void	sigInformation (const QString &szInfo)
	Triggering from a background thread displays information in the main thread without blocking the background thread.
void	sigShowMessageBox (const QString &szTitle, const QString &szMessage, 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	sigBlockShowMessageBox (const QString &szTitle, const QString &szMessage, QMessageBox::StandardButtons buttons, QMessageBox::StandardButton &nRet, bool &checkBox, QString checkBoxContext=QString())
	Block background threads and display message dialogs in foreground threads (QMessageBox)
void	sigBlockInputDialog (const QString &szTitle, const QString &szLable, const QString &szMessage, QString &szText)
	Block background threads and display input dialogs in foreground threads (QInputDialog)
void	sigBlockShowWidget (const QString &className, int &nRet, void *pContext)
	Blocks the background thread and displays the window in the foreground thread.
void	sigSecurityLevel (CSecurityLevel::Levels level)
	Triggered when the security level changes.
Protected Types inherited from CBackend
enum class	OnInitReturnValue { Fail = -1 , Success = 0 , UseOnProcess = Success , NotUseOnProcess = 1 }
Protected Slots inherited from CBackend
virtual void	slotTimeOut ()
	a non-Qt event loop (that is, normal loop processing)， It call OnProcess(), and start timer.

Detailed Description

Definition at line 7 of file BackendTemplateBase.h.

Constructor & Destructor Documentation

~CBackendTemplateBase()

CBackendTemplateBase::~CBackendTemplateBase ( )

virtual

Definition at line 13 of file BackendTemplateBase.cpp.

Member Function Documentation

OnClean()

int CBackendTemplateBase::OnClean ( )

overrideprotectedvirtual

Clean.

See also

Stop()

Implements CBackend.

Definition at line 45 of file BackendTemplateBase.cpp.

OnInit()

CBackend::OnInitReturnValue CBackendTemplateBase::OnInit ( )

overrideprotectedvirtual

Initialization.

Returns

CBackend::OnInitReturnValue

• OnInitReturnValue::Fail: error
• OnInitReturnValue::Success/OnInitReturnValueUseOnProcess: Use OnProcess() (non-Qt event loop)
• OnInitReturnValue::NotUseOnProcess: Don't use OnProcess() (qt event loop)

See also

Start()

Implements CBackend.

Definition at line 34 of file BackendTemplateBase.cpp.

OnProcess()

int CBackendTemplateBase::OnProcess ( )

overrideprotectedvirtual

Specific operation processing of plug-in.

Returns

• >= 0: continue, Interval call time (msec)
• = -1: stop
• < -1: error code

See also

Start() slotTimeOut()

Reimplemented from CBackend.

Definition at line 70 of file BackendTemplateBase.cpp.

---

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

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