src/SHAPERGUI/SHAPERGUI.h

   1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
   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 #ifndef SHAPERGUI_H
  21 #define SHAPERGUI_H
  22
  23 #include "SHAPER_SHAPERGUI.h"
  24 #include "SHAPERGUI_SalomeViewer.h"
  25
  26 #include <LightApp_Module.h>
  27 #include <XGUI_SalomeConnector.h>
  28
  29 #include <ModuleBase_ActionInfo.h>
  30
  31 #include <QList>
  32 #include <QMap>
  33
  34 class XGUI_Workshop;
  35 class SHAPERGUI_OCCSelector;
  36 class OCCViewer_Viewer;
  37 class CAM_Study;
  38
  39 /**
  40  * \ingroup Salome
  41  * An implementation of SALOME connector class for implementation of
  42  * XGUI functionality as a module of SALOME
  43  */
  44 class SHAPERGUI_EXPORT SHAPERGUI : public LightApp_Module, public XGUI_SalomeConnector
  45 {
  46 Q_OBJECT
  47  public:
  48   SHAPERGUI();
  49   virtual ~SHAPERGUI();
  50
  51   //----- LightAPP_Module interface ---------------
  52
  53   /// \brief Initializing of the module
  54   /// \param theApp application instance
  55   virtual void initialize(CAM_Application* theApp);
  56
  57   /// \brief Definition of module standard windows
  58   virtual void windows(QMap<int, int>& theWndMap) const;
  59
  60   /// \brief Definition of module viewer
  61   virtual void viewManagers(QStringList& theList) const;
  62
  63   /// \brief The method is called on selection changed event
  64   virtual void selectionChanged();
  65
  66   //--- XGUI connector interface -----
  67
  68   virtual QAction* addFeature(const QString& theWBName, const QString& theTBName,
  69                               const QString& theId, const QString& theTitle,
  70                               const QString& theTip, const QIcon& theIcon,
  71                               const QKeySequence& theKeys/* = QKeySequence()*/,
  72                               bool isCheckable /*= false*/, const bool isAddSeparator/* = false*/,
  73                               const QString& theStatusTip);
  74
  75   //! Add feature (QAction) in the \a theWBName toolbar with given \a theInfo about action
  76   virtual QAction* addFeature(const QString& theWBName,
  77                               const ActionInfo& theInfo, const bool isAddSeparator);
  78
  79   /// Add a nested feature
  80   /// \param theWBName a workbench name
  81   /// \param theInfo the action  parameters
  82   /// \param theNestedActions a list of nested actions
  83   virtual QAction* addFeatureOfNested(const QString& theWBName,
  84                                     const ActionInfo& theInfo,
  85                                     const QList<QAction*>& theNestedActions);
  86
  87   //! Returns true if the feature action is a nested action, in other words,
  88   //! it is created by addNestedFeature().
  89   //! \param theAction - an action of a feature
  90   //! returns boolean result
  91   virtual bool isFeatureOfNested(const QAction* theAction);
  92
  93   virtual QAction* addDesktopCommand(const QString& theId, const QString& theTitle,
  94                                      const QString& theTip, const QIcon& theIcon,
  95                                      const QKeySequence& theKeys, bool isCheckable,
  96                                      const char* theMenuSourceText,
  97                                      const int theMenuPosition = 10);
  98
  99   virtual void addDesktopMenuSeparator(const char* theMenuSourceText,
 100                                        const int theMenuPosition = 10);
 101
 102   /// Add an action to a tool bar
 103   /// \param theAction an ation to add
 104   /// \param theToolBarTitle a name of tool bar
 105   virtual bool addActionInToolbar( QAction* theAction, const QString& theToolBarTitle );
 106
 107   /// Creates menu/tool bar actions for loaded features stored in the menu manager
 108   virtual void createFeatureActions();
 109
 110   virtual QMainWindow* desktop() const;
 111
 112   //! Stores XML information for the feature kind
 113   //! \param theFeatureId a feature kind
 114   //! \param theMessage a container of the feature XML properties
 115   virtual void setFeatureInfo(const QString& theFeatureId,
 116                               const std::shared_ptr<Config_FeatureMessage>& theMessage);
 117
 118   //! Returns XML information for the feature kind
 119   //! \param theFeatureId a feature kind
 120   //! \return theMessage a container of the feature XML properties
 121   virtual std::shared_ptr<Config_FeatureMessage> featureInfo(const QString& theFeatureId);
 122
 123   //! Returns interface to Salome viewer
 124   virtual ModuleBase_IViewer* viewer() const
 125   {
 126     return myProxyViewer;
 127   }
 128
 129   //! Returns list of defined actions (just by SHAPER module)
 130   virtual QList<QAction*> commandList() const;
 131
 132   /// Redefinition of virtual function.
 133   /// \param theClient name of pop-up client
 134   /// \param theMenu popup menu instance
 135   /// \param theTitle menu title.
 136   virtual void contextMenuPopup(const QString& theClient, QMenu* theMenu, QString& theTitle);
 137
 138   /// Redefinition of virtual function for preferences creation.
 139   virtual void createPreferences();
 140
 141   /// Redefinition of virtual function for preferences changed event.
 142   virtual void preferencesChanged(const QString& theSection, const QString& theParam);
 143
 144   //! Shows the given text in status bar as a permanent text
 145   //! \theInfo a string value
 146   //! \theMsecs interval of msec milliseconds when the message will be hidden, if -1, it stays.
 147   //            If 0, default value is used, it is 3000
 148   virtual void putInfo(const QString& theInfo, const int theMSecs = 0);
 149
 150   /// \return Workshop class instance
 151   XGUI_Workshop* workshop() const { return myWorkshop; }
 152
 153   /// \brief Set flag about opened document state
 154   void setIsOpened(bool theOpened) { myIsOpened = theOpened; }
 155
 156   virtual void updateModuleVisibilityState();
 157
 158   /// Returns list of the module commands
 159   QIntList shaperActions() const { return myActionsList; }
 160
 161   /// Returns structure of tool bars
 162   QMap<QString, QIntList> shaperToolbars() const { return myToolbars; }
 163
 164   /// Returns free commands which are not in toolbars in the module
 165   QIntList getFreeCommands() const;
 166
 167   /// Returns structure of default tool bars
 168   QMap<QString, QIntList> defaultToolbars() const
 169   { return (myDefaultToolbars.size() == 0)? myToolbars : myDefaultToolbars; }
 170
 171   void resetToolbars();
 172
 173  public slots:
 174   /// \brief The method is redefined to connect to the study viewer before the data
 175   /// model is filled by opened file. This file open will flush redisplay signals for,
 176   /// objects which should be visualized
 177   //virtual void connectToStudy(CAM_Study* theStudy);
 178
 179    /// \brief The method is called on the module activation
 180    /// \param theStudy current study
 181   virtual bool activateModule(SUIT_Study* theStudy);
 182
 183    /// \brief The method is called on the module activation
 184    /// \param theStudy current study
 185   virtual bool deactivateModule(SUIT_Study* theStudy);
 186
 187  protected slots:
 188    /// Redefinition of virtual function
 189    /// \param theMgr view manager
 190   virtual void onViewManagerAdded(SUIT_ViewManager* theMgr);
 191
 192    /// Redefinition of virtual function
 193    /// \param theMgr view manager
 194   virtual void onViewManagerRemoved(SUIT_ViewManager* theMgr);
 195
 196   /// Set preferences to default
 197   void onDefaultPreferences();
 198
 199   /// Hide object browser if it was created during loading script
 200   void onScriptLoaded();
 201
 202   /// Save application functionality with additional processing of aborting the current operation
 203   void onSaveDocByShaper();
 204
 205   /// Save application functionality with additional processing of aborting the current operation
 206   void onSaveAsDocByShaper();
 207
 208   /// Obtains the current application and updates its actions
 209   void onUpdateCommandStatus();
 210
 211  protected:
 212    /// Create data model
 213   CAM_DataModel* createDataModel();
 214
 215   /// Create popup menu manager
 216   virtual QtxPopupMgr* popupMgr();
 217
 218   /// Abort all operations
 219   virtual bool abortAllOperations();
 220
 221 private slots:
 222   void onWhatIs(bool isToggled);
 223
 224   void onEditToolbars();
 225
 226  private:
 227    /// Create selector for OCC Viewer
 228    /// \param theMgr view manager
 229   SHAPERGUI_OCCSelector* createSelector(SUIT_ViewManager* theMgr);
 230
 231   void registerCommandToolbar(const QString& theToolName, int theCommandId);
 232
 233   int getNextCommandId() const;
 234
 235   // Update current toolbars
 236   void updateToolbars(const QMap<QString, QIntList>& theNewToolbars);
 237
 238   void saveToolbarsConfig();
 239   void loadToolbarsConfig();
 240
 241   /// List of registered nested actions
 242   QStringList myNestedActionsList;
 243
 244   /// Reference to workshop
 245   XGUI_Workshop* myWorkshop;
 246
 247   /// OCC viewer selector instance
 248   SHAPERGUI_OCCSelector* mySelector;
 249
 250   /// Proxy viewer for connection to OCC Viewer in SALOME
 251   SHAPERGUI_SalomeViewer* myProxyViewer;
 252
 253   /// Map of feature kind to a container of XML properties for the feature
 254   QMap<QString, std::shared_ptr<Config_FeatureMessage> > myFeaturesInfo;
 255
 256   /// Flag of opened document state
 257   bool myIsOpened;
 258
 259   // the next parameters should be restored after this module deactivation
 260
 261   /// The application value of the preferences parameter
 262   bool myIsStorePositions;
 263
 264   /// The application value
 265   bool myIsEditEnabled;
 266
 267   /// Popup manager
 268   QtxPopupMgr* myPopupMgr;
 269
 270   QAction* myWhatIsAction;
 271
 272   bool myIsInspectionVisible;
 273   QDockWidget* myInspectionPanel;
 274
 275   /// List of registered actions
 276   QIntList myActionsList;
 277   QMap<QString, QIntList> myToolbars;
 278   QMap<QString, QIntList> myDefaultToolbars;
 279   bool myIsToolbarsModified;
 280 };
 281
 282 #endif