include/vrvCoreQt/DtKeyMappingEditorWidgetInterface.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: DtKeyMappingEditorWidgetInterface.h,v $ $Revision: 1.10 $ $State: Exp $
******************************************************************************/


#pragma once

#include <vrvUtil/signalslib.h>

#include <vrvCoreQt/vrvCoreQt.h>
#include <vrvCore/DtKeyEvent.h>

class QWidget;

namespace makVrv
{
   class DtKeyMapping;
   class DtKeyFunctionNameList;
   
   class DT_DLL_VRVCOREQT DtKeyMappingEditorWidgetInterface
   {

   public:
      virtual ~DtKeyMappingEditorWidgetInterface();

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

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

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

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

      virtual void clearKeyFunctions() = 0;

      virtual void sortKeyFunctions() = 0;

      virtual void selectKeyFunction(const std::string& name) = 0;

      virtual void selectKeyMapping( const DtKeyMapping& keyMapping, bool isBinary ) = 0;
      
      virtual void setEnableFilterEditor(bool filters) = 0;

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

      virtual QWidget* widget() = 0;

   public:
      boost::signal<void (int)> signal_filterChanged;
      boost::signal<void ()> signal_deselectKeyMappings;
      boost::signal<void (const DtKeyMapping&)> signal_selectKeyMapping;
      boost::signal<void ()> signal_deselectFunctions;
      boost::signal<void (const std::string&)> signal_selectFunction;
      boost::signal<void ()> signal_addKeyMapping;
      boost::signal<void ()> signal_removeKeyMapping;
      boost::signal<void ()> signal_editKeyMapping;
      boost::signal<void ()> signal_requestInputCanceled;
      boost::signal<void (const DtKeyMapping&, bool)> signal_requestInputAccepted;
      boost::signal<void (const DtKeyMapping&,
         const DtKeyFunctionNameList&, bool, bool)> signal_requestKeyValidationAccepted;
   };
}