createMenu.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCoreQt/vrfGuiCoreQt.h>
#include <vrfGuiCoreQt/selectionEnabledMenu.h>
#include <vrfGuiCoreQt/vrfScenarioManager.h>
#include <vrfGuiCoreQt/createObjectAction.h>
#include <vrfGuiConstants/vrfMenuIds.h>
#include <vrfGuiCore/vrfObjectManipulationHandlerBaseClass.h>
#include <vrfGuiCore/orderedEntityTypeList.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <vrvCoreQt/DtMenu.h> 

#include <QtCore/QObject>
#include <QtWidgets/QMenu>

#include <matrix/vlVector.h>

namespace makVrv
{
   class DtDe;
   class DtQtMenuAssembler;
   class DtMenuConfiguration;
};

class QAction;
class QActionGroup;
class DtScenarioExplorer;
class DtString;
class DtFilename;
class DtEntityType;

namespace makVrf
{
   class DtVrfBackendState;
   class DtMenu;
   class DtCreateMenu;
   class DtEntityMapperKey;

   enum DtCreateMenuFlags
   {
      DtCreateMenuCreateAll = 0,                         
      DtCreateMenuRemovePaletteItems = 0x00000001,       
      DtCreateMenuRemoveExtraCreateItems = 0x00000002,   
      DtCreateMenuOnlySMSItems = (DtCreateMenuRemovePaletteItems |  DtCreateMenuRemoveExtraCreateItems)
   };

   class DT_DLL_VRFGUICOREQT DtVrfCreateMenu : public DtAssembledMenu
   {
      Q_OBJECT

   public:
      typedef std::map<std::string, QAction*>  MappedActions;

      DtVrfCreateMenu(makVrv::DtDe&, const QString& name, QWidget* parent = 0, makVrf::DtMenu* baseCreateMenu = 0,
         bool useGlobalMenuManager = false, DtCreateMenuFlags = DtCreateMenuCreateAll);
      virtual ~DtVrfCreateMenu();

      virtual void setupMenu(makVrf::DtMenu*, const makVrv::DtMenuConfiguration& initialCreateMenuConfiguration = makVrv::DtMenuConfiguration());

      virtual void setMenuBuilder(DtCreateMenu*);

      virtual bool signalCreation() const;

      boost::signal<void (const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData&)> signal_createObject;
      virtual void slot_createObject(const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData&);

      boost::signal<void (const DtEntityMapperKey&, int force, const std::string& keywords)> signal_creatingObject;

      virtual void slot_creationStopped();

      virtual DtEntityType nameToType(const QString&) const;

      virtual bool triggerAction(const DtEntityMapperKey& key);

      virtual const MappedActions& mappedActions() const;

   protected:
      virtual void setupConnections();

      virtual void buildCreationMenu(const DtList& list,
         DtConfigurableMenuAssembler& assemblers, DtSubMenuConfiguration& configurations,
         const makVrv::DtMenuPath& rootr);

      virtual void addAdditionalItems(DtConfigurableMenuAssembler& assemblers, DtSubMenuConfiguration& configurations);

      virtual void clearMenu();

      virtual void enableActions(const QList<QAction*>&);

      virtual void destroyActions(const QList<QAction*>&);

      virtual bool canCreate(QAction*) const;

      bool removePaletteItems() const
      {
         return ((myMenuFlags & DtCreateMenuRemovePaletteItems) != 0);
      }

      bool removeExtraCreateItems() const
      {
         return ((myMenuFlags & DtCreateMenuRemoveExtraCreateItems) != 0);
      }

      virtual void slot_createMenuLoaded(const DtScenarioExplorer&);

      virtual void recreateMenu();

      virtual void slot_backendUpdated(const DtVrfBackendState&, int);

      virtual void mergeChangesFrom(const DtSubMenuConfiguration&, DtSubMenuConfiguration&);

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

      virtual DtCreateObjectAction* createObjectActionFor(const std::string& menuId, const QString& menuName, const DtEntityMapperKey& key,
         const std::string& keywords, const std::string& menuIcon, const std::string& toolTip) const;

      virtual void addMappedActionsFrom(QMenu*);

      virtual bool updateSubMenuVisibilityState(QMenu*);

   protected slots:
      virtual void onCreateObjectFromMenu(const DtEntityMapperKey&, int, const std::string&);

      virtual void enableMenu();

      virtual void createMenuDestroyed();

   protected:
      QMenu*                        myCreateMenu;
      DtCreateMenu* myBuilder;
      bool myCreating;
      MappedActions myMappedActions;
      DtCreateMenuFlags myMenuFlags;
      bool myUseGlobalMenuManager;

      typedef std::pair<DtCreateObjectAction*, QAction*> ObjectActionData;
      typedef std::map<std::string, ObjectActionData> TempObjectActions;
      TempObjectActions myTempObjectActions;

      makVrf::DtMenu* myBaseCreateMenu;
   };

