Salome HOME
updated copyright message
[modules/shaper.git] / src / XGUI / XGUI_ModuleConnector.h
index b86c0ef8ba2277515b1536837e83ce0e74421613..5db513bf334679cf13abc62596094839d633a728 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        XGUI_ModuleConnector.h
-// Created:     3 June 2014
-// Author:      Vitaly Smetannikov
+// Copyright (C) 2014-2023  CEA/DEN, EDF R&D
+//
+// 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
+//
 
 #ifndef XGUI_ModuleConnector_H
 #define XGUI_ModuleConnector_H
@@ -31,16 +44,6 @@ Q_OBJECT
   //! Returns list of currently selected data objects
   virtual ModuleBase_ISelection* selection() const;
 
-  /// Activate sub-shapes selection (opens local context if it was not opened)
-  /// Types has to be dined according to TopAbs_ShapeEnum
-  virtual void activateSubShapesSelection(const QIntList& theTypes);
-
-  /// Activate objects in the module selection modes(opens local context)
-  virtual void activateModuleSelectionModes();
-
-  /// Deactivate sub-shapes selection (closes local context)
-  virtual void deactivateSubShapesSelection();
-
   //! Returns instance of loaded module
   virtual ModuleBase_IModule* module() const;
 
@@ -50,11 +53,19 @@ Q_OBJECT
   //! Returns property panel
   virtual ModuleBase_IPropertyPanel* propertyPanel() const;
 
+  //! Returns error manager
+  virtual ModuleBase_IErrorMgr* errorMgr() const;
+
+  /// A selection activate in 3D View handler
+  virtual ModuleBase_ISelectionActivate* selectionActivate() const;
+
   //! Returns currently active operation
   virtual ModuleBase_Operation* currentOperation() const;
 
   //! Returns true if the operation with id theId can be started
-  virtual bool canStartOperation(QString theId);
+  /// \param theId id of the operation which is going to start
+  /// \param isCommitted boolean value if the operation was committed otherwise it was aborted
+  virtual bool canStartOperation(QString theId, bool& isCommitted);
 
   //! Performs the operation launch
   //! \param theOperation an operation to be launched
@@ -72,7 +83,9 @@ Q_OBJECT
 
   //! Commits if possible or aborts the given operation.
   //! \param theOperation an aborted operation
-  virtual void stopOperation(ModuleBase_Operation* theOperation);
+  /// \param isCommitted boolean value if the operation was committed otherwise it was aborted
+  virtual void stopOperation(ModuleBase_Operation* theOperation,
+                             bool& isCommitted);
 
   //! Returns AIS object by data object
   virtual AISObjectPtr findPresentation(const ObjectPtr& theObject) const;
@@ -80,6 +93,13 @@ Q_OBJECT
   //! Returns data object by AIS
   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
 
+  //! Returns true if the object is displayed
+  //! \param theObject a data object
+  virtual bool isVisible(const ObjectPtr& theObject) const;
+
+  //! Returns list of currently displayed objects
+  virtual QObjectPtrList displayedObjects() const;
+
   //! Select features clearing previous selection.
   //! If the list is empty then selection will be cleared
   virtual void setSelected(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
@@ -98,10 +118,36 @@ Q_OBJECT
   /// Return application main window
   virtual QMainWindow* desktop() const;
 
+  /// Returns true if SHIFT is pressed
+  /// \return boolean value
+  virtual bool hasSHIFTPressed() const;
+
+  virtual void deactivateCurrentSelector();
+
+  //! Temporary enable or disable viewer update. Returns previous state of updating
+  //! \param isEnabled new state of the viewer update
+  virtual bool enableUpdateViewer(bool isEnabled);
 
   //! Returns workshop
   XGUI_Workshop* workshop() const { return myWorkshop; }
 
+  //! The methods applys current defined selection modes to given AIS presentation.
+  //! The AIS presentation has to be already displayed. After activation viewer has to be updated
+  //! \param theAIS the object which has to be activated
+  virtual void applyCurrentSelectionModes(const AISObjectPtr& theAIS);
+
+  //! Undo last command
+  virtual void undo();
+
+  //! Set enabled state of cancel button in property panel
+  virtual void setCancelEnabled(bool toEnable);
+
+  //! Returns current state of cancel button
+  virtual bool isCancelEnabled() const;
+
+  //! Show help of a current operation
+  virtual void showHelpPage(const QString& thePage) const;
+
 private:
   QObjectPtrList activeObjects(const QObjectPtrList& theObjList) const;