scriptedTaskDialog.h

Go to the documentation of this file.

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



#pragma once

#if !defined(Q_MOC_RUN)
#include <vrfGuiTaskSetQt/vrfGuiTaskSetQt.h>
#include <vrfGuiTaskSetQt/baseTaskSetDialogInterface.h>
#include <vrfGuiCommonQt/mapFocusHandler.h>
#include <vrfutil/scriptedTaskMetaData.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrftasks/scriptedTaskTask.h>
#endif
#include <boost/signals2.hpp>

#include <QtWidgets/QDialog>

#include <vector>

class QVBoxLayout;
class QScrollArea;
class QLabel;
class QFrame;
class DtRwVariableBindings;
class DtSimMessage;
class QSpacerItem;

namespace makVrf
{
   class DtTaskSetVariableWidgetInterface;
   class DtLocationEntryWidget;
   class DtVrfFilteredListView;
   class DtTaskSetVariableWidget;

   class DT_DLL_VRFGUITASKSETQT DtQtScriptedTaskFormatter : public DtScriptedTask::ScriptedTaskFormatter
   {
   public:
      DtQtScriptedTaskFormatter(makVrv::DtDe&);
      virtual ~DtQtScriptedTaskFormatter();

      virtual DtString stringRep(const DtScriptedTask&) const;
      virtual DtString stringRep(const DtString& scriptId, const DtRwVariableBindings& variables, const DtRwVariableBindings& variableDataTypes) const;

   protected:
      makVrv::DtDe& myDe;
   };

   class DT_DLL_VRFGUITASKSETQT DtScriptedTaskDialog : public DtBaseTaskSetDialogInterface
   {
      Q_OBJECT
   public:

      struct WidgetInfo
      {
         bool visible;
         std::string type;
         std::string scriptedTaskVariableName;
         DtTaskSetVariableWidgetInterface* widget;
         QHBoxLayout* hBoxLayout;
         int variableIndex;
      };

      //CTOR
      DtScriptedTaskDialog(makVrv::DtDe& de, QWidget* parent, const Qt::WindowFlags& flags = 0);

      //DTOR
      virtual ~DtScriptedTaskDialog();

      virtual QSize minimumSizeHint() const;
      virtual QSize sizeHint() const;

      virtual bool editStatement(const std::vector<makVrv::DtSimEntry*>& data, const DtSimStatement* s);

      virtual void initializeFromVariables(const QString& description, const std::vector<DtScriptedTaskVariable>& vars,
         const std::vector<makVrv::DtSimEntry*>& initializeFrom = std::vector<makVrv::DtSimEntry*>());

      virtual void initializeFromLayout(const QString& description, const std::string& uiLayout,
         const std::vector<makVrv::DtSimEntry*>& initializeFrom = std::vector<makVrv::DtSimEntry*>());

      virtual void setDescription(const QString&);

      virtual std::vector<DtScriptedTaskVariable> convertToVariables() const;

      virtual DtRwVariableBindings* convertToVariableBindings() const;

      virtual void setLocationValid(bool);

      virtual void validate();

      virtual QSize visibleSize();

      virtual void setupFromBoundVariables(const DtRwVariableBindings&);

      virtual DtRwVariableBindings* variableBindings() const;

      template <typename T> void getWidgetsOfType(std::vector<T>& widgets) const
      {
         std::map<std::string, WidgetInfo>::const_iterator iter = this->myWidgetVariables.begin();

         while (iter != this->myWidgetVariables.end())
         {
            T widget = dynamic_cast<T>(iter->second.widget);

            if (widget)
            {
               widgets.push_back(widget);
            }

            ++iter;
         }
      }

      boost::signals2::signal<void (DtVrfFilteredListView*)> signal_filteredListViewSelectionChanged;
      boost::signals2::signal<void (bool, DtTaskSetVariableWidget*)> signal_topLevelCheckStateChanged;

      virtual bool insertMapFocusHandler(DtMapFocusHandlerInterface* h, int index);

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

      virtual QSize canvasSize();
      virtual QWidget* contents(const std::vector<makVrv::DtSimEntry*>& data);

      virtual void setShowInternalVariables(bool);
      bool showInternalVariables() const { return myShowInternalVariables; };

      static std::string buildLayoutFrom(makVrv::DtDe& de, const std::vector<DtScriptedTaskVariable>& vars, const std::string& description, bool showInternal = false);
      virtual std::string buildLayoutFrom();

      virtual void resizeContentsToFit();

      virtual void setValidateBeforeSend(bool);
      bool validateBeforeSend() const
      {
         return myValidateBeforeSend;
      }

   protected:
      virtual bool initializeForScriptedTask(const std::vector<makVrv::DtSimEntry*>& data, const DtSimStatement* s);
      virtual bool initializeForScriptedSet(const std::vector<makVrv::DtSimEntry*>& data, const DtSimStatement* s);
      virtual bool initializeStatementForEditing(const std::vector<makVrv::DtSimEntry*>& data, const DtString& scriptId, const DtSimStatement* stmt);

