scriptedTasksMetaDataDialog.h

Go to the documentation of this file.

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



#pragma once

#if !defined(Q_MOC_RUN)
#include <vrvUtil/signalslib.h>
#include <vrfGuiCoreQt/vrfGuiCoreQt.h>
#include <vrfutil/scriptedTaskMetaData.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrfGuiCommonQt/treeWidget.h>
#endif
#include <boost/signals2.hpp>

#include <QDialog>

namespace makVrv
{
   class DtDe;
}

class DtSimMessage;
class QTreeWidgetItem;
class QPushButton;
class QVBoxLayout;
class QAction;
class QMenuBar;
class QMenu;
class QComboBox;
class QLineEdit;
class QLabel;
class QListWidget;
class QCheckBox;

namespace makVrf
{
   class DtScriptedTaskMetaDataDialog;

   #define DtScriptedTaskDragType "text/x-vrlScriptedTaskDragging@Type"

   class DT_DLL_VRFGUICOREQT DtScriptedTaskTreeWidget : public DtTreeWidget
   {
   public:
      typedef std::map<QTreeWidgetItem*, QTreeWidgetItem*> ScriptedTaskItem;
      typedef std::map<std::string, ScriptedTaskItem> ScriptedTaskItems;

      DtScriptedTaskTreeWidget(makVrv::DtDe& de, QWidget* parent);

      virtual ~DtScriptedTaskTreeWidget();

      virtual bool selectedScriptIsSystemScript() const;

      virtual bool selectedItemIsFolder() const;

      virtual bool itemIsFolder(QTreeWidgetItem*) const;

      virtual bool allSelectedItemsAreScripts() const;

      virtual QString getFolderName(QTreeWidgetItem*, const QString& current = "");

      virtual QTreeWidgetItem* addFolder(QTreeWidgetItem* root, const QString&, bool select = true);

      virtual bool systemScriptsInFolder(QTreeWidgetItem*) const;

      virtual bool selectedItemCanEditScript() const;

      virtual QTreeWidgetItem* findScriptItem(const QString& scriptId);

      virtual QTreeWidgetItem* findFolder(const QString& path, QTreeWidgetItem* root = 0);

      virtual void setFolderPaths(QTreeWidgetItem*);

      virtual std::string folderPathToItem(QTreeWidgetItem*) const;

      virtual std::string folderPathToSelectedItem() const;

      virtual std::vector<std::string> scriptIdsInFolder(QTreeWidgetItem*) const;

      virtual std::set<std::string> selectedScriptIds() const;

      virtual QSize sizeHint(QTreeWidgetItem*) const;

      const ScriptedTaskItems& scriptedTaskItems() const
      {
         return myScriptedTaskItems;
      }

      virtual void updateFrameRates(DtSimMessage*);

      virtual QTreeWidgetItem* addScriptedTask(const std::string&, QTreeWidgetItem* root = 0, bool addToFolder = true);

      virtual bool removeScriptedTask(const std::string&);

      virtual void scriptModified(const std::string&, bool);

      virtual void clear();

      virtual void setEditable(bool b);
      virtual bool editable() const;

      virtual void scriptModifiedCleared();

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

      virtual void filterByScriptEngine(const std::set<std::string>& showEngines);
      virtual bool filterByScriptEngine(QTreeWidgetItem*, const std::set<std::string>& showEngines);

      virtual void scriptIdChanged(const std::string& oldId, const std::string& newId);
      virtual bool changeScriptId(QTreeWidgetItem* item, const std::string& oldId, const std::string& newId) const;

   protected:
      virtual QMimeData* mimeData(const QList<QTreeWidgetItem*> list) const;

      virtual void dragEnterEvent(QDragEnterEvent* event);

      virtual void dragMoveEvent(QDragMoveEvent* event);

      virtual void dropItems(const QStringList&, QTreeWidgetItem*);

      virtual bool dropMimeData(QTreeWidgetItem* parent, int index, const QMimeData* mimeData, Qt::DropAction action);

      virtual void keyPressEvent(QKeyEvent*);

      virtual void statusUpdate(QTreeWidgetItem* item, const std::string& scriptId);

      virtual QIcon composeIcon(const DtScriptedTaskMetaData&) const;

   public:
      boost::signals2::signal<void ()> signal_deleteRequested;

   protected:
      bool myEditable;
      ScriptedTaskItems   myScriptedTaskItems;
   };

   class DT_DLL_VRFGUICOREQT DtScriptedTasksMetaDataDialog : public QDialog
   {
      Q_OBJECT

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

      virtual void onAddNewScript(int);

   protected:
      virtual void slot_aboutToClearScriptedTasks();
      virtual void slot_scriptedTaskAboutToBeRemoved(std::string scriptId);
      virtual void slot_scriptedTaskAdded(std::string scriptId, bool updateEntityTypeCombo = true);
      virtual void slot_receivedScriptedTasks();
      virtual void updateActions();
   
      virtual DtScriptedTaskMetaDataDialog* createScriptedTaskMetaDataDialog();

      virtual void selectToImport(const std::vector<DtScriptedTaskMetaData>&);

      virtual void slot_adding(const std::string& id);

      virtual void slot_scriptErrorChange(std::string scriptId, bool hasError, std::string error);

