abstractAddInConfigDialog.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2016, 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 ABSTRACTADDINCONFIGDIALOG_H
#define ABSTRACTADDINCONFIGDIALOG_H

#include "retVal.h"
#include "typeDefs.h"
#include "sharedStructuresQt.h"
#include "commonGlobal.h"
#include "../common/interval.h"
#include "../common/qtMetaTypeDeclarations.h"

#if QT_VERSION < 0x050000
#include <qdialog.h>
#else
#include <QtWidgets/qdialog.h>
#endif
#include <qmap.h>
#include <qsharedpointer.h>





//forward declarations
namespace ito
{
    class AddInBase; //forward declaration
    class AbstractAddInConfigDialogPrivate; //forward declaration

    //----------------------------------------------------------------------------------------------------------------------------------
    class ITOMCOMMONQT_EXPORT AbstractAddInConfigDialog : public QDialog
    {
        Q_OBJECT

        public:
            AbstractAddInConfigDialog(ito::AddInBase *plugin);

            virtual ~AbstractAddInConfigDialog();
            
            enum MessageLevel 
            {
                msgLevelNo = 0,          
                msgLevelErrorOnly = 1,   
                msgLevelWarningOnly = 2, 
                msgLevelWarningAndError = msgLevelErrorOnly | msgLevelWarningOnly 
            };


            virtual ito::RetVal applyParameters() = 0;
        
        protected:

            virtual ito::RetVal setPluginParameter(QSharedPointer<ito::ParamBase> param, MessageLevel msgLevel = msgLevelWarningAndError);


            virtual ito::RetVal setPluginParameters(const QVector<QSharedPointer<ito::ParamBase> > params, MessageLevel msgLevel = msgLevelWarningAndError);
            

            virtual ito::RetVal observeInvocation(ItomSharedSemaphore *waitCond, MessageLevel msgLevel) const;

            QMap<QString, ito::Param> m_currentParameters; 
        private:
            AbstractAddInConfigDialogPrivate* d; 
        public slots:

            virtual void parametersChanged(QMap<QString, ito::Param> params) = 0;
    };
} //end namespace ito

#endif //ABSTRACTADDINCONFIGDIALOG_H