src/SalomeApp/SalomeApp_Module.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 // File:      SalomeApp_Module.h
  24 // Created:   10/25/2004 11:33:06 AM
  25 // Author:    Sergey LITONIN
  26
  27 #ifndef SALOMEAPP_MODULE_H
  28 #define SALOMEAPP_MODULE_H
  29
  30 #include "SalomeApp.h"
  31
  32 #include <LightApp_Module.h>
  33
  34 class CAM_DataModel;
  35 class SalomeApp_Application;
  36 class LightApp_Selection;
  37 class SALOME_ListIO;
  38 class QString;
  39 class SUIT_DataObject;
  40
  41 /*!
  42  * \brief Base class for all salome modules
  43  */
  44 class SALOMEAPPIMPL_EXPORT SalomeApp_Module : public LightApp_Module
  45 {
  46   Q_OBJECT
  47
  48 public:
  49   SalomeApp_Module( const QString& );
  50   virtual ~SalomeApp_Module();
  51
  52   /*! engineIOR() should be a pure virtual method, to avoid logical errors!\n
  53    * Implementation in derived classes can return the following values:\n
  54    * module`s engine IOR - means that this is a standard SALOME module with a CORBA engine
  55    * \li "" (empty string)   - means that this not correct SALOME module
  56    */
  57   virtual QString                     engineIOR() const = 0;
  58
  59   /*! Convenient shortcuts*/
  60
  61   SalomeApp_Application*              getApp() const;
  62
  63   virtual void                        storeVisualParameters(int savePoint);
  64   virtual void                        restoreVisualParameters(int savePoint);
  65   virtual LightApp_Selection*         createSelection() const;
  66
  67 protected:
  68   virtual CAM_DataModel*              createDataModel();
  69   virtual void                        extractContainers( const SALOME_ListIO&, SALOME_ListIO& ) const;
  70 };
  71
  72 #endif