Salome HOME
A correction to check modified value in extrusion cut/sketch/etc operations.
[modules/shaper.git] / src / XGUI / XGUI_Workshop.h
old mode 100644 (file)
new mode 100755 (executable)
index 4db6052..5aa9e78
@@ -5,69 +5,82 @@
 
 #include "XGUI.h"
 //#include "XGUI_Constants.h"
-#include <Events_Listener.h>
 #include <ModuleBase_Definitions.h>
 #include <ModelAPI_Document.h>
 #include <ModelAPI_Feature.h>
 
+#include <ModuleBase_ActionInfo.h>
+
 #include <QObject>
 #include <QMap>
 #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_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 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:
-
+  /// Constructor
+  /// \param theConnector a Salome connector object. 
+  /// Used only if the workshop is launched in Salome environment
   XGUI_Workshop(XGUI_SalomeConnector* theConnector = 0);
   virtual ~XGUI_Workshop();
 
   //! 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
   {
@@ -86,6 +99,12 @@ Q_OBJECT
     return myOperationMgr;
   }
 
+  //! ! Returns error manager.
+  XGUI_ErrorMgr* errorMgr() const
+  {
+    return myErrorMgr;
+  }
+
   //! ! Returns an actions manager
   XGUI_ActionsMgr* actionsMgr() const
   {
@@ -104,12 +123,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
   {
@@ -131,29 +144,49 @@ Q_OBJECT
     return myObjectBrowser;
   }
 
+  /// This method is called by Salome module when selection is changed
   void salomeViewerSelectionChanged();
 
+  /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
   XGUI_ViewerProxy* viewer() const
   {
     return myViewerProxy;
   }
 
-  /// Returns the module connectory
+  /// Returns the module connector
   /// \returns the instance of connector
   XGUI_ModuleConnector* moduleConnector() const
   {
     return myModuleConnector;
   }
 
-  //! Returns icon name according to feature
-  static QIcon featureIcon(const FeaturePtr& theFeature);
-
-  //! Activates or deactivates a part
-  //! If PartPtr is Null pointer then PartSet will be activated
-  void activatePart(std::shared_ptr<ModelAPI_ResultPart> theFeature);
+  /// Returns a desktop
+  /// \return a desktop instance
+  QMainWindow* desktop() const;
 
   //! Delete features
-  void deleteObjects(const QObjectPtrList& theList);
+  void deleteObjects();
+
+  //! Returns true if the selected feature can be moved to the position after the current feature
+  //! \return boolean value
+  bool canMoveFeature();
+
+  //! 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
+  bool canChangeColor() const;
+
+  //! Change color of the features if it is possible
+  //! The operation is available for construction, body and group results
+  //! theObjects a list of selected objects
+  void changeColor(const QObjectPtrList& theObjects);
 
   //! Show the given features in 3d Viewer
   void showObjects(const QObjectPtrList& theList, bool isVisible);
@@ -161,17 +194,21 @@ Q_OBJECT
   //! Show the given features in 3d Viewer
   void showOnlyObjects(const QObjectPtrList& theList);
 
+  /// 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);
 
+  /// 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; }
 
   /**
@@ -181,68 +218,144 @@ 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 theList an objects to be deleted
+  //! \param theIgnoredFeatures a list of features to be ignored during delete
+  //! \param theParent a parent widget for the question message box
+  //! \param theAskAboutDeleteReferences if true, the message box with a list of references to the
+  //! objects features appear. If the user chose do not continue, the deletion is not performed
+  //! \return the success of the delete 
+  bool deleteFeatures(const QObjectPtrList& theList,
+                      const std::set<FeaturePtr>& theIgnoredFeatures = std::set<FeaturePtr>(),
+                      QWidget* theParent = 0,
+                      const bool theAskAboutDeleteReferences = false);
+
+  /// 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);
+
+  /// 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);
 
 signals:
+  /// Emitted when selection happens in Salome viewer
   void salomeViewerSelection();
+
+  /// Emitted when error in application happens
   void errorOccurred(const QString&);
+
   //! the signal about the workshop actions states are updated.
   void commandStatusUpdated();
 
+  //! the application is started
+  void applicationStarted();
+
+  //! Signal to update Undo history list
+  void updateUndoHistory(const QList<ActionInfo>&);
+
+  //! Signal to update Redo history list
+  void updateRedoHistory(const QList<ActionInfo>&);
+
  public slots:
+   /// Update of commands status
   void updateCommandStatus();
 
-  void onNew();
-  void onOpen();
+  /// update history list (undo/redo commands)
+  void updateHistory();
+
+  /// Save current document
   bool onSave();
+
+  /// Save current document to a file selected by user
   bool onSaveAs();
-  void onExit();
-  void onUndo();
-  void onRedo();
+
+  /// Undo last command
+  void onUndo(int times = 1);
+
+  /// Redo previous command
+  void onRedo(int times = 1);
+
+  /// Rebuild data tree
   void onRebuild();
-  void onPreferences();
 
+  /// Validates the operation to change the "Apply" button state.
+  /// \param thePreviousState the previous state of the widget
+  void onWidgetStateChanged(int thePreviousState);
+
+  /// Show property panel
   void showPropertyPanel();
+
+  /// Hide property panel
   void hidePropertyPanel();
+
+  /// Show object Browser
   void showObjectBrowser();
+
+  /// Hide object Browser
   void hideObjectBrowser();
 
-  void onFeatureTriggered();
-  void changeCurrentDocument(ObjectPtr theObj);
+  /// Close document
+  void closeDocument();
 
-  void activateLastPart();
+  /// Open document from file
+  void onOpen();
 
-  void closeDocument();
+  /// Create a new document
+  void onNew();
+
+#ifndef HAVE_SALOME
+  /// Exit application
+  void onExit();
+
+  /// Open preferences dialog box
+  void onPreferences();
+#endif
 
  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
+  /// 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);
+
+  /// 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);
 
-  bool event(QEvent * theEvent);
-  //Event-loop processing methods:
-  void addFeature(const std::shared_ptr<Config_FeatureMessage>&);
-  void connectWithOperation(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);
 
-  void onFeatureUpdatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg);
-  void onFeatureCreatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg);
-  void onFeatureRedisplayMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg);
-  void onObjectDeletedMsg(const std::shared_ptr<ModelAPI_ObjectDeletedMessage>& theMsg);
+private:
+  /// Display all results
+  //void displayAllResults();
 
-  void validateOperation(const QString& theOperationId);
-
-  void displayAllResults();
+  /// Display results from document
+  /// \param theDoc a document
   void displayDocumentResults(DocumentPtr theDoc);
+
+  /// Display results from a group
   void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
 
  private slots:
@@ -257,40 +370,81 @@ 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.
   /// \param theOpertion an aborted operation
   void onOperationAborted(ModuleBase_Operation* theOperation);
 
+  /// Slot, which reacts to the context popup menu call
+  /// \param theId the data value of the clicked action
+  /// \param isChecked a state of toggle if the action is checkable
   void onContextMenuCommand(const QString& theId, bool isChecked);
 
-  void onWidgetValuesChanged();
-
+  /// 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();
+
+  /// Listens the corresponded signal from operation manager and send it with the Ok
+  /// action to operation manager.
+  /// \param theEnabled an enabled state for the action
+  //void onValidationStateChanged(bool theEnabled);
+
+  //connect(myOperationMgr,  SIGNAL(validationStateChanged(bool)),
+  //        aOkAct,          SLOT(setEnabled(bool)));
+
+
  private:
+   /// Init menu
   void initMenu();
 
+  /// Register validators
   void registerValidators() const;
 
+  /// Load module from external library
+  /// \param theModule name of the module
   ModuleBase_IModule* loadModule(const QString& theModule);
-  bool activateModule();
 
+  /// Create module
+  bool createModule();
+
+  /// Create object browser widget
+  /// \param theParent a parent of widget
   QDockWidget* createObjectBrowser(QWidget* theParent);
+
+  /// Create property panel widget
+  /// \param theParent a parent of widget
   QDockWidget* createPropertyPanel(QWidget* theParent);
 
   // Creates Dock widgets: Object browser and Property panel
   void createDockWidgets();
 
+  //! 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.
+  //! \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
+  //! \param theSlot - onUndo(int) or onRedo(int) SLOT
+  void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
+
+  //! Creates list of actions (commands) by given history list from session
+  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;
@@ -302,14 +456,9 @@ signals:
   XGUI_ViewerProxy* myViewerProxy;
   XGUI_ContextMenuMgr* myContextMenuMgr;
   XGUI_ModuleConnector* myModuleConnector;
+  XGUI_WorkshopListener* myEventsListener;
 
   QString myCurrentDir;
-  static QMap<QString, QString> myIcons;
-
-  bool myUpdatePrefs;
-
-  // Flag to check that part document is in process of activating
-  bool myPartActivating;
 };
 
 #endif