Salome HOME
Issue #1015: The validate icon must be greyed and inactive instead of red and active
[modules/shaper.git] / src / XGUI / XGUI_Workshop.h
old mode 100644 (file)
new mode 100755 (executable)
index baeff44..835816c
@@ -5,7 +5,6 @@
 
 #include "XGUI.h"
 //#include "XGUI_Constants.h"
-#include <Events_Listener.h>
 #include <ModuleBase_Definitions.h>
 #include <ModelAPI_Document.h>
 #include <ModelAPI_Feature.h>
 #include <QKeySequence>
 #include <QIcon>
 
+#ifndef HAVE_SALOME
 class AppElements_MainWindow;
 class AppElements_Command;
 class AppElements_Workbench;
+#endif
 
-class XGUI_SelectionMgr;
+class XGUI_ActionsMgr;
+class XGUI_ContextMenuMgr;
 class XGUI_Displayer;
+class XGUI_ErrorDialog;
+class XGUI_ErrorMgr;
+class XGUI_MenuMgr;
+class XGUI_ModuleConnector;
+class XGUI_ObjectsBrowser;
 class XGUI_OperationMgr;
+class XGUI_PropertyPanel;
 class XGUI_SalomeConnector;
-class XGUI_ObjectsBrowser;
-class XGUI_ActionsMgr;
-class XGUI_ErrorDialog;
 class XGUI_SalomeViewer;
+class XGUI_SelectionMgr;
 class XGUI_ViewerProxy;
-class XGUI_PropertyPanel;
-class XGUI_ContextMenuMgr;
-class XGUI_ModuleConnector;
+class XGUI_WorkshopListener;
 
-class ModuleBase_Operation;
 class ModuleBase_IModule;
 class ModuleBase_IViewer;
-
-class Config_FeatureMessage;
-class Config_PointerMessage;
+class ModuleBase_Operation;
 
 class QWidget;
 class QDockWidget;
 class QMainWindow;
 
-class ModelAPI_ObjectUpdatedMessage;
-class ModelAPI_ObjectDeletedMessage;
-class ModelAPI_ResultPart;
 class QAction;
+class Config_DataModelReader;
 
 /**\class XGUI_Workshop
  * \ingroup GUI
  * \brief Class which defines a configuration of the application (Workshop) and launches it.
  */