   class DT_DLL_VRFGUICOREQT DtCreateMenu : public DtConfigurableMenu
   {
   public:
      struct AdditionalItem
      {
         AdditionalItem()
         : before(false)
         , path(makVrv::DtMenuPath::empty())
         , related(makVrv::DtMenuPath::empty())
         {
         };

         makVrv::DtMenuPath   path;
         DtEntityMapperKey    key;
         makVrv::DtMenuPath   related;
         std::string          keywords;
         std::string          menuIcon;
         bool                 before;
      };

      typedef std::vector<AdditionalItem> AdditionalItems;
      typedef DtOrderedEntityTypeList<DtCreateObjectActionCreator*>  ObjectActionCreators;

   public:

      DtCreateMenu(makVrv::DtDe&, const QString& createName = DtCreateMenuId);

      virtual ~DtCreateMenu();

      virtual QMenu* createMenu(makVrv::DtDe&, QWidget* parent);

      static DtCreateMenu& instance(makVrv::DtDe&);

      virtual void setUseGlobalMenuManager(bool);
      virtual bool useGlobalMenuManager() const;

      static DtCreateMenu* menuInstance(makVrv::DtDe&);

      virtual DtCreateMenu* newInstance();

      virtual DtCreateMenu* clone() const;

      virtual DtCreateMenu* duplicate(QMenu*&, QWidget* parent, makVrf::DtMenu* menu = 0);

      void setTearOffsEnabled(bool b)
      {
         myTearOffsEnabled = b;
      }

      virtual void setBaseCreateMenu(makVrf::DtMenu*);

      virtual DtEntityType nameToType(const QString&) const;

      virtual bool triggerAction(const DtEntityMapperKey& key);

      bool tearOffsEnabled() const
      {
         return myTearOffsEnabled;
      }

      virtual void setSignalCreation(bool);
      bool signalCreation() const
      {
         return mySignalCreation;
      }

      const AdditionalItems& additionalItems() const
      {
         return myAdditionalItems;
      }

      AdditionalItems& additionalItems()
      {
         return myAdditionalItems;
      }

      virtual void setCreateObjectActionCreatorFor(const DtEntityType&, DtCreateObjectActionCreator*);

      virtual DtCreateObjectActionCreator* createObjectActionCreatorFor(const DtEntityType&) const;

      const DtVrfCreateMenu::MappedActions& mappedActions() const;

      virtual DtCreateMenuFlags menuFlags() const
      {
         return myMenuFlags;
      }

      bool removePaletteItems() const
      {
         return ((myMenuFlags & DtCreateMenuRemovePaletteItems) != 0);
      }

      bool removeExtraCreateItems() const
      {
         return ((myMenuFlags & DtCreateMenuRemoveExtraCreateItems) != 0);
      }

      virtual void setMenuFlags(DtCreateMenuFlags b)
      {
         myMenuFlags = b;
      }

   public:
      boost::signal<void (const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData&)> signal_createObject;

   protected:
      virtual void createMenuConfiguration(makVrv::DtDe& de);

   public:
      virtual DtSubMenuConfiguration& menuConfiguration();

      virtual DtConfigurableMenuAssembler& menuAssembler();

   public:
      virtual void addItemToCreate(const makVrv::DtMenuPath& path, const DtEntityMapperKey& key,
         const DtString& keywords = "", const DtString& menuIcon = "");

      virtual void removeItemToCreate(const makVrv::DtMenuPath&);

      virtual void addItemToCreateBefore(const makVrv::DtMenuPath& path,
         const makVrv::DtMenuPath& before, const DtEntityMapperKey& key, const DtString& keywords = "", const DtString& menuIcon = "");

      virtual void addItemToCreateAfter(const makVrv::DtMenuPath& path,
         const makVrv::DtMenuPath& after, const DtEntityMapperKey& key, const DtString& keywords = "", const DtString& menuIcon = "");

   protected:
      virtual void slot_onCreateObject(const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData&);
      virtual void menuRecreated();

   protected:
      bool                       myTearOffsEnabled;

      AdditionalItems            myAdditionalItems;
      bool mySignalCreation;
      ObjectActionCreators       myObjectActionCreators;

      DtCreateMenuFlags          myMenuFlags;

      static DtConfigurableMenuAssembler* theMenuAssembler;
      static DtSubMenuConfiguration* theMenuConfiguration;

      makVrf::DtMenu* myBaseCreateMenu;
      bool myUseGlobalMenuManager;
   }; 

   class DT_DLL_VRFGUICOREQT DtRightClickCreateMenu : public DtCreateMenu
   {
   public:
      DtRightClickCreateMenu(makVrv::DtDe& de);
      virtual ~DtRightClickCreateMenu();

   protected:
      virtual QMenu* createMenu( makVrv::DtDe& de, QWidget* parent );

   protected:
      DtCreateMenu* myCreateMenu;
   };
}