src/SalomeApp/SalomeApp_Module.h

   1 // File:      SalomeApp_Module.h
   2 // Created:   10/25/2004 11:33:06 AM
   3 // Author:    Sergey LITONIN
   4 // Copyright (C) CEA 2004
   5
   6 #ifndef SALOMEAPP_MODULE_H
   7 #define SALOMEAPP_MODULE_H
   8
   9 #include "SalomeApp.h"
  10 #include "SalomeApp_Selection.h"
  11
  12 #include <CAM_Module.h>
  13
  14 #include <string>
  15
  16 class QDockWindow;
  17
  18 class CAM_Study;
  19
  20 class QtxPopupMgr;
  21
  22 class SUIT_Operation;
  23 class SUIT_Convertor;
  24 class SUIT_ViewModel;
  25 class SUIT_DataObject;
  26
  27 class SalomeApp_DataModel;
  28 class SalomeApp_Application;
  29 class SalomeApp_Preferences;
  30 class SalomeApp_SelectionManager;
  31
  32 /*
  33   Class : SalomeApp_Module
  34   Description : Base class for all salome modules
  35 */
  36
  37 class SALOMEAPP_EXPORT SalomeApp_Module : public CAM_Module
  38 {
  39   Q_OBJECT
  40
  41 public:
  42   SalomeApp_Module( const QString& );
  43   virtual ~SalomeApp_Module();
  44
  45   virtual void                        initialize( CAM_Application* );
  46   virtual void                        windows( QMap<int, int>& ) const;
  47   virtual void                        viewManagers( QStringList& ) const;
  48
  49   // engineIOR() should be a pure virtual method, to avoid logical errors!
  50   //
  51   // Implementation in derived classes can return the following values:
  52   // "" (empty string)   - means that this is a light module, default engine should be used for interaction with SALOMEDS persistence
  53   // "-1"                - means that this is a light module, SALOMEDS persistence is not used at all
  54   // module`s engine IOR - means that this is a standard SALOME module with a CORBA engine
  55   //
  56   virtual QString                     engineIOR() const = 0;
  57
  58   virtual void                        contextMenuPopup( const QString&, QPopupMenu*, QString& );
  59
  60   virtual void                        createPreferences();
  61
  62   // Convenient shortcuts
  63   SalomeApp_Application*              getApp() const;
  64
  65   void                                updateObjBrowser( bool = true, SUIT_DataObject* = 0 );
  66
  67   virtual void                        selectionChanged();
  68   virtual void                        preferencesChanged( const QString&, const QString& );
  69
  70 public slots:
  71   virtual bool                        activateModule( SUIT_Study* );
  72   virtual bool                        deactivateModule( SUIT_Study* );
  73
  74   void                                MenuItem();
  75
  76 protected slots:
  77   virtual void                        onModelSaved();
  78   virtual void                        onModelOpened();
  79   virtual void                        onModelClosed();
  80
  81 protected:
  82   QtxPopupMgr*                        popupMgr();
  83   SalomeApp_Preferences*              preferences() const;
  84
  85   virtual CAM_DataModel*              createDataModel();
  86   virtual SalomeApp_Selection*        createSelection() const;
  87
  88   int                                 addPreference( const QString& label );
  89   int                                 addPreference( const QString& label, const int pId, const int = -1,
  90                                                      const QString& section = QString::null,
  91                                                      const QString& param = QString::null );
  92   QVariant                            preferenceProperty( const int, const QString& ) const;
  93   void                                setPreferenceProperty( const int, const QString&, const QVariant& );
  94
  95 private:
  96   QtxPopupMgr*                        myPopupMgr;
  97 };
  98
  99 #endif