scriptedTaskDataWidgets.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCoreQt/vrfGuiCoreQt.h>
#include <vrfGuiCoreQt/configurableMenu.h>
#include <vrvUtil/signalslib.h>
#include <vrfutil/scriptedTaskMetaData.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include "DtScriptedTaskVariableDialogUi.hpp"

#include <QtWidgets/QDialog>
#include <QtGui/QValidator>

class QLabel;
class QPushButton;
class QTreeWidget;
class QTreeWidgetItem;
class QAction;
class QRadioButton;
class QCheckBox;
class DtSimMessage;

namespace makVrf
{
   class DtDesignerEditor;
   class DtTaskSetVariableWidgetInterface;
   class DtTaskSetVariableWidgetExtensionInterface;
   class DtConfigurableMenuAssembler;
   class DtMenuPathSelector;
   class DtToolbarPathSelector;

   class DT_DLL_VRFGUICOREQT DtScriptedTaskDataWidget : public QWidget
   {
      Q_OBJECT

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

      //DTOR
      virtual ~DtScriptedTaskDataWidget();

      virtual void init(const DtScriptedTaskMetaData&) = 0;

      virtual void accept(DtScriptedTaskMetaData&) = 0;

      virtual void clear();

      virtual void setReadOnly(bool);

      virtual bool processing() const;

      boost::signal<void ()> signal_processing;

      boost::signal<void ()> signal_done;

   protected slots:
      virtual void onItemSelected();
      virtual void onAdd() = 0;
      virtual void onUpdate() = 0;
      virtual void onDelete() = 0;

   public:
      QLabel* myTitle;
      QPushButton* myAdd;
      QPushButton* myUpdate;
      QPushButton* myDelete;
      QTreeWidget* myDataItems;
      QHBoxLayout* myTitleLayout;

   protected:
      makVrv::DtDe&  myDe;
      bool myReadOnly;
      bool myProcessing;
   };

   class DT_DLL_VRFGUICOREQT DtScriptedTaskVariableDataWidget : public DtScriptedTaskDataWidget
   {
      Q_OBJECT

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

      //DTOR
      virtual ~DtScriptedTaskVariableDataWidget();

      virtual void init(const DtScriptedTaskMetaData&);

      virtual void accept(DtScriptedTaskMetaData&);

      virtual void setReadOnly(bool);

      const std::vector<DtScriptedTaskVariable>& variables() const;

      virtual std::string generateCommentBlock() const;
      
      static std::string generateCommentBlock(makVrv::DtDe& de, const std::vector<DtScriptedTaskVariable>&, bool isSetBlock);

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

      virtual void setIsSet(bool b);
      bool isSet() const;

      virtual void setAdding(bool);
      bool adding() const;

      virtual void setUseUiDesigner(bool);
      virtual bool useUiDesigner() const;

      virtual const std::string& uiLayout() const;

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

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

      virtual void receivedUiLayout(DtSimMessage*);

      virtual void requestUiLayout();

      boost::signal<void ()> signal_variablesUpdatedFromDesigner;
      boost::signal<void ()> signal_receivedUiLayout;

   protected:
      virtual void onUiLayoutEditingComplete(const std::string& scriptId);
      virtual void onUiLayoutSaved(const std::string& scriptId, const std::string&, const std::vector<DtScriptedTaskVariable>&);

   protected slots:
      virtual void onMoveUp();
      virtual void onMoveDown();
      virtual void onShowTaskParameterComments();
      virtual void copyCommentsToClipboard();
      virtual void useUiDesignerChanged();
      virtual void onEditDesignerCode();

   protected:
      virtual void setupVariables();
      virtual int variableIndexFrom(int row) const;
      virtual void onItemSelected();
      virtual void onAdd();
      virtual void onUpdate();
      virtual void onDelete();
      virtual void moveItemFrom(int from, int to);

   public:
      QPushButton* myShowTaskParameterComments;
      QPushButton* myMoveUp;
      QPushButton* myMoveDown;

      QHBoxLayout* myUiDesignerLayout;
      QCheckBox*   myUseUiDesigner;
      QPushButton* myEditUiLayout;

   protected:
      std::vector<DtScriptedTaskVariable> myVariables;
      DtString myModule;
      std::string myScriptId;
      bool myIsSet;
      std::string myUiLayout;
      makVrv::DtSignalConnectionManager myConnections;
      std::string myDescription;
      bool myAdding;
      int myUiLayoutRequestId;
   };

   class DT_DLL_VRFGUICOREQT DtParameterNameValidator : public QValidator
   {
   public:
      DtParameterNameValidator(QObject* parent);
      virtual ~DtParameterNameValidator();

      virtual State validate(QString &, int &) const;
   };

   class DT_DLL_VRFGUICOREQT DtScriptedTaskVariableDialog: public QDialog
   {
      Q_OBJECT

   public:
      DtScriptedTaskVariableDialog(makVrv::DtDe&, QWidget*, const Qt::WindowFlags& flags = 0);
      virtual ~DtScriptedTaskVariableDialog();

      virtual void init(const DtString& module, const DtScriptedTaskVariable&);

      virtual DtScriptedTaskVariable scriptedTaskVariable() const;

      virtual void view();

   protected:
      virtual void accept();

   protected slots:
      virtual void parameterTypeChanged();
      virtual void parameterNameChanged();

   public:
      Ui_DtScriptedTaskVariableDialogUi myUiImpl;

