DtKeyMappingEditorWidget.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCoreQt/vrvCoreQt.h>

#include <QtWidgets/QWidget>
#include <QtWidgets/QDialog>
#include <QtWidgets/QLabel>
#include <vrvCoreQt/DtKeyMappingEditorWidgetInterface.h>
#include <vrvCore/DtKeyMap.h>

class QAbstractButton;
class QActionGroup;
class QButtonGroup;
class QHBoxLayout;
class QLineEdit;
class QMenu;
class QPushButton;
class QRadioButton;
class QSplitter;
class QTreeWidget;
class QTreeWidgetItem;
class QVBoxLayout;
class QWidget;
class QListWidget;
class QFocusEvent;

namespace makVrv
{

   class DtRequestKeyMapKeyDialog;
   class DtRequestKeyValidationDialog;

   class DT_DLL_VRVCOREQT DtKeyMappingEditorWidget : public QWidget,
      public DtKeyMappingEditorWidgetInterface
   {

      Q_OBJECT

   public:

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

      virtual ~DtKeyMappingEditorWidget();

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

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

      virtual void addChildKeyFunction(const std::string& name, const std::string& parentName,
         const std::string& keyString);

      virtual void deleteKeyFunction(const std::string& name);

      virtual void clearKeyFunctions();

      virtual void selectKeyFunction(const std::string& name);
      
      virtual void selectKeyMapping( const DtKeyMapping& keyMapping, bool isBinary );

      virtual void setEnableFilterEditor(bool filters);

      virtual void setFilters(const std::vector<std::pair<int,bool> >& filters);
      
      virtual void sortKeyFunctions();
     
      virtual void addKeyMapping( const DtKeyMapping& keyMapping, 
         bool suppressUpDown );
      
      virtual void removeKeyMapping( const DtKeyMapping& keyMapping );
      
      virtual void clearKeyMappings();
      
      virtual void setEnableAddMappingButton( bool enabled );
      
      virtual void setEnableRemoveMappingButton( bool enabled );
      
      virtual void setEnableEditMappingButton( bool enabled );
      
      virtual void requestInput( const std::string& functionName, 
        const DtKeyMapping& keyMapping, bool isBinary );
      
      virtual void requestInput( const std::string& functionName, bool isBinary );
      
      virtual void closeEditor();
      
      virtual std::string unmappedString();
       
      virtual void requestKeyValidation( const DtKeyMapping& keyMapping, 
         const std::string& functionName, const DtKeyFunctionNameList& fnList, bool isEdit );               
            
      virtual void disableEditor();
      
      virtual void enableEditor();

      virtual QWidget* widget();

      virtual void resizeColumnToContents();
     
   protected slots:
      
      virtual void onFunctionItemSelectionChanged();
      
      virtual void onEditItemSelectionChanged();
      
      virtual void onFilterGroupTriggered(QAction* action);
      
      virtual void onAddMappingClicked();
      
      virtual void onRemoveMappingClicked();
      
      virtual void onEditMappingClicked();
      
   protected:
      virtual void closeEvent(QCloseEvent*);

      virtual void hideEvent(QHideEvent*);

      void slot_requestInputAccepted(const DtKeyMapping&, bool);
      void slot_requestInputCanceled();

      void slot_requestKeyValidationAccepted( const DtKeyMapping& keyMapping,
         const DtKeyFunctionNameList& fnList, bool isEdit, bool replace);

      QString selectedKeyFunctionName() const;
      void functionCategoryToCategoryName( int category, QString& categoryName );
      void setupGui();
      QTreeWidgetItem* findItem( const std::string& key );
      QTreeWidgetItem* findKeyMapping( const DtKeyMapping& mapping, bool isBinary );

   protected:

      DtDe& myDe;
      std::string myKeyMapName;

      QPushButton* myFilterButton;
      QLabel* myFilterLabel;
      QActionGroup* myFilterGroup;
      QMenu* myFilterMenu;
      QWidget* myFunctionWidget;
      QWidget* myEditWidget;
      QTreeWidget* myFunctionTreeWidget;
      QTreeWidget* myEditTreeWidget;

      QSplitter* myTreeWidgetSplitter;
      QVBoxLayout* myFunctionLayout;
      QVBoxLayout* myMappingEditorLayout;
      QHBoxLayout* myMappingEditorButtonLayout;
      QHBoxLayout* myButtonLayout;
      QPushButton* myEditMappingButton;
      QPushButton* myAddMappingButton;
      QPushButton* myRemoveMappingButton;
      DtRequestKeyMapKeyDialog* myRequestDialog;
      DtRequestKeyValidationDialog* myRequestKeyValidationDialog;

      bool mySaveFilterEnabledState;
      bool mySaveFunctionListEnabledState;
      bool mySaveMappingListEnabledState;
      bool mySaveEditMappingButtonEnabledState;
      bool mySaveAddMappingButtonEnabledState;
      bool mySaveRemoveMappingButtonEnabledState;
      bool myEditorDisabled;
      bool myIsClosing;

   };


