src/CAM/CAM_Application.h

   1 // Copyright (C) 2007-2023  CEA, EDF, 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 CAM_APPLICATION_H
  24 #define CAM_APPLICATION_H
  25
  26 #include "CAM.h"
  27
  28 #include <STD_Application.h>
  29 #include <QList>
  30
  31 class QMenu;
  32 class CAM_Module;
  33
  34 #ifdef WIN32
  35 #pragma warning( disable:4251 )
  36 #endif
  37
  38 class CAM_EXPORT CAM_Application : public STD_Application
  39 {
  40   Q_OBJECT
  41
  42 public:
  43   typedef QList<CAM_Module*> ModuleList;
  44   typedef struct { QString name;  QString version; } ModuleShortInfo;
  45   typedef QList<ModuleShortInfo> ModuleShortInfoList;
  46
  47 public:
  48   CAM_Application( const bool = true );
  49   virtual ~CAM_Application();
  50
  51   virtual void        start();
  52
  53   CAM_Module*         activeModule() const;
  54   CAM_Module*         module( const QString& ) const;
  55
  56   ModuleList          modules() const;
  57   void                modules( ModuleList& ) const;
  58   void                modules( QStringList&,
  59                                const bool loaded = true ) const;
  60
  61   virtual void        addModule( CAM_Module* );
  62
  63   virtual void        loadModules();
  64   virtual CAM_Module* loadModule( const QString&, const bool = true );
  65
  66   virtual bool        activateModule( const QString& );
  67
  68   bool                activateOperation( const QString& modName,
  69                                          const int actionId );
  70   bool                activateOperation( const QString& modName,
  71                                          const QString& actionId );
  72   bool                activateOperation( const QString& modName,
  73                                          const QString& actionId,
  74                                          const QString& pluginName );
  75
  76   virtual void        contextMenuPopup( const QString&, QMenu*, QString& );
  77
  78   static QString      moduleName( const QString& );
  79   static QString      moduleTitle( const QString& );
  80   static QString      moduleIcon( const QString& );
  81   static QString      moduleDescription( const QString& );
  82   static QString      moduleLibrary( const QString&,
  83                                      const bool = true );
  84   static QString      moduleDisplayer( const QString& );
  85
  86   virtual void        createEmptyStudy();
  87
  88   static ModuleShortInfoList getVersionInfo();
  89
  90   static void         logUserEvent( const QString& );
  91   static void         logAction( QAction*, const QString& = QString() );
  92
  93 protected:
  94   virtual SUIT_Study* createNewStudy();
  95   virtual void        updateCommandsStatus();
  96
  97   virtual bool        checkModule( const QString& );
  98   virtual void        moduleAdded( CAM_Module* );
  99   virtual void        moduleDeactivated( CAM_Module* );
 100   virtual void        beforeCloseDoc( SUIT_Study* );
 101   virtual void        afterCloseDoc();
 102   virtual bool        activateModule( CAM_Module* = 0 );
 103
 104   virtual void        setActiveStudy( SUIT_Study* );
 105
 106   virtual bool        abortAllOperations();
 107
 108 protected:
 109   bool                appendModuleInfo( const QString& );
 110   void                removeModuleInfo( const QString& );
 111
 112 private:
 113   enum { stInvalid = -1, stUnknown = 0, stNoGui, stInaccessible, stReady };
 114   struct ModuleInfo
 115   {
 116     QString name, title, icon, library, version, description, displayer;
 117     int status;
 118     ModuleInfo() : status( stInvalid ) {}
 119   };
 120   void                readModuleList();
 121
 122 private:
 123   typedef QList<ModuleInfo> ModuleInfoList;
 124   static ModuleInfoList myInfoList;      //!< modules info list
 125   CAM_Module*           myModule;        //!< active module
 126   ModuleList            myModules;       //!< loaded modules list
 127   bool                  myAutoLoad;      //!< auto loading flag
 128   bool                  myBlocked;       //!< "blocked" flag, internal usage
 129 };
 130
 131 #ifdef WIN32
 132 #pragma warning( default:4251 )
 133 #endif
 134
 135 #endif