      virtual void slot_topLevelCheckStateChanged(bool, DtTaskSetVariableWidget*);

      virtual void slot_filteredListViewChanged(DtVrfFilteredListView*);

      virtual void initializeFromAction(DtVrfTaskSetAction*);
      virtual void initializeDialogFromScriptId(const std::string& scriptId);

      virtual void setupFormForDisplayFromMetaData();

      virtual void initializeDialogFromLayout(const QString& description, const std::string& scriptId);

      virtual bool wantsSelectionOfObjectInCommandMode(const std::vector<makVrv::DtSimEntry*>&) const;
      virtual void sendRequest();

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

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

      virtual void setupStatement(const DtSimStatement* stmt);

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

      virtual void setLocationValid(DtLocationEntryWidget* loca, bool);

      virtual bool setupFromUiLayout(bool& setup, const std::vector<makVrv::DtSimEntry*>& data = std::vector<makVrv::DtSimEntry*>());

      virtual bool setupFromVariables(bool& setup, const std::vector<makVrv::DtSimEntry*>& data = std::vector<makVrv::DtSimEntry*>());

      virtual void requestUiLayout();

      virtual void receivedUiLayout(DtSimMessage*);

      virtual void initializeWidgetForVariable(DtTaskSetVariableWidgetInterface* w, const DtScriptedTaskVariable&, int index, bool fromDesigner, int& indent, bool& setup,
         const std::vector<makVrv::DtSimEntry*>& data = std::vector<makVrv::DtSimEntry*>(), const std::set<makVrv::DtUniqueID>& selection = std::set<makVrv::DtUniqueID>());

      virtual void resizeToContents();

   public slots:

      virtual void updateValidity();

   public:
      QWidget* myCanvas;
      QVBoxLayout* myContentLayout;
      QLabel* myDescription;
      QScrollArea* myScrollArea;
      QWidget* myInsideWidget;
      QSpacerItem* myInsideWidgetSpacerItem;
      QFrame* myDescriptionSeparator;
      QVBoxLayout* myInsideLayout;

   protected:
      bool myShowInternalVariables;
      DtMapFocusHandler myMapFocusHandler;

      std::map<std::string, WidgetInfo> myWidgetVariables;
      DtScriptedTaskMetaData myScriptedTaskMetaData;
      std::vector<DtScriptedTaskVariable> myScriptedTaskVariables;

      QString myDescriptionText;

      typedef std::map<DtLocationEntryWidget*, bool> LocationValid;
      LocationValid myLocationsValid;

      makVrv::DtSignalConnectionManager myConnections;

      std::string myUiLayout;

      std::vector<makVrv::DtUniqueID> mySimEntryIDs;
      int myUiLayoutRequestId;
      const DtSimStatement* myScriptedTaskToEdit;
      
      bool myValidateBeforeSend = true;
   };

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

      virtual void init(const QString& description, const std::vector<DtScriptedTaskVariable>&);

      virtual void init(const QString& description, const std::string&);

   public:
      DtScriptedTaskDialog* myScriptedTaskDialog;
      makVrv::DtDe& myDe;
   };

   class DT_DLL_VRFGUITASKSETQT DtScriptedTaskDialogCreator : public DtVrfTaskDialogCreator
   {
   public:
      virtual DtTaskSetDialogInterface* create(makVrv::DtDe&, QWidget* parent);
      bool supportsType(makVrv::DtDe& de, const DtSimTaskMessageType&, const DtSimStatement*) const;
   };

   class DT_DLL_VRFGUITASKSETQT DtScriptedSetDialogCreator : public DtVrfSetDialogCreator
   {
   public:
      virtual DtTaskSetDialogInterface* create(makVrv::DtDe&, QWidget* parent);
      bool supportsType(makVrv::DtDe& de, const DtSetMessageType&, const DtSimStatement*) const;
   };

   class DT_DLL_VRFGUITASKSETQT DtScriptedTaskDialogCreatorInstance : public makVrv::DtVirtualBaseClass
   {
   public:
      virtual DtScriptedTaskDialogCreator* create();

      static DtScriptedTaskDialogCreatorInstance& instance(makVrv::DtDe&);
      static void registerInstance(makVrv::DtDe& de, DtScriptedTaskDialogCreatorInstance*);
   };

   class DT_DLL_VRFGUITASKSETQT DtScriptedSetDialogCreatorInstance : public makVrv::DtVirtualBaseClass
   {
   public:
      virtual DtScriptedSetDialogCreator* create();

      static DtScriptedSetDialogCreatorInstance& instance(makVrv::DtDe&);
      static void registerInstance(makVrv::DtDe& de, DtScriptedSetDialogCreatorInstance*);
   };
}