AbstractItomDesignerPlugin.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2020, Institut fuer Technische Optik (ITO),
    Universitaet Stuttgart, Germany

    This file is part of itom and its software development toolkit (SDK).

    itom is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public Licence as published by
    the Free Software Foundation; either version 2 of the Licence, or (at
    your option) any later version.
   
    In addition, as a special exception, the Institut fuer Technische
    Optik (ITO) gives you certain additional rights.
    These rights are described in the ITO LGPL Exception version 1.0,
    which can be found in the file LGPL_EXCEPTION.txt in this package.

    itom is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library
    General Public Licence for more details.

    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************** */

#ifndef ABSTRACTITOMDESIGNERPLUGIN_H
#define ABSTRACTITOMDESIGNERPLUGIN_H

#include "plotCommon.h"
#include "../common/sharedStructuresGraphics.h"
#include "AbstractFigure.h"
#include "designerPluginInterfaceVersion.h"

#include <QtUiPlugin/QDesignerCustomWidgetInterface>

#if !defined(Q_MOC_RUN) || defined(ITOMCOMMONPLOT_MOC) //only moc this file in itomCommonQtLib but not in other libraries or executables linking against this itomCommonQtLib
    
namespace ito {

    class ITOMCOMMONPLOT_EXPORT AbstractItomDesignerPlugin : public QObject, public QDesignerCustomWidgetInterface
    {
        Q_OBJECT
        
        Q_INTERFACES(QDesignerCustomWidgetInterface)

        public:
            AbstractItomDesignerPlugin(QObject *parent) :
                QObject(parent),
                QDesignerCustomWidgetInterface(),
                m_plotFeatures(ito::Static), 
                m_version(0),
                m_author(""),
                m_description(""),
                m_detaildescription(""),
                m_aboutThis(""),
                m_license("LGPL with ITO itom-exception") {}

            virtual ~AbstractItomDesignerPlugin() {}

            inline ito::PlotDataTypes getPlotDataTypes(void) const { return m_plotDataTypes; }
            inline ito::PlotDataFormats getPlotDataFormats(void) const { return m_plotDataFormats; }
            inline ito::PlotFeatures getPlotFeatures(void) const { return m_plotFeatures; }

            inline int getVersion(void) const { return m_version; }
            const QString getAuthor(void) const { return m_author; }
            const QString getDescription(void) const { return m_description; }
            const QString getDetailDescription(void) const { return m_detaildescription; }
            const QString getLicenseInfo(void) const { return m_license; }
            const QString getAboutInfo(void) const { return m_aboutThis; }

            inline void setItomSettingsFile(const QString &settingsFile) { m_itomSettingsFile = settingsFile; }

            virtual QWidget *createWidgetWithMode(AbstractFigure::WindowMode winMode, QWidget *parent) = 0;

        protected:
            ito::PlotDataTypes   m_plotDataTypes;
            ito::PlotDataFormats m_plotDataFormats;
            ito::PlotFeatures    m_plotFeatures;
            
            int m_version;                        
            QString m_author;                     
            QString m_description;                
            QString m_detaildescription;          
            QString m_license;                    
            QString m_aboutThis;                  
            QString m_itomSettingsFile;
    };
} // namepsace ito

#endif //#if !defined(Q_MOC_RUN) || defined(ITOMCOMMONQT_MOC)

#endif // ABSTRACTITOMDESIGNERPLUGIN_H