src/SALOME_PYQT/SALOME_PYQT_GUILight/SALOME_PYQT_ModuleLight.h

   1 // Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 // File   : SALOME_PYQT_ModuleLight.h
  21 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
  22
  23 #ifndef SALOME_PYQT_MODULELIGHT_H
  24 #define SALOME_PYQT_MODULELIGHT_H
  25
  26 #include "SALOME_PYQT_GUILight.h"
  27
  28 #include "PyInterp_Interp.h" // !!! WARNING !!! THIS INCLUDE MUST BE THE VERY FIRST !!!
  29 #include "LightApp_Module.h"
  30
  31 #include <QIcon>
  32 #include <QMap>
  33 #include <QStringList>
  34
  35 class QMenu;
  36 class PyModuleHelper;
  37 class SALOME_PYQT_Selector;
  38 class SALOME_PYQT_DataObjectLight;
  39
  40 class SALOME_PYQT_LIGHT_EXPORT SALOME_PYQT_ModuleLight: public LightApp_Module
  41 {
  42   Q_OBJECT
  43
  44 public:
  45   SALOME_PYQT_ModuleLight();
  46   ~SALOME_PYQT_ModuleLight();
  47
  48 public:
  49   // module activation, preferences, menus
  50   void            initialize( CAM_Application* );
  51   bool            activateModule( SUIT_Study* );
  52   bool            deactivateModule( SUIT_Study* );
  53   void            onModelClosed();
  54   void            windows( QMap<int, int>& ) const;
  55   void            viewManagers( QStringList& ) const;
  56   void            studyActivated();
  57   void            contextMenuPopup( const QString&, QMenu*, QString& );
  58   void            createPreferences();
  59   void            preferencesChanged( const QString&, const QString& );
  60
  61   // persistence & dump python
  62   void            save( QStringList&, const QString& );
  63   bool            load( const QStringList&, const QString& );
  64   void            dumpPython( QStringList& );
  65
  66   // drag-n-drop support
  67   bool            isDraggable( const SUIT_DataObject* ) const;
  68   bool            isDropAccepted( const SUIT_DataObject* ) const;
  69   void            dropObjects( const DataObjectList&, SUIT_DataObject*,
  70                                const int, Qt::DropAction );
  71
  72   // data model management
  73   QString         createObject( const QString& );
  74   QString         createObject( const QString&,
  75                                 const QString&,
  76                                 const QString&,
  77                                 const QString& );
  78
  79   void            setName( const QString&, const QString& );
  80   QString         getName( const QString& ) const;
  81
  82   void            setIcon( const QString&, const QString& );
  83
  84   void            setToolTip( const QString&, const QString& );
  85   QString         getToolTip( const QString& ) const;
  86
  87   void            setColor( const QString&, const QColor& );
  88   QColor          getColor( const QString& ) const;
  89
  90   void            setReference( const QString&, const QString& );
  91   QString         getReference( const QString& ) const;
  92
  93   void            removeObject( const QString& );
  94   void            removeChildren( const QString& );
  95
  96   void            setObjectPosition( const QString&, int );
  97   int             getObjectPosition( const QString& );
  98
  99   QStringList     getChildren( const QString&, const bool = false ) const;
 100
 101   void             enableSelector();
 102   void             disableSelector();
 103   void             setLocalSelected(const QStringList &);
 104   void             getSelected( DataObjectList& ) const;
 105 //  unsigned long    getModifiedTime() const;
 106 //  SUIT_DataObject* root() const;
 107   void             setSelected( const QStringList&, const bool = false );
 108
 109 protected:
 110   CAM_DataModel*  createDataModel();
 111
 112 private:
 113   SALOME_PYQT_DataObjectLight*
 114                   findObject( const QString& ) const;
 115
 116 signals:
 117   void            selectionChanged();
 118   void            localSelectionChanged();
 119
 120 private:
 121   PyModuleHelper* myHelper;
 122   SALOME_PYQT_Selector* mySelector;
 123 };
 124
 125 #endif // SALOME_PYQT_MODULELIGHT_H