   class DT_DLL_VRVCOREQT DtRequestKeyMapKeyDialog : public QDialog
   {  Q_OBJECT;
   public:

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

      virtual ~DtRequestKeyMapKeyDialog();

      virtual void keyPressEvent( QKeyEvent * event );

      virtual void closeEvent(QCloseEvent *event);     

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

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

   protected slots:

      void onOkClicked();

      void onCancelClicked();

      void onUpRadioButtonClicked();

      void onDownRadioButtonClicked();

   public:

      boost::signalslib::signal<void ()> signal_requestInputCanceled;
      boost::signalslib::signal<void (const DtKeyMapping&, bool)> signal_requestInputAccepted;
      boost::signalslib::signal<void (const DtKeyMapping&,
         const DtKeyFunctionNameList&, bool, bool)> signal_requestKeyValidationAccepted;

   protected:

      void setupGui();
      QString keyMappingToQString( const DtKeyMapping& keyMapping );

   protected:

      QLabel* myFunctionNameLabel;
      QLineEdit* myKeyTextLineEdit;
      QButtonGroup* myUpDownButtonGroup;
      QRadioButton* myUpRadioButton;
      QRadioButton* myDownRadioButton;
      QVBoxLayout* myUpDownLayout;
      QHBoxLayout* myEntryLayout;
      QPushButton* myOkButton;
      QPushButton* myCancelButton;
      QHBoxLayout* myBottomButtonLayout;
      QVBoxLayout* myDialogLayout;

      DtKeyMapping myKeyMapping;
      DtKeyMapping myInitialEditKeyMapping;
      bool myUserTyped;

      bool myIsBinary;
      bool myIsClosing;
      bool myIsEdit;

   };


   class DT_DLL_VRVCOREQT DtRequestKeyValidationDialog : public QDialog
   {  Q_OBJECT;
   public:

      DtRequestKeyValidationDialog( QWidget* parent = 0, Qt::WindowFlags flags = Qt::Tool | Qt::WindowTitleHint );

      virtual ~DtRequestKeyValidationDialog();

      virtual void closeEvent( QCloseEvent *event );

      void show( const DtKeyMapping& keyMapping, const std::string& functionName,
         const DtKeyFunctionNameList& fnList, bool isEdit );

   protected slots:

      void onAddClicked();

      void onReplaceClicked();

      void onCancelClicked();

   public:

      boost::signalslib::signal<void ()> signal_requestInputCanceled;
      boost::signalslib::signal<void (const DtKeyMapping&, bool)> signal_requestInputAccepted;
      boost::signalslib::signal<void (const DtKeyMapping&,
         const DtKeyFunctionNameList&, bool, bool)> signal_requestKeyValidationAccepted;

   protected:

      void setupGui();

      QString keyMappingToQString( const DtKeyMapping& keyMapping );

   protected:

      QLabel* myFunctionNamePrefixLabel;
      QLabel* myFunctionNameSuffixLabel;
      QListWidget* myFunctionNameList;
      QPushButton* myAddButton;
      QPushButton* myReplaceButton;
      QPushButton* myCancelButton;
      QHBoxLayout* myBottomButtonLayout;
      QVBoxLayout* myMainLayout;

      DtKeyMapping myKeyMapping;
      DtKeyFunctionNameList myFnList;
      bool myIsClosing;
      bool myIsEdit;

   };

}