   protected:
      makVrv::DtDe& myDe;
      DtParameterNameValidator myParameterNameValidator;
      DtTaskSetVariableWidgetExtensionInterface* myParameterExtension;
      DtScriptedTaskVariable myScriptedTaskVariable;
      bool myReadOnly;
      DtString myModule;
   };

   class DT_DLL_VRFGUICOREQT DtScriptedTaskEntityTypeDataWidget : public DtScriptedTaskDataWidget
   {
      Q_OBJECT

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

      //DTOR
      virtual ~DtScriptedTaskEntityTypeDataWidget();

      virtual void init(const DtScriptedTaskMetaData&);

      void init(const std::vector<DtString>& types);

      virtual void accept(DtScriptedTaskMetaData&);

      virtual std::vector<DtEntityType> entityTypes() const;

      virtual void setToolTip(const QString&);

      virtual std::string displayStringFor(const DtEntityType&) const;

   protected:
      virtual void onAdd();
      virtual void onUpdate();
      virtual void onDelete();

      virtual bool getEntityType(DtEntityType& result, const DtEntityType& start = DtEntityType());
   };

   class DT_DLL_VRFGUICOREQT DtScriptedTaskMenuLocationsDataWidget : public QWidget
   {
      Q_OBJECT

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

      //DTOR
      virtual ~DtScriptedTaskMenuLocationsDataWidget();

      virtual void init(const DtScriptedTaskMetaData&);

      virtual void accept(DtScriptedTaskMetaData&);

      virtual void setReadOnly(bool);

      virtual void setMenuText(const QString&);

      virtual bool processing() const;

      virtual void setupForSets();

      virtual void setupForTasks();

      boost::signal<void ()> signal_processing;

      boost::signal<void ()> signal_done;

   protected:
      virtual QString selectMenuPath(const QString& curPath = "");

      virtual bool wouldCreateCircularDependency(const std::string&) const;
      virtual void addScriptedTaskMenuLocation(const std::string& scriptedTaskId, const std::string&, DtSubMenuConfiguration&) const;

   protected slots:
      virtual void showOnTaskMenuChanged();
      virtual void showOnSetMenuChanged();
      virtual void onUpdate();

   public:
      DtMenuPathSelector* myTaskMenuPathSelector;
      DtMenuPathSelector* mySetMenuPathSelector;
      DtScriptedTaskMetaData myScriptedTaskMetaData;
      QCheckBox* myTitle;
      QCheckBox* myShowOnRightClickTitle;
      QLabel* myMenuLocation;
      QLabel* myMenuLabel;
      QPushButton* myUpdate;
      QWidget* myMenuCanvas;

   protected:
      std::vector<std::string> myMenuPaths;
      makVrv::DtDe& myDe;
      bool myResetBeforeUpdate;
      bool myProcessing;
      bool myIsSet;
   };

   class DT_DLL_VRFGUICOREQT DtScriptedTaskToolbarLocationsDataWidget : public QWidget
   {
      Q_OBJECT

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

      //DTOR
      virtual ~DtScriptedTaskToolbarLocationsDataWidget();

      virtual void init(const DtScriptedTaskMetaData&);

      virtual void accept(DtScriptedTaskMetaData&);

      virtual void setReadOnly(bool);

      virtual bool processing() const;

      virtual std::string selectToolbarPath();

      virtual void setupForSets();
      virtual void setupForTasks();

      boost::signal<void ()> signal_processing;

      boost::signal<void ()> signal_done;

   protected slots:
      virtual void showOnTaskToolbarChanged();
      virtual void showOnSetToolbarChanged();
      virtual void onUpdate();

   public:
      QCheckBox* myTitle;
      QWidget* myToolbarCanvas;
      QLabel* myToolbarLocation;
      QLabel* myToolbarLabel;
      QPushButton* myUpdate;
      DtToolbarPathSelector* myTaskToolbarPathSelector;
      DtToolbarPathSelector* mySetToolbarPathSelector;

   protected:
      DtScriptedTaskMetaData myScriptedTaskMetaData;
      makVrv::DtDe& myDe;
      bool myProcessing;
      bool myIsSet;
   };

   class DT_DLL_VRFGUICOREQT DtScriptedTaskReactiveTaskDataWidget : public QWidget
   {
      Q_OBJECT

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

      //DTOR
      virtual ~DtScriptedTaskReactiveTaskDataWidget();

      virtual void init(const DtScriptedTaskMetaData&);

      virtual void accept(DtScriptedTaskMetaData&);

      virtual void setReadOnly(bool);

      virtual bool processing() const;

      virtual void setActionCategories(const std::set<std::string>&);

      virtual void setEntityTypes(const std::vector<DtEntityType>&);

      virtual std::string displayStringFor(const DtEntityType&) const;

      boost::signal<void ()> signal_processing;

      boost::signal<void ()> signal_done;

   protected slots:
      virtual void onDisplayScriptedTaskPriorities();

   public:
      QLineEdit* myPriority;
      QIntValidator* myValidator;
      QLabel* myPriorityLabel;
      QCheckBox* myEnabled;
      QPushButton* myDisplayScriptedTaskPriorities;
      QHBoxLayout* myPriorityLayout;

   protected:
      makVrv::DtDe& myDe;
      bool myProcessing;
      std::string myScriptId;
      std::set<std::string> myActionCategories;
      std::vector<DtEntityType> myEntityTypes;
   };
}