qxplugincontext.h

浏览该文件的文档.

 
#ifndef QXPLUGINCONTEXT_H
#define QXPLUGINCONTEXT_H
 
#include "qxplugin_global.h"
 
#include "qxcore/qxsettings.h"
 
#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtGui/QIcon>
#include <QtWidgets/QWidget>
 
QX_PLUGIN_BEGIN_NAMESPACE
 
class QX_PLUGIN_EXPORT QxPluginContext
{
public:
    virtual ~QxPluginContext();
 
    enum DockArea {
        LeftDock = 0x1,
        RightDock = 0x2,
        TopDock = 0x4,
        BottomDock = 0x8
    };
 
    enum class ToastLevel {
        Information,
        Success,
        Warning,
        Error
    };
 
    // Pages -----------------------------------------------------------------
    virtual void addPage(const QString &id, const QIcon &icon, const QString &title, QWidget *page) = 0;
    virtual void setCurrentPage(const QString &id) = 0;
    virtual QString currentPageId() const = 0;
 
    // Docks -----------------------------------------------------------------
    virtual QWidget *addDock(DockArea area, const QString &id, const QString &title, QWidget *widget) = 0;
 
    // Status bar ------------------------------------------------------------
    virtual void setStatusMessage(const QString &message) = 0;
    virtual void setBusy(bool busy) = 0;
    virtual void setProgressRange(int minimum, int maximum) = 0;
    virtual void setProgress(int value) = 0;
    virtual void clearProgress() = 0;
 
    // Notifications ---------------------------------------------------------
    virtual void showToast(const QString &text, ToastLevel level = ToastLevel::Information, int timeoutMs = -1) = 0;
 
    // Config ----------------------------------------------------------------
    virtual QX_CORE_PREPEND_NAMESPACE(QxSettings) * settings() const = 0;
};
 
QX_PLUGIN_END_NAMESPACE
 
#endif   // QXPLUGINCONTEXT_H