-class XGUI_EXPORT XGUI_Workshop : public QObject, public Events_Listener
+class XGUI_EXPORT XGUI_Workshop : public QObject
 {
 Q_OBJECT
  public:
@@ -67,12 +66,23 @@ Q_OBJECT
   //! Starting of the application
   void startApplication();
 
+  /// Activates the module controls. Should be called after module creation
+  void activateModule();
+
+  /// Deactivates the module controls. Should be called after module creation
+  void deactivateModule();
+
+#ifndef HAVE_SALOME
   //! Returns main window (Desktop) of the application
   AppElements_MainWindow* mainWindow() const
   {
     return myMainWindow;
   }
 
+  //! Creates and adds a new workbench (menu group) with the given name and returns it
+  AppElements_Workbench* addWorkbench(const QString& theName);
+#endif
+
   //! Returns selection manager object
   XGUI_SelectionMgr* selector() const
   {
@@ -91,12 +101,24 @@ Q_OBJECT
     return myOperationMgr;
   }
 
+  //! ! Returns error manager.
+  XGUI_ErrorMgr* errorMgr() const
+  {
+    return myErrorMgr;
+  }
+
   //! ! Returns an actions manager
   XGUI_ActionsMgr* actionsMgr() const
   {
     return myActionsMgr;
   }
 
+  //! ! Returns an actions manager
+  XGUI_MenuMgr* menuMgr() const
+  {
+    return myMenuMgr;
+  }
+
   //! Returns property panel widget
   XGUI_PropertyPanel* propertyPanel() const
   {
@@ -109,12 +131,6 @@ Q_OBJECT
     return myContextMenuMgr;
   }
 
-  //! Creates and adds a new workbench (menu group) with the given name and returns it
-  AppElements_Workbench* addWorkbench(const QString& theName);
-
-  //! Redefinition of Events_Listener method
-  virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
-
   //! Returns an object which provides interface to Salome Module (LightApp_Module)
   XGUI_SalomeConnector* salomeConnector() const
   {
@@ -145,7 +161,7 @@ Q_OBJECT
     return myViewerProxy;
   }
 
-  /// Returns the module connectory
+  /// Returns the module connector
   /// \returns the instance of connector
   XGUI_ModuleConnector* moduleConnector() const
   {
@@ -156,15 +172,25 @@ Q_OBJECT
   /// \return a desktop instance
   QMainWindow* desktop() const;
 
-  //! Returns icon name according to feature
-  static QIcon featureIcon(const FeaturePtr& theFeature);
+  //! Delete features
+  void deleteObjects();
+
+  //! Searches for selected features unused in other (not selected) features. If one or several
+  //! selected features are found, a warning message proposes to delete them. It contains 
+  //! the list of features to be deleted.
+  void cleanHistory();
 
-  //! Activates or deactivates a part
-  //! If PartPtr is Null pointer then PartSet will be activated
-  void activatePart(std::shared_ptr<ModelAPI_ResultPart> theFeature);
+  //! Returns true if the selected feature can be moved to the position after the current feature
+  //! \return boolean value
+  bool canMoveFeature();
 
-  //! Delete features
-  void deleteObjects(const QObjectPtrList& theList);
+  //! Move selected features to be after the current feature
+  void moveObjects();
+
+  //! Returns true if the object can be shaded. If the object is a compsolid result, the method
+  //! checks subobjects of the result
+  //! \return boolean value
+  bool canBeShaded(const ObjectPtr& theObject) const;
 
   //! Returns true if there is at least one selected body/construction/group result
   //! \return boolean value
@@ -181,21 +207,28 @@ Q_OBJECT
   //! Show the given features in 3d Viewer
   void showOnlyObjects(const QObjectPtrList& theList);
 
-  /// Set display mode for the given onjects
+  /// Set display mode for the given objects
   /// \param theList a list of displayed objects
   /// \param theMode a mode to set (see \ref XGUI_Displayer)
   void setDisplayMode(const QObjectPtrList& theList, int theMode);
 
+  /// Set selection mode in viewer. If theMode=-1 then activate default mode
+  /// \param theMode the selection mode (according to TopAbs_ShapeEnum)
+  void setViewerSelectionMode(int theMode);
+
+  /// Activates current selection mode for the given list of objects
+  void activateObjectsSelection(const QObjectPtrList& theList);
+
   /// Returns current module
   ModuleBase_IModule* module() const
   {
     return myModule;
   }
 
-  /// Returns current directory whic contains data files
+  /// Returns current directory which contains data files
   QString currentDataDir() const { return myCurrentDir; }
 
-  /// Returns current directory whic contains data files
+  /// Returns current directory which contains data files
   void setCurrentDataDir(const QString& theDir) { myCurrentDir = theDir; }
 
   /**
@@ -206,18 +239,74 @@ Q_OBJECT
   void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
 
   /**
-   * If there is an active (uncommited) operation shows a prompt to abort it
+   * If there is an active (uncommitted) operation shows a prompt to abort it
    * and performs abortion if user agreed. Returns true if
    * - operation aborted successfully
    * - there is no active operation
    */
-  bool isActiveOperationAborted();
+  bool abortAllOperations();
+
+  //! Delete features. Delete the referenced features. There can be a question with a list of
+  //! referenced objects.
+  //! \param theFeatures a list of objects to be deleted
+  bool deleteFeatures(const QObjectPtrList& theFeatures);
+
+  /// Deactivates the object, if it is active and the module returns that the activation
+  /// of selection for the object is not possible currently(the current operation uses it)
+  /// \param theObject an object
+  /// \param theUpdateViewer a boolean flag to update viewer immediately
+  void deactivateActiveObject(const ObjectPtr& theObject, const bool theUpdateViewer);
+
+  /// Returns true if the action of the feature is created to contain Accept/Cancel button
+  /// \param theFeature a feature
+  bool isFeatureOfNested(const FeaturePtr& theFeature);
+
+  //! Shows the message in the status bar
+  //! \param theMessage a message
+  void setStatusBarMessage(const QString& theMessage);
+
+  /// Has to be called in order to display objects with visibility status = true
+  void synchronizeViewer();
+
+  /// Has to be called in order to display objects from a cpecifed group with visibility status = true
+  /// \param theDoc the document for objects synchronisation
+  /// \param theGroup the group name
+  /// \param theUpdateViewer update viewer flag
+  void synchronizeGroupInViewer(const DocumentPtr& theDoc, const std::string& theGroup, bool theUpdateViewer);
+
+  /// Update the property panel content by the XML description of the operation and set the panel
+  /// into the operation
+  /// \param theOperation an operation
+  void setPropertyPanel(ModuleBase_Operation* theOperation);
+
+  /// Connects or disconnects to the value changed signal of the property panel widgets
+  /// \param isToConnect a boolean value whether connect or disconnect
+  void connectToPropertyPanel(const bool isToConnect);
+
+  /// Returns defailt selection mode in 3d viewer
+  QIntList viewerSelectionModes() const { return myViewerSelMode; }
+
+  /// Highlights result objects in Object Browser according to
+  /// features found in the given list
+  void highlightResults(const QObjectPtrList& theObjects);
+
+  /// Highlights feature objects in Object Browser according to
+  /// features found in the given list
+  void highlightFeature(const QObjectPtrList& theObjects);
+
+  /// Returns Data Model XML reader which contains information about 
+  /// Data structure configuration
+  const Config_DataModelReader* dataModelXMLReader() const { return myDataModelXMLReader; }
+
+  /// A constant string used for "Move to end" command definition
+  /// It is used for specific processing of Undo/Redo for this command.
+  static QString MOVE_TO_END_COMMAND;
 
 signals:
   /// Emitted when selection happens in Salome viewer
   void salomeViewerSelection();
 
-  /// Emitted when error in applivation happens
+  /// Emitted when error in application happens
   void errorOccurred(const QString&);
 
   //! the signal about the workshop actions states are updated.
@@ -228,6 +317,7 @@ signals:
 
   //! Signal to update Undo history list
   void updateUndoHistory(const QList<ActionInfo>&);
+
   //! Signal to update Redo history list
   void updateRedoHistory(const QList<ActionInfo>&);
 
@@ -238,32 +328,31 @@ signals:
   /// update history list (undo/redo commands)
   void updateHistory();
 
-  /// Create a new dokument
-  void onNew();
-
-  /// Open document from file
-  void onOpen();
-
   /// Save current document
   bool onSave();
 
   /// Save current document to a file selected by user
   bool onSaveAs();
 
-  /// Exit application
-  void onExit();
-
   /// Undo last command
   void onUndo(int times = 1);
 
   /// Redo previous command
   void onRedo(int times = 1);
 
-  /// Rebuild data tree
-  void onRebuild();
+  // Rebuild data tree
+  //void onRebuild();
 
-  /// Open preferences dialog box
-  void onPreferences();
+  /// Validates the operation to change the "Apply" button state.
+  /// \param thePreviousState the previous state of the widget
+  void onWidgetStateChanged(int thePreviousState);
+
+  /// Calls activate of the current widget again. It is possible that selection filters are
+  /// differs in the new state of paged container
+  void onValuesChanged();
+
+  /// Listens the corresponded signal of model widget and updates Apply button state by feature
+  void onWidgetObjectUpdated();
 
   /// Show property panel
   void showPropertyPanel();
@@ -277,56 +366,38 @@ signals:
   /// Hide object Browser
   void hideObjectBrowser();
 
-  /// Reaction on command call
-  void onFeatureTriggered();
-
-  /// Change active document
-  /// \param theObj a part object. If it is NULL then active document is a main document
-  void changeCurrentDocument(ObjectPtr theObj);
-
-  //void activateLastPart();
-
   /// Close document
   void closeDocument();
 
- protected:
-  /// Find the nested features and set them into the operation
-  /// \param theOperation an operation
-  void setNestedFeatures(ModuleBase_Operation* theOperation);
-
-  /// Update the property panel content by the XML description of the operation and set the panel
-  /// into the operation
-  /// \param theOperation an operation
-  void setPropertyPanel(ModuleBase_Operation* theOperation);
-
-  /// Procedure to process postponed events
-  bool event(QEvent * theEvent);
-
-  //Event-loop processing methods:
+  /// Open document from file
+  void onOpen();
 
-  /// Process event "Add a feature"
-  void addFeature(const std::shared_ptr<Config_FeatureMessage>&);
+  /// Create a new document
+  void onNew();
 
-  /// Connect to operation signals
-  /// \param theOperation an operation
-  void connectWithOperation(ModuleBase_Operation* theOperation);
+#ifndef HAVE_SALOME
+  /// Exit application
+  void onExit();
 
-  /// Process feature update message
-  void onFeatureUpdatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
+  /// Open preferences dialog box
+  void onPreferences();
+#endif
 
-  ///Process feature created message
-  void onFeatureCreatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
+  /// Activates/deactivates the trihedron in the viewer AIS context
+  void onTrihedronVisibilityChanged(bool theState);
 
-  /// Process feature redisplay message
-  void onFeatureRedisplayMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
 
-  /// Process feature delete message
-  void onObjectDeletedMsg(const std::shared_ptr<ModelAPI_ObjectDeletedMessage>& );
+ protected:
+  /// Sets the granted operations for the parameter operation. Firstly, it finds the nested features
+  /// and set them into the operation. Secondly, it asks the module about ids of granted operations.
+  /// \param theOperation an operation
+   void setGrantedFeatures(ModuleBase_Operation* theOperation);
 
+private:
   /// Display all results
-  void displayAllResults();
+  //void displayAllResults();
 
-  /// Displau results from document
+  /// Display results from document
   /// \param theDoc a document
   void displayDocumentResults(DocumentPtr theDoc);
 
@@ -345,12 +416,12 @@ signals:
   virtual void onOperationResumed(ModuleBase_Operation* theOperation);
 
   /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
-  /// hides the property panel and udpate the command status.
+  /// hides the property panel and update the command status.
   /// \param theOpertion a stopped operation
   virtual void onOperationStopped(ModuleBase_Operation* theOperation);
 
   /// SLOT, that is called after the operation is committed.
-  /// \param theOpertion a commmitted operation
+  /// \param theOpertion a committed operation
   virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
 
   /// SLOT, that is called after the operation is aborted.
@@ -365,6 +436,14 @@ signals:
   /// Set waiting cursor
   void onStartWaiting();
 
+  /// Called by Ok button clicked in the property panel. Asks the error manager whether
+  /// the operation can be committed and do it if it returns true.
+  void onAcceptActionClicked();
+
+  /// Called by Preview button clicked in the property panel. Sends signal to model to
+  /// compute preview.
+  void onPreviewActionClicked();
+
  private:
    /// Init menu
   void initMenu();
@@ -376,8 +455,8 @@ signals:
   /// \param theModule name of the module
   ModuleBase_IModule* loadModule(const QString& theModule);
 
-  /// Activate module
-  bool activateModule();
+  /// Create module
+  bool createModule();
 
   /// Create object browser widget
   /// \param theParent a parent of widget
@@ -390,12 +469,6 @@ signals:
   // Creates Dock widgets: Object browser and Property panel
   void createDockWidgets();
 
-  /// Displaus object and fit all viewer if the object is first (update viewer will not be called)
-  /// Asks the module whether the object can be displayed
-  /// \param theObj an object
-  /// \return true if the object is displayed
-  bool displayObject(ObjectPtr theObj);
-
   //! Extends undo/redo toolbutton's with history menu
   //! \param theObject - in the OpenParts it is a QToolButton by itself,
   //! in salome mode - QAction that creates a button.
@@ -407,27 +480,31 @@ signals:
   QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
 
 private:
+#ifndef HAVE_SALOME
   AppElements_MainWindow* myMainWindow;
+#endif
+
   ModuleBase_IModule* myModule;
+  XGUI_ErrorMgr* myErrorMgr;
   XGUI_ObjectsBrowser* myObjectBrowser;
   XGUI_PropertyPanel* myPropertyPanel;
   XGUI_SelectionMgr* mySelector;
   XGUI_Displayer* myDisplayer;
   XGUI_OperationMgr* myOperationMgr;  ///< manager to manipulate through the operations
   XGUI_ActionsMgr* myActionsMgr;
+  XGUI_MenuMgr* myMenuMgr; ///< manager to build menu/tool bar using order defined in XML
   XGUI_SalomeConnector* mySalomeConnector;
   XGUI_ErrorDialog* myErrorDlg;
   XGUI_ViewerProxy* myViewerProxy;
   XGUI_ContextMenuMgr* myContextMenuMgr;
   XGUI_ModuleConnector* myModuleConnector;
+  XGUI_WorkshopListener* myEventsListener;
 
   QString myCurrentDir;
-  static QMap<QString, QString> myIcons;
 
-  bool myUpdatePrefs;
+  QIntList myViewerSelMode;
 
-  // Flag to check that part document is in process of activating
-  bool myPartActivating;
+  Config_DataModelReader* myDataModelXMLReader;
 };
 
 #endif