vrfMenuKeyMapManager.h

Go to the documentation of this file.

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



#pragma once

#if !defined(Q_MOC_RUN)
#include <vrfGuiCommonQt/vrfGuiCommonQt.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <vrvCore/DtMenuPath.h>
#include <vrvCore/DtKeyMapManager.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvCore/DtKeyMapManagerSignaler.h>
#include <vrvCore/DtKeyState.h>
#include <vrvCoreQt/DtKeyMappingEditorPage.h>
#include <vrvCoreQt/DtKeyMappingEditorWidget.h>
#endif

#include <QObject>

class QEvent;
class QAction;
class QCheckBox;
class QTranslator;
class QKeyEvent;

namespace makVrv
{
   class DtKeyMap;
   class DtDe;
   class DtMenuManager;
}

namespace makVrf
{
   class DtAssembledMenu;

   class DT_DLL_VRFGUICOMMONQT DtVrfMenuKeyMapManager : public QObject,
      public makVrv::DtVirtualBaseClass
   {
      Q_OBJECT

   public:
      DtVrfMenuKeyMapManager(makVrv::DtDe&);
      virtual ~DtVrfMenuKeyMapManager() override;

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

      virtual void setup();

      virtual void addNonFocusKeyMapFunction(const std::string&);
      virtual void removeNonFocusKeyMapFunction(const std::string&);

      virtual void addKeyboardMenuMapping(const makVrv::DtMenuPath& path, const makVrv::DtMenuManager* localMenuManager = nullptr, QAction* act = nullptr);

      virtual void removeKeyboardMenuMapping(const makVrv::DtMenuPath& path, const makVrv::DtMenuManager* localMenuManager = nullptr, QAction* act = nullptr);

      virtual void setApplyChangesToAllKeymaps(bool);
      virtual bool applyChangesToAllKeymaps() const;

      virtual bool isMenuFunction(const std::string& func) const;

      virtual QString reverseTranslate(const QString&) const;

      virtual void copyKeyFunction(const makVrv::DtMenuPath& from, const makVrv::DtMenuPath& to);

      virtual bool setSaveManagersOnChange(bool);
      virtual bool saveManagersOnChange() const;

      virtual bool hasActionToProcessNonFocusKey(const QKeySequence&);
      virtual QString keyStateToKeySequence(const makVrv::DtKeyState&) const;
      virtual QString actionTypeToKeySequence(int) const;

      virtual makVrv::DtKeyEvent vrvKeyEventFromQtKeyEvent(const QKeyEvent& e) const;
      virtual makVrv::DtKeyState::KeyType qtKeyEventToVrvKey(const QKeyEvent&) const;

   protected slots:
      virtual void actionDestroyed();

   protected:
      virtual bool eventFilter(QObject*, QEvent*) override;

      virtual std::string menuPathToFunctionName(const makVrv::DtMenuPath&, const makVrv::DtMenuManager* localMenuManager = nullptr) const;

      virtual void slot_triggerShortcut(makVrv::DtMenuPath, const makVrv::DtMenuManager* localMenuManager = nullptr);

      virtual void setKeyMap(makVrv::DtKeyMapManager*, std::string currentMap);

      virtual void manageChangeableMenu(const std::string& menuId);

      virtual void setupChangeableMenus();

      virtual void preAssembleConfigurableMenu(DtAssembledMenu*);

      virtual void postAssembleConfigurableMenu(DtAssembledMenu*);

      virtual int mapPathToKeymapFunctionCategory(const std::string& path);

      virtual void keyMappingRemoved(makVrv::DtKeyMap*, std::string,  makVrv::DtKeyState::KeyType,
         makVrv::DtKeyEvent::KeyEventType, makVrv::DtKeyState::KeyModifier);

      virtual void keyMappingModified(makVrv::DtKeyMap*, std::string,  makVrv::DtKeyState::KeyType,
         makVrv::DtKeyEvent::KeyEventType, makVrv::DtKeyState::KeyModifier);

      virtual bool setupKeyMappingFor(const std::string& path, QAction* action, makVrv::DtKeyMap* map);

      virtual void resetShortcut(makVrv::DtKeyMap*, std::string);

      void parseTSFile(const QString& file);

      virtual void zoomToExtents();

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

      std::map<QKeySequence, std::set<QAction*>> myShortcuts;
      std::map<QKeySequence, std::string> myNonFocusShortcutsByKeySequence;
      std::set<std::string> myNonFocusShortcuts;

      typedef std::map<std::string, std::map<std::string, QAction*>> FunctionToPathMap;
      FunctionToPathMap myFunctionToPathMap;

      typedef std::map<std::string, std::string> PathToFunctionMap;
      PathToFunctionMap myPathToFunctionMap;

      typedef std::map<std::string, int> FunctionCategoryMap;
      FunctionCategoryMap myFunctionCategories;

      typedef std::map<int, std::pair<std::string, QAction*>> ActionTypeToPathMap;
      ActionTypeToPathMap myActionTypeToPathMap;

      bool myApplyChangesToAllKeymaps;
      std::map<QString, QString> myReverseMap;

      bool mySaveManagersOnChange;
      std::string myCurrentKeyMap;
      bool mySetupChanged;
   };

   class DT_DLL_VRFGUICOMMONQT DtVrfKeyMappingEditorPage : public makVrv::DtKeyMappingEditorPage
   {
   public:
      DtVrfKeyMappingEditorPage(makVrv::DtDe& de, QWidget* parent, Qt::WindowFlags f);

      virtual ~DtVrfKeyMappingEditorPage() override;
   };

   typedef makVrv::DtPageCreatorTemplate<DtVrfKeyMappingEditorPage> 
      DtVrfKeyMappingEditorPageCreator;

   class DT_DLL_VRFGUICOMMONQT DtVrfKeyMappingEditorWidget : public makVrv::DtKeyMappingEditorWidget
   {
      Q_OBJECT

   public:
      DtVrfKeyMappingEditorWidget( makVrv::DtDe& de, QWidget* parent, Qt::WindowFlags flags = 0);

      virtual ~DtVrfKeyMappingEditorWidget() override;

   protected:
      virtual void closeEvent(QCloseEvent*) override;

      virtual void hideEvent(QHideEvent*) override;

      virtual void addKeyFunction(const std::string& name, const std::string& keyString) override;

   protected slots:
      virtual void on_applyChangesToAllKeymapsChanged();
      
      virtual void requestInput(
         const std::string& functionName, const makVrv::DtKeyMapping& keyMapping, bool isBinary) override;
      virtual void requestInput(const std::string& functionName, bool isBinary) override;

   protected:
      QCheckBox* myApplyChangesToAllKeymaps;
      makVrv::DtRequestKeyMapKeyDialog* myMenuItemKeyMapDialog;
   };

   class DT_DLL_VRFGUICOMMONQT DtVrfRequestKeyMapKeyDialog : public makVrv::DtRequestKeyMapKeyDialog
   {
   public:

      DtVrfRequestKeyMapKeyDialog( QWidget* parent = 0, Qt::WindowFlags flags = Qt::Tool );

      virtual ~DtVrfRequestKeyMapKeyDialog() override;

      void show( std::string functionName, bool isBinary  );

      void show( std::string functionName, const makVrv::DtKeyMapping& keyMapping,
         bool isBinary  );
   };
}