OSUToolboxPlugin.h

/*
 * Your License or Copyright can go here
 */

#pragma once

#include <QtCore/QObject>
#include <QtCore/QSettings>

#include "SIMPLib/Plugin/ISIMPLibPlugin.h"

#include "OSUToolbox/OSUToolboxDLLExport.h"

/**
 * @brief The OSUToolboxPlugin class
 */
class OSUToolbox_EXPORT OSUToolboxPlugin : public QObject, public ISIMPLibPlugin
{
    Q_OBJECT
    Q_INTERFACES(ISIMPLibPlugin)
    Q_PLUGIN_METADATA(IID "com.your.domain.OSUToolboxPlugin")

  public:
    OSUToolboxPlugin();
   ~OSUToolboxPlugin() override;
    
  /**
    * @brief Returns the name of the plugin that appears on the file system. 
    * 
    * Note that if the build is a debug build there will be a _Plugin postfix
    * to the filename.
    */
    QString getPluginFileName() override;

    /**
    * @brief getPluginDisplayName The name that should be used for human facing
    * labels and display strings
    * @return 
    */
    QString getPluginDisplayName() override;
    
    /**
    * @brief getPluginBaseName The Name of the plugin.
    * 
    * This typically will NOT have the Plugin suffix.
    * @return 
    */
    QString getPluginBaseName() override;

    /**
     * @brief getVersion Returns the version
     */
    QString getVersion() override;

     /**
     * @brief getCompatibilityVersion Returns the compatibility version
     */
    QString getCompatibilityVersion() override;

     /**
     * @brief getVendor Returns the name of the vendor
     */
    QString getVendor() override;

    /**
     * @brief getURL Returns the URL of the plugin
     */
    QString getURL() override;

    /**
     * @brief getLocationReturns the location of the plugin
     */
    QString getLocation() override;

    /**
     * @brief getDescription Returns the description of the plugin
     * PLEASE UPDATE YOUR PLUGIN'S DESCRIPTION FILE.
     * It is located at OSUToolbox/Resources/OSUToolbox/OSUToolboxDescription.txt
     */
    QString getDescription() override;

    /**
     * @brief getCopyright Returns the copyright of the plugin
     */
    QString getCopyright() override;

    /**
     * @brief getLicense Returns the license of the plugin
     * PLEASE UPDATE YOUR PLUGIN'S LICENSE FILE.
     * It is located at OSUToolbox/Resources/OSUToolbox/OSUToolboxLicense.txt
     */
    QString getLicense() override;

    /**
     * @brief getFilters Returns the filters of the plugin
     */
    QList<QString> getFilters() override;

    /**
     * @brief getThirdPartyLicenses Returns the third party licenses of the plugin
     */
    QMap<QString, QString> getThirdPartyLicenses() override;

    /**
     * @brief getDidLoad Returns the load status of the plugin
     */
    bool getDidLoad() override;

    /**
     * @brief setDidLoad Sets the load status of the plugin
     * @param didLoad Boolean value to set status
     */
    void setDidLoad(bool didLoad) override;

    /**
     * @brief setLocation Sets the location of the plugin on the file system.
     * This is required so that we can cache the file path information
     * as the plugin is loaded.
     * @param filePath File path
     */
    void setLocation(QString filePath) override;

    /**
     * @brief registerFilterWidgets Register all the filters with the FilterWidgetFactory
     * @param fwm FilterWidgetManager instance pointer
     */
    void registerFilterWidgets(FilterWidgetManager* fwm) override;

    /**
    * @brief registerFilters Registers the filters that this plugin implements with the Filter Manager that is passed in
    * @param fm FilterManager instance pointer
    */
    void registerFilters(FilterManager* fm) override;


    /**
     * @brief writeSettings Writes the settings in the input gui to the Application's preference file
     * @param prefs QSettings reference variable
     */
    void writeSettings(QSettings& prefs) override;

    /**
     * @brief readSettings Reads the settings from the Application's preference file and sets
     * the input GUI widgets accordingly.
     * @param prefs QSettings reference variable
     */
    void readSettings(QSettings& prefs) override;

  private:
    QString             m_Version;
    QString             m_CompatibilityVersion;
    QString             m_Vendor;
    QString             m_URL;
    QString             m_Location;
    QString             m_Description;
    QString             m_Copyright;
    QList<QString>      m_Filters;
    bool                m_DidLoad;

    OSUToolboxPlugin(const OSUToolboxPlugin&); // Copy Constructor Not Implemented
    void operator=(const OSUToolboxPlugin&); // Operator '=' Not Implemented
};