ExtensionHost.hpp

Go to the documentation of this file.

 
#pragma once
 
#include "ISettings.hpp"
#include "IUiHost.hpp"
#include "INetworkPolicy.hpp"
#include "IApplicationServices.hpp"
#include "Version.hpp"
#include <QColor>
#include <QObject>
#include <QUrl>
#include <QVariantMap>
#include <functional>
 
namespace OpenSWMM::Sdk
{
class IModelInstance;
class IProject;
 
class IConsole
{
public:
    virtual ~IConsole() = default;
    virtual void append(const QString &level, const QString &text) = 0;
    virtual void clear() = 0;
    virtual void appendLocation(const QString &level, const QString &text, const QString &path,
                                int line) = 0;
    virtual void setLocationHandler(QObject *context,
                                    std::function<void(const QString &, int)> handler) = 0;
};
class IJobContext
{
public:
    virtual ~IJobContext() = default;
    virtual bool isCancelled() const = 0;
    virtual void setProgress(double fraction, const QString &text = {}) = 0;
    virtual void postToMainThread(std::function<void()> callback) = 0;
};
class IJob
{
public:
    virtual ~IJob() = default;
    virtual void cancel() = 0;
    virtual bool isFinished() const = 0;
};
 
class ExtensionHost
{
public:
    virtual ~ExtensionHost() = default;
    virtual CompatibilityManifest manifest() const = 0;
    virtual QString pluginId() const = 0;
    virtual QObject *lifetime() const = 0;
    virtual QList<IProject *> projects() const = 0;
    virtual IProject *activeProject() const = 0;
    virtual QList<IModelInstance *> instances() const = 0;
    virtual IModelInstance *activeInstance() const = 0;
    virtual IUiHost *ui() = 0;
    virtual ISettings *settings() = 0;
    virtual IConsole *console() = 0;
    virtual INetworkPolicy *network() = 0;
    virtual IRunRegistry *runRegistry() = 0;
    virtual IPlotService *plots() = 0;
    virtual IDialogs *dialogs() = 0;
    virtual bool isDark() const = 0;
    virtual QColor themeColor(QPalette::ColorRole role) const = 0;
    virtual QMetaObject::Connection
    observe(QObject *context,
            std::function<void(const QString &event, const QVariantMap &data)> callback) = 0;
    virtual IJob *runJob(const QString &title, std::function<void(IJobContext &)> work,
                         std::function<void(bool ok, const QString &error)> finished = {}) = 0;
    virtual void prepareShutdown() = 0;
};
}