src/SalomeApp/SalomeApp_Module.h

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