scriptedTaskConfigurableMenu.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiTaskSetQt/vrfGuiTaskSetQt.h>
#include <vrfGuiCommonQt/configurableMenu.h> 
#include <vrvCore/DtToolbarConfiguration.h>
#include <vrfGuiConstants/vrfMenuIds.h>
#include <vrfGuiTaskSetQt/vrfTaskSetAction.h>
#include <vrfutil/scriptedTaskMetaData.h>
#include <vrvCoreQt/DtToolbar.h>
#include <vrvUtil/DtUnicode.h>
#include <boost/signals2.hpp>

class QEvent;
class DtScriptedTaskMetaData;

namespace makVrv
{
   class DtUnicode;
}

namespace makVrf
{
   class DtVrfTaskSetMenu;

   class DT_DLL_VRFGUITASKSETQT DtScriptedTaskConfigurableMenu : public DtConfigurableMenu, public QObject
   { 
   public:
      enum RecreateFlags
      {
         RecreateNone = 0,
         RecreateOnScenarioLoad = 0x00000001,
         RecreateOnScriptedTaskChange = 0x00000002,
         RecreateToolbars = 0x00000004,
         UseGlobalMenuManager = 0x00000008,
         RecreateMenuOnSelectionChange = 0x00000010,
         SkipInitialMenuSetup = 0x00000020, 
         AllowPassThru = 0x00000040 
      };

      struct ScriptedTaskData
      {
         ScriptedTaskData() : availableSystemScript(false) {};
         ScriptedTaskData(const ScriptedTaskData& orig) : metaData(orig.metaData), availableSystemScript(orig.availableSystemScript) {};

         ScriptedTaskData& operator=(const ScriptedTaskData& orig) { metaData = orig.metaData; availableSystemScript = orig.availableSystemScript; return *this; };

         DtScriptedTaskMetaData metaData;
         bool availableSystemScript;
      };

      typedef std::map<std::string, ScriptedTaskData> ScriptedTasks;

      DtScriptedTaskConfigurableMenu(makVrv::DtDe&, const std::string& menuIdName);

      virtual ~DtScriptedTaskConfigurableMenu() override;

      virtual void setEditMode(bool);
      virtual bool editMode() const;

      virtual void setRecreateFlags(RecreateFlags);

      virtual void addScriptedTask(const DtScriptedTaskMetaData&, bool signal = true);

      virtual void addScriptedTasks(DtSubMenuConfiguration&, makVrv::DtToolbarConfiguration&, DtConfigurableMenuAssembler&,
         bool addToolbarMenuItems = true, bool useGlobalMenuManager = false);

      virtual void setScriptedTasks(const ScriptedTasks&, bool signal = true);
      virtual const ScriptedTasks& scriptedTasks() const;

      virtual void setMenuConfiguration(const DtSubMenuConfiguration&);

      virtual int supportedScriptType(int type) const = 0;
      virtual const char* supportsToolbarType() const = 0;

      boost::signals2::signal<void (DtSubMenuConfiguration&)> signal_preCreateConfiguration;

      boost::signals2::signal<void ()> signal_recreateMenu;

      DtVrfTaskSetMenu* menu()
      {
         return myMenu;
      }

   protected:
      virtual void scriptIdChanged(const std::string& oldId, const std::string& newId, int action);
      virtual bool eventFilter(QObject* o, QEvent* e) override;
      virtual void slot_sendTaskRequest(std::vector<DtUUID> names, const DtSimTask& s);
      virtual void slot_sendSetRequest(std::vector<DtUUID> names, const DtSetDataRequest& s);

      virtual void menuRecreated();
      virtual void clearScriptedTasks();
      virtual void scriptedTaskAboutToBeRemoved(std::string id);
      virtual void scriptedTaskAdded(std::string id);
      virtual void receivedScriptedTasks();

      virtual void clearRegisteredMenuAssemblers();
      virtual void clearRegisteredMenuAssembler(const std::string&);

      virtual void removeAllScriptedTasks(bool signal = true);
      virtual void removeScriptedTask(const std::string& id, bool signal = true);

      virtual std::string addScriptedTaskMenuLocation(const std::string& scriptedTaskId, const std::string& potentialPath,
         const QString& menuName, const QString& extMenuName, const QString& toolTip, DtSubMenuConfiguration& configuration,
         DtConfigurableMenuAssembler&, bool showInMenu = true, bool addToolbarMenuItems = true, bool useGlobalMenuManager = false);

      virtual std::string addScriptedTaskToolbarLocation(const std::string& scriptedTaskId, makVrv::DtToolbarConfiguration& configuration);

   protected:
      RecreateFlags myRecreateFlags;
      ScriptedTasks myScriptedTasks;
      bool myEditMode;
      makVrv::DtSignalConnectionManager myConnectionManager;
      DtSubMenuConfiguration myConfiguration;
      DtVrfTaskSetMenu* myMenu;
      std::set<std::string> myScriptedTasksAddedToMenuAssember;
      std::map<std::string, std::string> myScriptedTaskMenuItems;
   }; 

   class DT_DLL_VRFGUITASKSETQT DtScriptedTaskMenuItem : public DtVrfTaskSetMenuItem
   {
   public:
      DtScriptedTaskMenuItem(makVrv::DtDe& de, const std::string& scriptedTaskId, const std::string& menuId,
         const makVrv::DtUnicode& menuName, const makVrv::DtUnicode& extMenuName, const makVrv::DtUnicode& toolTip,
         bool showInMenu, bool addToolbarItem = true);

      virtual ~DtScriptedTaskMenuItem() override;

      virtual QAction* createAction(makVrv::DtDe&, QWidget* parent) override;

      virtual void setMenuName(const makVrv::DtUnicode&);

      void setUseSharedAction(bool);

   protected:
      virtual void on_aboutToShow() override;

   protected:
      std::string myScriptedTaskId;
      makVrv::DtUnicode myMenuName;
      makVrv::DtUnicode myExtendedMenuName;
      makVrv::DtUnicode myToolTip;
      bool myShowInMenu;
      bool myUseSharedAction;
      QAction* mySharedAction;
   };
}