taskSetVariableWidget.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#ifdef WIN32
   #if !defined(_DEBUG)
      #define QT_NO_DEBUG 
   #endif
#else
   #define QT_NO_DEBUG 
#endif

#include <vrvUtil/signalslib.h>
#include <vrfGuiDataEntryWidgets/vrfGuiDataEntryWidgets.h>
#include <vrvCore/DtSimEntry.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtUnicode.h>
#include <boost/signals2.hpp>

#include <QtWidgets/QWidget>
#include <set>

#define CHECK_AND_CONVERT(variable, function) if (variable == 0xFFFFFFFF) variable = myRange.variable(); else variable = function(variable, mySelection); 
#define CHECK_AND_CONVERT_APPLICATION(variable, function) if (variable == 0xFFFFFFFF) variable = myRange.variable(); else variable = function(variable); 

class DtString;
class QSpacerItem;
class QVBoxLayout;
class QLabel;
class QFrame;
class QGridLayout;
class QHBoxLayout;
class DtReaderWriter;
class QRadioButton;
class QDomElement;
class QDesignerFormEditorInterface;
class QXmlStreamWriter;
class DtScriptedTaskVariable;

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   class DtScriptedTaskVariableLayoutConverter;
   class DtScriptedTaskDialog;

   class DT_DLL_VRFGUIDATAENTRYWIDGETS DtRange : public QObject
   {
      Q_OBJECT
      Q_PROPERTY(qreal top READ top WRITE setTop)
      Q_PROPERTY(qreal bottom READ bottom WRITE setBottom)

   public:
      DtRange() : myBottom(-100000.), myTop(100000) {};
      DtRange(const DtRange& orig) : myBottom(orig.myBottom), myTop(orig.myTop) {};
      DtRange& operator=(const DtRange& rhs) { myBottom = rhs.myBottom; myTop = rhs.myTop; return *this; };

      qreal top() const { return myTop; };
      qreal bottom() const { return myBottom; };
      void setTop(qreal t) { myTop = t; };
      void setBottom(qreal b) { myBottom = b; };

   public:
      double myTop;
      double myBottom;
   };

   class DT_DLL_VRFGUIDATAENTRYWIDGETS DtTaskSetVariableWidgetExtensionInterface : public QWidget
   {
   public:
      DtTaskSetVariableWidgetExtensionInterface(makVrv::DtDe& de, QWidget* parent, const Qt::WindowFlags& flags = 0);
      virtual ~DtTaskSetVariableWidgetExtensionInterface();

      virtual int setFrom(const DtScriptedTaskVariable&, QGridLayout* parentLayout, int startRow) = 0;

      virtual void setTo(DtScriptedTaskVariable&) const = 0;

      virtual bool isValid()
      {
         return true;
      }

      virtual void setReadOnly(bool) = 0;

   protected:
      makVrv::DtDe& myDe;
   };

   class DT_DLL_VRFGUIDATAENTRYWIDGETS DtTaskSetVariableWidgetInterface
   {
   public:
      enum CreationFlags
      {
         NormalMode = 0x00000000,
         QtDesignerMode = 0x00000001
      };

      DtTaskSetVariableWidgetInterface() {};

      //DTOR
      virtual ~DtTaskSetVariableWidgetInterface() {};

      virtual void setLabel(const std::string&) = 0;
      virtual void setLabel(const QString&) = 0;

      virtual void setToolTip(const QString&) = 0;

      virtual void setTopLineVisible(bool)
      {
      }

      virtual bool topLineVisible() const
      {
         return false;
      }

      virtual bool isValid() const = 0;

      virtual void setRange(double bottom, double top) = 0;

      virtual void setDefaultValue(const std::string&) = 0;

      virtual void setVariableData(const std::string&) = 0;

      virtual void setupFrom(const std::vector<makVrv::DtSimEntry*>& data) = 0;

      virtual DtReaderWriter* createBoundVariable(const std::string& variableName) = 0;

      virtual void setupFromBoundVariable(const DtReaderWriter* variableName) = 0;

      virtual DtTaskSetVariableWidgetExtensionInterface* parameterContents(QWidget* parent, const Qt::WindowFlags& flags = 0) const
      {
         return 0;
      }

      virtual bool guiElementOnly() const
      {
         return false;
      }

      static bool canBeUsedAsWidget()
      {
         return true;
      }

      virtual void setIndent(int) = 0;

      virtual std::string variableDataFromUiDesigner(const QDomElement&, const DtScriptedTaskVariableLayoutConverter&) const = 0;

      static void initializeForQtDesignerExtension(makVrv::DtDe& de, QDesignerFormEditorInterface* core)
      {
      }

      static bool includeInQtDesigner()
      {
         return true;
      }

      virtual std::string scriptedTaskVariableName() const = 0;

      virtual void widgetInitializedForDialog(DtScriptedTaskDialog*, const std::vector<makVrv::DtSimEntry*>& data)
      {
      }

      virtual void setSelection(const std::set<makVrv::DtUniqueID>& selection) {};
      virtual void setSelection(const std::vector<makVrv::DtSimEntry*>& data) {};

      virtual const std::set<makVrv::DtUniqueID>& selection() const
      {
         static std::set<makVrv::DtUniqueID> theEmptySet;
         return theEmptySet;
      }
   };

   class DT_DLL_VRFGUIDATAENTRYWIDGETS DtTaskSetVariableWidget : public QWidget, public DtTaskSetVariableWidgetInterface
   {
      Q_OBJECT
      Q_PROPERTY(QString label READ label WRITE setLabel)
      Q_PROPERTY(bool isInternal READ isInternal WRITE setIsInternal)
      Q_PROPERTY(int indent READ indent WRITE setIndent)
      Q_PROPERTY(QString variableData READ variableData WRITE setVariableData DESIGNABLE false)

   public:
      DtTaskSetVariableWidget(makVrv::DtDe& de, QWidget* parent, const Qt::WindowFlags& flags = 0, const CreationFlags& cflags = NormalMode);

      //DTOR
      virtual ~DtTaskSetVariableWidget();

      virtual void setToolTip(const QString&);

      virtual void setLabel(const std::string&);

      virtual void setLabel(const QString&);

      virtual void setVariableData(const std::string&);

      virtual void setVariableData(const QString&);
      virtual QString variableData() const;

      virtual QString label() const;

      virtual void setupFrom(const std::vector<makVrv::DtSimEntry*>& data);

      virtual void setIsInternal(bool);
      virtual bool isInternal() const;

      virtual void setTopLineVisible(bool);
      virtual bool topLineVisible() const;

      virtual void createTopLine();

      virtual void setIndent(int);
      virtual int indent() const;

      virtual bool isValid() const;

      virtual void setTopLabelChecked(bool);
      virtual bool topLabelChecked() const;

      virtual void setRange(double, double)
      {
      }

      virtual void setRange(const DtRange&);
      virtual void setRangeTop(double);
      virtual void setRangeTop(int);
      virtual double rangeTop() const;

      virtual void setRangeBottom(double);
      virtual void setRangeBottom(int);
      virtual double rangeBottom() const;

      virtual const DtRange& getRange() const;

      virtual void setTopLabelIsCheckable(bool);
      virtual bool topLabelIsCheckable() const;
      virtual void getDefaultSpecificTitles(QString& defaultTitle, QString& specificTitle) const;
      virtual void setDefaultSpecificTitles(const QString& defaultTitle, const QString& specificTitle);

      virtual void setupDefaultSpecificFromVariableData(const DtString& var);

      boost::signals2::signal<void (bool)> signal_topLevelCheckStateChanged;

      static bool includeInQtDesigner()
      {
         return true;
      }

      virtual std::string variableDataFromUiDesigner(const QDomElement&, const DtScriptedTaskVariableLayoutConverter&) const;

      virtual std::string scriptedTaskVariableName() const;

      virtual void setSelection(const std::set<makVrv::DtUniqueID>& selection);
      virtual void setSelection(const std::vector<makVrv::DtSimEntry*>& data);
      virtual const std::set<makVrv::DtUniqueID>& selection() const
      {
         return mySelection;
      }

   protected:
      virtual void selectionChanged(const std::set<makVrv::DtUniqueID>& oldSelection);

   signals:

      void validityUpdated();

   protected slots:
      virtual void topLabelCheckStateChanged();

   protected:
      makVrv::DtDe& myDe;
      makVrv::DtSignalConnectionManager myConnections;
      bool myTopLabelIsCheckable;
      DtRange myRange;
      bool myIsInternal;
      CreationFlags myCreationFlags;

      QString myVariableData;
      std::set<makVrv::DtUniqueID> mySelection;

   public:
      int myIndent;
      QVBoxLayout* myVariableWidgetLayout;
      QHBoxLayout* mySpacedLayout;

      QVBoxLayout* myVariableContentLayout;
      QWidget* myTopLine;
      QLabel* myTopLabel;
      QWidget* myChoiceCanvas;
      QRadioButton* myUseDefault;
      QRadioButton* myUseSpecific;
      QSpacerItem* myTopSeparator;
      QHBoxLayout* myTopLineLayout;
      QSpacerItem* mySpacerItem;
   };


   class DT_DLL_VRFGUIDATAENTRYWIDGETS DtTaskSetVariableWidgetCreatorInterface
   {
   public:
      virtual ~DtTaskSetVariableWidgetCreatorInterface()
      {
      };

      virtual DtTaskSetVariableWidgetInterface* create(makVrv::DtDe& de, QWidget* parent, const Qt::WindowFlags& flags = 0,
         const DtTaskSetVariableWidgetInterface::CreationFlags& = DtTaskSetVariableWidgetInterface::NormalMode) = 0;

      virtual makVrv::DtUnicode codeVariableType() const = 0;
      virtual std::string className() const = 0;

      virtual bool canBeUsedAsWidget() const = 0;


      virtual std::string designerIcon() const
      {
         return "../data/images/icons/Simulate_FrontEnd_Icon.ico";
      }

      virtual std::string designerGroup() const = 0;

      virtual std::string headerFile() const = 0;

      virtual std::string variableName() const = 0;

      virtual bool includeInDesigner() const = 0;

      virtual void initializeForQtDesignerExtension(makVrv::DtDe& de, QDesignerFormEditorInterface* core) = 0;

   };

   template <typename _Class>
   class DtTaskSetVariableWidgetCreator : public DtTaskSetVariableWidgetCreatorInterface
   {
   public:
      DtTaskSetVariableWidgetCreator() {};

      virtual ~DtTaskSetVariableWidgetCreator()
      {
      };

      virtual DtTaskSetVariableWidgetInterface* create(makVrv::DtDe& de, QWidget* parent, const Qt::WindowFlags& flags = 0,
         const DtTaskSetVariableWidgetInterface::CreationFlags& cflags = DtTaskSetVariableWidgetInterface::NormalMode)
      {
         return new _Class(de, parent, flags, cflags);
      }

      virtual makVrv::DtUnicode codeVariableType() const
      {
         return _Class::codeVariableType();
      }

      virtual std::string className() const
      {
         return _Class::staticMetaObject.className();
      }

      virtual std::string designerGroup() const
      {
         return _Class::designerGroup();
      }

      virtual std::string headerFile() const
      {
         return _Class::headerFile();
      }

      virtual std::string variableName() const
      {
         return _Class::variableName();
      }

      virtual bool canBeUsedAsWidget() const
      {
         return _Class::canBeUsedAsWidget();
      }

      virtual bool includeInDesigner() const
      {
         return _Class::includeInQtDesigner();
      }

      virtual void initializeForQtDesignerExtension(makVrv::DtDe& de, QDesignerFormEditorInterface* core)
      {
         _Class::initializeForQtDesignerExtension(de, core);
      }
   };
}