      virtual void showAllItems();

      virtual void filterByScriptEngine();

      virtual void filterByScriptType();
      virtual bool filterByScriptType(QTreeWidgetItem*);


      virtual void filterByScriptAccess();
      virtual bool filterByScriptAccess(QTreeWidgetItem*);

      virtual void filterByEntityType();
      virtual bool filterByEntityType(QTreeWidgetItem*);

      virtual void filterBySearchString();
      virtual bool filterBySearchString(QTreeWidgetItem*);

      virtual void updateEntityTypeCombo();

      virtual void slot_scriptModified(std::string scriptId, bool modified);

      virtual void slot_scriptModifiedCleared();

      virtual void slot_scriptIdChanged(const std::string& oldId, const std::string& newId);

   protected slots:
      virtual void systemAvailabilityChanged(QTreeWidgetItem*,int);
      virtual void onMetaDataSelected();
      virtual void onEditSelectedMetaData();
      virtual void onViewSelectedMetaData();
      virtual void onAddMetaData();
      virtual void onDuplicateMetaData();
      virtual void onDeleteMetaData();
      virtual void onEditScript();
      virtual void onEditExternalScript();
      virtual void onShowVrfLuaDocHelp();
      virtual void onShowLuaDocHelp();
      virtual void onViewScriptError();
      virtual void onImportScripts();
      virtual void onExportScripts();
      virtual void onMakeSystemScript();
      virtual void onShowScriptedTaskSettings();

      virtual void onAddFolder();
      virtual void onRenameFolder();
      virtual void onDeleteFolder();
      virtual void onRightClickOnItem(QTreeWidgetItem*, QMouseEvent* e, int col);

      virtual void filterItems();

      virtual void resetFilters();

      virtual void selectAllToImport();

      virtual void clearAllToImport();

      virtual void onRemoveFromFolder();

      virtual void onMetaDataDialogClosed(QObject* dlg);

   protected:
      virtual void onDeleteItem();

      virtual void receivedScriptsToExport(DtSimMessage* msg, int requestId, QString filenameToExportTo);

      virtual void receivedFrameRates(DtSimMessage* msg);

      virtual bool continueWithSystemScriptEdit();

      virtual void closeEvent(QCloseEvent*);

      virtual void showEvent(QShowEvent*);

      virtual void slot_scriptedTaskSettingsChanged();

      virtual void receivedScriptForMetaDataDuplication(DtSimMessage*);

      virtual void slot_scriptedTaskTypeAdded(int);

      virtual void slot_scriptedTaskTypeRemoved(int);

   public:
      DtScriptedTaskTreeWidget* myScripts;
      QPushButton* myCloseButton;
      QPushButton* myNewScript;
      QPushButton* myImportScripts;
      QPushButton* myResetButton;
      QLabel* myScriptTypeFilterLabel;
      QComboBox* myScriptTypeFilterCombo;
      QLabel* myScriptAccessFilterLabel;
      QComboBox* myScriptAccessFilterCombo;
      QLabel* myEntityTypeFilterLabel;
      QComboBox* myEntityTypeComboBox;
      QLabel* mySearchLabel;
      QLineEdit* mySearchBar;
      QCheckBox* myShowCPPScriptedTasks;

      QAction* myAddScriptAction;
      QAction* myEditAction;
      QAction* myEditScriptAction;
      QAction* myEditExternalScriptAction;
      QAction* myViewScriptErrorAction;
      QAction* myDeleteAction;
      QAction* mySettingsAction;
      QAction* myImportAction;
      QAction* myExportAction;
      QAction* myDuplicateAction;
      QAction* myMakeSystemScript;
      QAction* myAddFolderAction;
      QAction* myDeleteFolderAction;
      QAction* myRenameFolderAction;
      QAction* myRemoveFromFolderAction;
      QAction* myVrfLuaDocHelpAction;
      QAction* myLuaDocHelpAction;

      QAction* myRightClickSeparator;
      QMenu* myScriptMenu;
      QMenu* myFolderMenu;
      QMenu* myHelpMenu;
      QMenu* myRightClickMenu;

      QMenuBar* myMenuBar;

   protected:
      makVrv::DtDe& myDe;
      makVrv::DtSignalConnectionManager myConnectionManager;

      std::string myAddingScript;

      QListWidget* myImportList;

      bool myMonitoringFrameRates;

      typedef std::map<int, std::string> PendingDuplications;
      PendingDuplications myPendingDuplications;

      std::map<std::string, DtScriptedTaskMetaDataDialog*> myOpenMetaDataDialogs;
   };

   class DT_DLL_VRFGUICOREQT DtScriptedTasksMetaDataDialogCreator : public makVrv::DtVirtualBaseClass
   {
   public:
      DtScriptedTasksMetaDataDialogCreator();
      virtual ~DtScriptedTasksMetaDataDialogCreator();

      static DtScriptedTasksMetaDataDialogCreator& instance(makVrv::DtDe&);
      static void registerInstance(makVrv::DtDe&, DtScriptedTasksMetaDataDialogCreator*);

      virtual DtScriptedTasksMetaDataDialog* create(makVrv::DtDe&, QWidget* parent, const Qt::WindowFlags&f = 0);
   };
}