1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File: SalomeApp_Module.h
24 // Created: 10/25/2004 11:33:06 AM
25 // Author: Sergey LITONIN
27 #ifndef SALOMEAPP_MODULE_H
28 #define SALOMEAPP_MODULE_H
30 #include "SalomeApp.h"
32 #include <LightApp_Module.h>
35 class SalomeApp_Application;
36 class LightApp_Selection;
39 class SUIT_DataObject;
42 * \brief Base class for all salome modules
44 class SALOMEAPP_EXPORT SalomeApp_Module : public LightApp_Module
49 SalomeApp_Module( const QString& );
50 virtual ~SalomeApp_Module();
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
57 virtual QString engineIOR() const = 0;
59 /*! Convenient shortcuts*/
61 SalomeApp_Application* getApp() const;
63 virtual void storeVisualParameters(int savePoint);
64 virtual void restoreVisualParameters(int savePoint);
65 virtual LightApp_Selection* createSelection() const;
68 virtual bool activateModule( SUIT_Study* );
69 virtual void studyClosed( SUIT_Study* );
70 virtual void onObjectClicked( SUIT_DataObject*, int );
72 virtual void updateModuleVisibilityState();
75 virtual CAM_DataModel* createDataModel();
76 virtual void extractContainers( const SALOME_ListIO&, SALOME_ListIO& ) const;
80 bool myIsFirstActivate;