AppModuleInterface.h

Go to the documentation of this file.

#pragma once
 
#include <QAbstractItemModel>
#include <QDockWidget>
#include <QMimeType>
#include <QObject>
#include <QSettings>
#include <ami/iface/AppModuleFileType.h>
#include <ami/iface/MultiDocInterface.h>
#include <ami/iface/global.h>
#include <bitset>
#include <misc/gen/TClassRegistration.h>
#include <misc/qt/PropertySheetDialog.h>
 
class QMainWindow;
 
namespace sf
{
 
class _AMI_CLASS AppModuleInterface : public QObject
{
  public:
    struct Parameters
    {
        explicit Parameters(QSettings* settings, QObject* parent)
          : _settings(settings)
          , _parent(parent)
        {}
 
        QSettings* _settings;
        QObject* _parent;
    };
 
    explicit AppModuleInterface(const Parameters&);
 
    ~AppModuleInterface() override;
 
    static void instantiate(QSettings* settings, QObject* parent);
 
    enum InitializeStage
    {
      Uninitialize = 0,
      Initialize,
      Finalize,
    };
    static size_t initializeInstances(InitializeStage stage);
 
    static void addAllPropertyPages(PropertySheetDialog* sheet);
 
    enum MenuType
    {
      Settings,
      View,
      Tools
    };
 
    static void addAllMenuItems(MenuType menuType, QMenu* menu);
 
    typedef QMap<QString, AppModuleInterface*> Map;
 
    [[nodiscard]] static const Map& getMap();
 
    virtual void initialize(InitializeStage stage) = 0;
 
    [[nodiscard]] virtual QString getName() const = 0;
 
    [[nodiscard]] virtual QString getDescription() const = 0;
 
    [[nodiscard]] virtual QString getLibraryFilename() const = 0;
 
    [[nodiscard]] virtual QString getSvgIconResource() const;
 
    virtual void addPropertyPages(PropertySheetDialog* sheet) = 0;
 
    virtual void addMenuItems(MenuType menuType, QMenu* menu);
 
    typedef QList<QDockWidget*> DockWidgetList;
 
    virtual DockWidgetList createDockingWidgets(QWidget* parent);
 
    static DockWidgetList createAllDockingWidgets(QWidget* parent);
 
    virtual void addToolBars(QMainWindow* mainWindow);
 
    static void addAllToolBars(QMainWindow* mainWindow);
 
    [[nodiscard]] bool hasFileTypes() const;
 
    void addFileType(const QString& name, const QString& suffix);
 
    void addFileType(const QString& mime);
 
    void addFileType(const QMimeType& mime);
 
    static AppModuleInterface* findByFile(const QString& filename);
 
    [[nodiscard]] QString getFileTypeFilters() const;
 
    static QString getFileTypeFilters(bool all_files);
 
    static AppModuleInterface* selectDialog(const QString& title, QSettings* settings, QWidget* parent = nullptr);
 
    [[nodiscard]] static QAbstractItemModel* getListModel(bool file_only, QObject* parent);
 
    [[nodiscard]] MultiDocInterface* createChild(QWidget* parent) const;
 
    [[nodiscard]] QSettings* getSettings() const;
 
    MultiDocInterface* openFile(const QString& filename, AppModuleInterface* ami = nullptr) const;
 
    virtual void documentActivated(MultiDocInterface* iface, bool yn) const;
 
    typedef TClosure<MultiDocInterface*, const QString&, AppModuleInterface*> OpenFileClosure;
    static OpenFileClosure callbackOpenFile;
 
  protected:
    [[nodiscard]] virtual MultiDocInterface* createWidget(QWidget* parent) const;
 
  private:
    QSettings* _settings;
    QList<AppModuleFileType> _fileTypes;
    InitializeStage _initializeStage;
    static Map _map;
 
    // Declarations of static functions and data members to be able to create implementations.
    SF_DECL_IFACE(AppModuleInterface, AppModuleInterface::Parameters, Interface)
};
 
}// namespace sf