Operate.h

// Author: Kang Lin <kl222@126.com>
 
#pragma once
 
#include <QMessageBox>
#include <QObject>
#include <QMenu>
#include <QClipboard>
#include "ParameterPlugin.h"
 
class CPlugin;
 
class PLUGIN_EXPORT COperate : public QObject
{
    Q_OBJECT
 
public:
    explicit COperate(CPlugin *plugin);
    virtual ~COperate();
    
 
    [[nodiscard]] virtual const QString Id();
    [[nodiscard]] virtual const QString Name();
    [[nodiscard]] virtual const QString Description();
    [[nodiscard]] virtual const QString Protocol() const;
    [[nodiscard]] virtual const qint16 Version() const = 0;
    [[nodiscard]] virtual const QIcon Icon() const;
    [[nodiscard]] virtual const QString GetTypeName() const;
 
    [[nodiscard]] virtual QWidget* GetViewer() = 0;
    [[nodiscard]] virtual int OpenDialogSettings(QWidget* parent = nullptr);
    [[nodiscard]] virtual QMenu* GetMenu(QWidget* parent = nullptr);
 
    enum class SecurityLevel {
        No,                       // No the function
        Secure,                   // Both authentication and channels are secure. Green
        NonSecureAuthentication,  // Non-secure authentication over a secure channel. Blue
        SecureChannel,            // Channel is secure. Yellow
        Normal = SecureChannel, 
        SecureAuthentication,     // There is security verification, not a secure channel. Orange
        Risky                     // Red
    };
    [[nodiscard]] virtual SecurityLevel GetSecurityLevel();
    [[nodiscard]] virtual QString GetSecurityLevelString();
    [[nodiscard]] virtual QColor GetSecurityLevelColor();
    [[nodiscard]] static QString GetSecurityLevelString(SecurityLevel level);
    [[nodiscard]] static QColor GetSecurityLevelColor(SecurityLevel level);
 
public:
    virtual int Start() = 0;
    virtual int Stop() = 0;
 
Q_SIGNALS:
    void sigRunning();
    void sigStop();
    void sigFinished();
 
    void sigViewerFocusIn(QWidget* pView);
    void sigUpdateName(const QString& szName);
    void sigUpdateParameters(COperate* pOperate);
    void sigError(const int nError, const QString &szError);
    void sigInformation(const QString& szInfo);
    void sigShowMessageBox(const QString& title, const QString& message,
                           const QMessageBox::Icon& icon = QMessageBox::Information);
 
protected:
    Q_INVOKABLE virtual int Initial();
    Q_INVOKABLE virtual int Clean();
    Q_INVOKABLE virtual int SetGlobalParameters(CParameterPlugin* pPara) = 0;
 
protected:
    [[nodiscard]] Q_INVOKABLE CPlugin* GetPlugin() const;
 
    static QObject* createObject(const QString &className, QObject* parent = NULL);
 
private:
    [[nodiscard]] virtual QDialog* OnOpenDialogSettings(QWidget* parent = nullptr) = 0;
    
public:
    /* \~chinese 得到配置文件名
     * \~english Get settings file name
     * \see CManager::SaveOperate
     */
    [[nodiscard]] virtual QString GetSettingsFile();
    /* \~chinese 设置配置文件名
     * \~english Set settings file name
     */
    virtual int SetSettingsFile(const QString &szFile);
private:
    QString m_szSettings;
protected:
    virtual int Load(QSettings &set);
    virtual int Save(QSettings &set);
    Q_INVOKABLE virtual int Load(QString szFile = QString());
    Q_INVOKABLE virtual int Save(QString szFile = QString());
 
private Q_SLOTS:
    void slotUpdateName();
 
    virtual void slotBlockShowWidget(const QString& className, int &nRet, void* pContext);
    virtual void slotBlockShowMessageBox(const QString& szTitle,
                                         const QString& szMessage,
                                         QMessageBox::StandardButtons buttons,
                                         QMessageBox::StandardButton& nRet,
                                         bool &checkBox,
                                         QString szCheckBoxContext = QString());
    virtual void slotBlockInputDialog(const QString& szTitle,
                                      const QString& szLable,
                                      const QString& szMessage,
                                      QString& szText
                                      );
 
private Q_SLOTS:
    virtual void slotSetClipboard(QMimeData *data);
private:
Q_SIGNALS:
    void sigClipBoardChanged();
 
protected:
    QMenu m_Menu;
    QAction* m_pActionSettings;
private Q_SLOTS:
    virtual void slotSettings();
 
private:
    CPlugin* m_pPlugin;
};