src/SUIT/SUIT_ViewModel.h

   1 // Copyright (C) 2007-2023  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef SUIT_VIEWMODEL_H
  24 #define SUIT_VIEWMODEL_H
  25
  26 #include "SUIT.h"
  27
  28 #include <QObject>
  29 #include <QMap>
  30
  31 class QMenu;
  32
  33 class SUIT_Desktop;
  34 class SUIT_ViewWindow;
  35 class SUIT_ViewManager;
  36
  37 #ifdef WIN32
  38 #pragma warning( disable:4251 )
  39 #endif
  40 /*!
  41  * This object manages the definition and behaviour of a View Window. \n
  42  * In case of definition of this object in an external lib that lib must \n
  43  * have an exported function "createViewModel" which returns newly created \n
  44  * instance of SUIT_ViewModel.
  45  */
  46 class SUIT_EXPORT SUIT_ViewModel : public QObject
  47 {
  48         Q_OBJECT
  49 public:
  50   enum HotOperation { PAN, ZOOM, ROTATE, FIT_AREA };
  51   enum InteractionStyle { STANDARD, KEY_FREE };
  52
  53   typedef QMap<HotOperation, Qt::KeyboardModifiers> StatesMap;
  54   typedef QMap<HotOperation, Qt::MouseButtons>      ButtonsMap;
  55
  56   typedef QMap<InteractionStyle, StatesMap>         InteractionStyle2StatesMap;
  57   typedef QMap<InteractionStyle, ButtonsMap>        InteractionStyle2ButtonsMap;
  58
  59   SUIT_ViewModel();
  60   virtual ~SUIT_ViewModel();
  61
  62   virtual SUIT_ViewWindow* createView( SUIT_Desktop* theDesktop );
  63
  64   virtual void      setViewManager(SUIT_ViewManager* theViewManager);
  65   SUIT_ViewManager* getViewManager() const;
  66
  67   virtual QString   getType() const { return "SUIT_ViewModel"; }
  68
  69   virtual void      contextMenuPopup( QMenu* ) {}
  70
  71   static void       setHotButton( InteractionStyle theInteractionStyle, HotOperation theOper,
  72                                   Qt::KeyboardModifiers theState, Qt::MouseButtons theButton );
  73   static void       getHotButton( InteractionStyle theInteractionStyle, HotOperation theOper,
  74                                   Qt::KeyboardModifiers& theState, Qt::MouseButtons& theButton );
  75
  76 protected:
  77   SUIT_ViewManager* myViewManager;
  78
  79 public:
  80   static InteractionStyle2StatesMap  myStateMap;
  81   static InteractionStyle2ButtonsMap myButtonMap;
  82 };
  83
  84 #ifdef WIN32
  85 #pragma warning( default:4251 )
  86 #endif
  87
  88 extern "C"
  89 {
  90   typedef SUIT_ViewModel* (*VIEWMODEL_CREATE_FUNC)();
  91 }
  92
  93 #define VIEWMODEL_CREATE_NAME   "createViewModel"
  94
  95 #endif