Salome HOME
Updated copyright comment
[modules/gui.git] / src / SalomeApp / SalomeApp_Module.h
index 7ac60246213037c116f0bc6601f8ba9eff094085..23e202ca278289cd6e7731666ece6b1bb9afb025 100644 (file)
@@ -1,40 +1,47 @@
+// Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
+//
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
 // File:      SalomeApp_Module.h
 // Created:   10/25/2004 11:33:06 AM
 // Author:    Sergey LITONIN
-// Copyright (C) CEA 2004
 
 #ifndef SALOMEAPP_MODULE_H
 #define SALOMEAPP_MODULE_H
 
 #include "SalomeApp.h"
-#include "SalomeApp_Selection.h"
-
-#include <CAM_Module.h>
-
-#include <string>
-
-class QDockWindow;
-
-class CAM_Study;
-
-class QtxPopupMgr;
 
-class SUIT_Operation;
-class SUIT_Convertor;
-class SUIT_ViewModel;
-class SUIT_DataObject;
+#include <LightApp_Module.h>
 
-class SalomeApp_DataModel;
+class CAM_DataModel;
 class SalomeApp_Application;
-class SalomeApp_Preferences;
-class SalomeApp_SelectionManager;
-
-/*
-  Class : SalomeApp_Module
-  Description : Base class for all salome modules
-*/
+class LightApp_Selection;
+class SALOME_ListIO;
+class QString;
+class SUIT_DataObject;
 
-class SALOMEAPP_EXPORT SalomeApp_Module : public CAM_Module
+/*!
+ * \brief Base class for all salome modules
+ */
+class SALOMEAPPIMPL_EXPORT SalomeApp_Module : public LightApp_Module
 {
   Q_OBJECT
 
@@ -42,60 +49,24 @@ public:
   SalomeApp_Module( const QString& );
   virtual ~SalomeApp_Module();
 
-  virtual void                        initialize( CAM_Application* );
-  virtual void                        windows( QMap<int, int>& ) const;
-  virtual void                        viewManagers( QStringList& ) const;
-
-  // engineIOR() should be a pure virtual method, to avoid logical errors!
-  //
-  // Implementation in derived classes can return the following values:
-  // "" (empty string)   - means that this is a light module, default engine should be used for interaction with SALOMEDS persistence
-  // "-1"                - means that this is a light module, SALOMEDS persistence is not used at all
-  // module`s engine IOR - means that this is a standard SALOME module with a CORBA engine
-  //
+  /*! engineIOR() should be a pure virtual method, to avoid logical errors!\n
+   * Implementation in derived classes can return the following values:\n
+   * module`s engine IOR - means that this is a standard SALOME module with a CORBA engine
+   * \li "" (empty string)   - means that this not correct SALOME module
+   */
   virtual QString                     engineIOR() const = 0;
-
-  virtual void                        contextMenuPopup( const QString&, QPopupMenu*, QString& );
-
-  virtual void                        createPreferences();
-
-  // Convenient shortcuts
-  SalomeApp_Application*              getApp() const;
   
-  void                                updateObjBrowser( bool = true, SUIT_DataObject* = 0 );
-
-  virtual void                        selectionChanged();
-  virtual void                        preferencesChanged( const QString&, const QString& );
-
-  virtual void                        studyActivated() {};
-
-public slots:
-  virtual bool                        activateModule( SUIT_Study* );
-  virtual bool                        deactivateModule( SUIT_Study* );
-
-  void                                MenuItem();
+  /*! Convenient shortcuts*/
 
-protected slots:
-  virtual void                        onModelSaved();
-  virtual void                        onModelOpened();
-  virtual void                        onModelClosed();
+  SalomeApp_Application*              getApp() const;
 
+  virtual void                        storeVisualParameters(int savePoint);
+  virtual void                        restoreVisualParameters(int savePoint);
+  virtual LightApp_Selection*         createSelection() const;
+  
 protected:
-  QtxPopupMgr*                        popupMgr();
-  SalomeApp_Preferences*              preferences() const;
-
   virtual CAM_DataModel*              createDataModel();
-  virtual SalomeApp_Selection*        createSelection() const;
-
-  int                                 addPreference( const QString& label );
-  int                                 addPreference( const QString& label, const int pId, const int = -1,
-                                                    const QString& section = QString::null,
-                                                    const QString& param = QString::null );
-  QVariant                            preferenceProperty( const int, const QString& ) const;
-  void                                setPreferenceProperty( const int, const QString&, const QVariant& );
-
-private:
-  QtxPopupMgr*                        myPopupMgr;
+  virtual void                        extractContainers( const SALOME_ListIO&, SALOME_ListIO& ) const;
 };
 
 #endif