COperateWebBrowser Class Reference

Inheritance diagram for COperateWebBrowser:

Collaboration diagram for COperateWebBrowser:

Public Member Functions
	COperateWebBrowser (CPlugin *plugin)
virtual const QString	Name () override
	Name.
virtual const QIcon	Icon () const override
virtual const qint16	Version () const override
virtual QWidget *	GetViewer () override
	Get Viewer.
virtual QMenu *	GetMenu (QWidget *parent=nullptr) override
	Get menu.
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 const QString	Id ()
virtual const QString	Description ()
	Description.
virtual const QString	Protocol () 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	SetGlobalParameters (CParameterPlugin *pPara) override
	Apply the global parameters of the plug-in.
virtual int	Initial () override
	Initial parameters and resource.
virtual 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
CFrmWebBrowser *	m_pWeb
CParameterWebBrowser	m_Parameter

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 9 of file OperateWebBrowser.h.

Constructor & Destructor Documentation

~COperateWebBrowser()

COperateWebBrowser::~COperateWebBrowser ( )

virtual

Definition at line 16 of file OperateWebBrowser.cpp.

Member Function Documentation

Clean()

int COperateWebBrowser::Clean ( )

overrideprotectedvirtual

Clean parameters and resource.

See also

CManager::DeleteOperate

Reimplemented from COperate.

Definition at line 110 of file OperateWebBrowser.cpp.

GetMenu()

QMenu * COperateWebBrowser::GetMenu ( QWidget *  parent = nullptr )

overridevirtual

Get menu.

Reimplemented from COperate.

Definition at line 54 of file OperateWebBrowser.cpp.

GetViewer()

QWidget * COperateWebBrowser::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 49 of file OperateWebBrowser.cpp.

Icon()

const QIcon COperateWebBrowser::Icon ( ) const

overridevirtual

Reimplemented from COperate.

Definition at line 34 of file OperateWebBrowser.cpp.

Initial()

int COperateWebBrowser::Initial ( )

overrideprotectedvirtual

Initial parameters and resource.

Note

Call before Load()

See also

CManager::CreateOperate Load

Reimplemented from COperate.

Definition at line 74 of file OperateWebBrowser.cpp.

Load()

int COperateWebBrowser::Load ( QSettings &  set )

overrideprotectedvirtual

Load parameters.

Implements COperate.

Definition at line 142 of file OperateWebBrowser.cpp.

Name()

const QString COperateWebBrowser::Name ( )

overridevirtual

Name.

const QString COperateDesktop::Name()
{
    QString szName;
    // Show the name of parameter
    if(GetParameter() && !(GetParameter()->GetName().isEmpty()))
        szName += GetParameter()->GetName();
    else {
        // Show the prefix of protocol
        if(GetParameter() && GetParameter()->GetGlobalParameters()
            && (GetParameter()->GetGlobalParameters()->GetNameStyles()
                & CParameterPlugin::NameStyle::Protocol)
            && !Protocol().isEmpty())
            szName = Protocol() + ":";
        // Show the server name
        szName += ServerName();
    }
 
    // Show the prefix of security level
    QString szSecurityLevel;
    CSecurityLevel sl(GetSecurityLevel());
    if((GetParameter()->GetGlobalParameters()->GetNameStyles()
         & CParameterPlugin::NameStyle::SecurityLevel)
        && !(GetSecurityLevel() & CSecurityLevel::Level::No)
        && !sl.GetUnicodeIcon().isEmpty())
        szSecurityLevel = sl.GetUnicodeIcon().left(2);
 
    return szSecurityLevel + szName;
}

See also

COperateDesktop::Name()

Reimplemented from COperate.

Definition at line 21 of file OperateWebBrowser.cpp.

OnOpenDialogSettings()

QDialog * COperateWebBrowser::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 68 of file OperateWebBrowser.cpp.

Save()

int COperateWebBrowser::Save ( QSettings &  set )

overrideprotectedvirtual

Save parameters.

Implements COperate.

Definition at line 151 of file OperateWebBrowser.cpp.

SetGlobalParameters()

int COperateWebBrowser::SetGlobalParameters ( CParameterPlugin *  pPara )

overrideprotectedvirtual

Apply the global parameters of the plug-in.

Note

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

int COperateDesktop::SetGlobalParameters(CParameterPlugin *pPara)
{
    if(GetParameter()) {
        GetParameter()->SetGlobalParameters(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 SetGlobalParameters() 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 61 of file OperateWebBrowser.cpp.

Start()

int COperateWebBrowser::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 121 of file OperateWebBrowser.cpp.

Stop()

int COperateWebBrowser::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 132 of file OperateWebBrowser.cpp.

Version()

const qint16 COperateWebBrowser::Version ( ) const

overridevirtual

Implements COperate.

Definition at line 44 of file OperateWebBrowser.cpp.

Member Data Documentation

m_Parameter

CParameterWebBrowser COperateWebBrowser::m_Parameter

private

Definition at line 40 of file OperateWebBrowser.h.

m_pWeb

CFrmWebBrowser* COperateWebBrowser::m_pWeb

private

Definition at line 39 of file OperateWebBrowser.h.

---

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

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