src/CAM/CAM_Module.h

   1 // Copyright (C) 2007-2012  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.
  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 CAM_MODULE_H
  24 #define CAM_MODULE_H
  25
  26 #include "CAM.h"
  27
  28 #include <QObject>
  29 #include <QPixmap>
  30 #include <QString>
  31 #include <QMap>
  32
  33 class QAction;
  34 class QMenu;
  35 class QIcon;
  36
  37 class QtxActionMenuMgr;
  38 class QtxActionToolMgr;
  39 class SUIT_Study;
  40 class SUIT_Application;
  41 class CAM_Study;
  42 class CAM_DataModel;
  43 class CAM_Application;
  44
  45 #ifdef WIN32
  46 #pragma warning( disable: 4251 )
  47 #endif
  48
  49 class CAM_EXPORT CAM_Module : public QObject
  50 {
  51   Q_OBJECT
  52
  53 public:
  54   CAM_Module();
  55   CAM_Module( const QString& );
  56   virtual ~CAM_Module();
  57
  58   virtual void           initialize( CAM_Application* );
  59
  60   QString                name() const;
  61   QString                moduleName() const;
  62   virtual QPixmap        moduleIcon() const;
  63   virtual QString        iconName() const;
  64
  65   CAM_DataModel*         dataModel() const;
  66   CAM_Application*       application() const;
  67
  68   virtual void           contextMenuPopup( const QString&, QMenu*, QString& ) {};
  69   virtual void           updateCommandsStatus() {};
  70
  71   virtual void           putInfo( const QString&, const int = -1 );
  72
  73   bool                   isActiveModule() const;
  74
  75   virtual void           setMenuShown( const bool );
  76   void                   setMenuShown( QAction*, const bool );
  77   void                   setMenuShown( const int, const bool );
  78
  79   virtual void           setToolShown( const bool );
  80   void                   setToolShown( QAction*, const bool );
  81   void                   setToolShown( const int, const bool );
  82
  83   virtual void           updateModuleVisibilityState();
  84
  85 public slots:
  86   virtual bool           activateModule( SUIT_Study* );
  87   virtual bool           deactivateModule( SUIT_Study* );
  88
  89   virtual void           connectToStudy( CAM_Study* );
  90
  91   virtual void           studyClosed( SUIT_Study* );
  92   virtual void           studyChanged( SUIT_Study*, SUIT_Study* );
  93
  94   virtual void           onApplicationClosed( SUIT_Application* );
  95
  96 private slots:
  97   void                   onInfoChanged( QString );
  98
  99 protected:
 100   virtual bool           isSelectionCompatible();
 101
 102   virtual CAM_DataModel* createDataModel();
 103
 104   void                   setName( const QString& );
 105   virtual void           setModuleName( const QString& );
 106
 107   QtxActionMenuMgr*      menuMgr() const;
 108   QtxActionToolMgr*      toolMgr() const;
 109
 110   int                    createTool( const QString& );
 111   int                    createTool( const int, const int, const int = -1 );
 112   int                    createTool( const int, const QString&, const int = -1 );
 113   int                    createTool( QAction*, const int, const int = -1, const int = -1 );
 114   int                    createTool( QAction*, const QString&, const int = -1, const int = -1 );
 115
 116   int                    createMenu( const QString&, const int, const int = -1, const int = -1, const int = -1 );
 117   int                    createMenu( const QString&, const QString&, const int = -1, const int = -1, const int = -1 );
 118   int                    createMenu( const int, const int, const int = -1, const int = -1 );
 119   int                    createMenu( const int, const QString&, const int = -1, const int = -1 );
 120   int                    createMenu( QAction*, const int, const int = -1, const int = -1, const int = -1 );
 121   int                    createMenu( QAction*, const QString&, const int = -1, const int = -1, const int = -1 );
 122
 123   static QAction*        separator();
 124
 125   QAction*               action( const int ) const;
 126   int                    actionId( const QAction* ) const;
 127
 128   int                    registerAction( const int, QAction* );
 129   bool                   unregisterAction( const int );
 130   bool                   unregisterAction( QAction* );
 131   QAction*               createAction( const int, const QString&, const QIcon&, const QString&,
 132                                        const QString&, const int, QObject* = 0,
 133                                        const bool = false, QObject* = 0, const char* = 0, const QString& = QString() );
 134
 135 private:
 136   CAM_Application*       myApp;             //!< parent application object
 137   QString                myName;            //!< module title (user name)
 138   QPixmap                myIcon;            //!< module icon
 139   QString                myInfo;            //!< latest info message
 140   CAM_DataModel*         myDataModel;       //!< data model
 141   QMap<int, QAction*>    myActionMap;       //!< menu actions
 142   bool                   myMenuShown;       //!< menu shown flag
 143   bool                   myToolShown;       //!< tool shown flag
 144
 145   friend class CAM_Application;
 146 };
 147
 148 #ifdef WIN32
 149 #pragma warning( default: 4251 )
 150 #endif
 151
 152 extern "C"
 153 {
 154   typedef CAM_Module* (*GET_MODULE_FUNC)();
 155   typedef char* (*GET_VERSION_FUNC)();
 156 }
 157
 158 #define GET_MODULE_NAME "createModule"
 159 #define GET_VERSION_NAME "getModuleVersion"
 160 #endif