IUiHost.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <QAction>
#include <QJsonObject>
#include <QList>
#include <QStringList>
#include <QWidget>
#include <functional>
 
namespace OpenSWMM::Sdk
{
class ExtensionHost;
class IModelInstance;
class ISettings;
 
struct RibbonGroupSpec {
    QString caption;       
    QStringList actionIds; 
};
struct RibbonTabSpec {
    QString id;                    
    QString title;                 
    bool contextual = false;       
    QList<RibbonGroupSpec> groups; 
};
 
class IDockPanelFactory
{
public:
    virtual ~IDockPanelFactory() = default;
    virtual QString id() const = 0;
    virtual QString title() const = 0;
    virtual Qt::DockWidgetArea defaultArea() const { return Qt::RightDockWidgetArea; }
    virtual QString tabifyWith() const { return {}; }
    virtual QWidget *create(ExtensionHost *host) = 0;
};
class IDocumentViewFactory
{
public:
    virtual ~IDocumentViewFactory() = default;
    virtual QString kind() const = 0;
    virtual bool accepts(IModelInstance *instance) const = 0;
    virtual QWidget *create(IModelInstance *instance, ExtensionHost *host) = 0;
    virtual QJsonObject saveState(QWidget *view) const = 0;
    virtual void restoreState(QWidget *view, const QJsonObject &state) = 0;
};
class IPreferencesPageFactory
{
public:
    virtual ~IPreferencesPageFactory() = default;
    virtual QString id() const = 0;
    virtual QString title() const = 0;
    virtual QWidget *create(ISettings *settings) = 0;
    virtual void apply() = 0;
    virtual void reset() = 0;
};
 
class IUiHost
{
public:
    virtual ~IUiHost() = default;
    virtual bool registerAction(const QString &id, QAction *action) = 0;
    virtual void unregisterAction(const QString &id) = 0;
    virtual bool registerRibbonTab(const RibbonTabSpec &tab) = 0;
    virtual void unregisterRibbonTab(const QString &id) = 0;
    virtual bool registerDockPanelFactory(IDockPanelFactory *factory) = 0;
    virtual void unregisterDockPanelFactory(const QString &id) = 0;
    virtual bool registerDocumentViewFactory(IDocumentViewFactory *factory) = 0;
    virtual void unregisterDocumentViewFactory(const QString &kind) = 0;
    virtual QWidget *openDocumentView(const QString &kind, IModelInstance *instance) = 0;
    virtual bool registerPreferencesPage(IPreferencesPageFactory *factory) = 0;
    virtual void unregisterPreferencesPage(const QString &id) = 0;
    virtual void showDock(const QString &id) = 0;
    virtual void statusMessage(const QString &text, int milliseconds = 5000) = 0;
    virtual void message(const QString &title, const QString &text) = 0;
    virtual void postToMainThread(std::function<void()> callback) = 0;
    virtual QWidget *mainWindow() const = 0;
};
}