1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 #ifndef XGUI_WORKSHOP_H
4 #define XGUI_WORKSHOP_H
7 //#include "XGUI_Constants.h"
8 #include <ModuleBase_Definitions.h>
9 #include <ModelAPI_Document.h>
10 #include <ModelAPI_Feature.h>
12 #include <ModuleBase_ActionInfo.h>
16 #include <QKeySequence>
19 class AppElements_MainWindow;
20 class AppElements_Command;
21 class AppElements_Workbench;
23 class XGUI_ActionsMgr;
24 class XGUI_ContextMenuMgr;
26 class XGUI_ErrorDialog;
28 class XGUI_ModuleConnector;
29 class XGUI_ObjectsBrowser;
30 class XGUI_OperationMgr;
31 class XGUI_PropertyPanel;
32 class XGUI_SalomeConnector;
33 class XGUI_SalomeViewer;
34 class XGUI_SelectionMgr;
35 class XGUI_ViewerProxy;
36 class XGUI_WorkshopListener;
38 class ModuleBase_IModule;
39 class ModuleBase_IViewer;
40 class ModuleBase_Operation;
48 /**\class XGUI_Workshop
50 * \brief Class which defines a configuration of the application (Workshop) and launches it.
52 class XGUI_EXPORT XGUI_Workshop : public QObject
57 /// \param theConnector a Salome connector object.
58 /// Used only if the workshop is launched in Salome environment
59 XGUI_Workshop(XGUI_SalomeConnector* theConnector = 0);
60 virtual ~XGUI_Workshop();
62 //! Starting of the application
63 void startApplication();
65 /// Activates the module controls. Should be called after module creation
66 void activateModule();
68 /// Deactivates the module controls. Should be called after module creation
69 void deactivateModule();
71 //! Returns main window (Desktop) of the application
72 AppElements_MainWindow* mainWindow() const
77 //! Returns selection manager object
78 XGUI_SelectionMgr* selector() const
84 XGUI_Displayer* displayer() const
89 //! ! Returns operation manager.
90 XGUI_OperationMgr* operationMgr() const
92 return myOperationMgr;
95 //! ! Returns error manager.
96 XGUI_ErrorMgr* errorMgr() const
101 //! ! Returns an actions manager
102 XGUI_ActionsMgr* actionsMgr() const
107 //! Returns property panel widget
108 XGUI_PropertyPanel* propertyPanel() const
110 return myPropertyPanel;
113 //! Returns context menu manager object
114 XGUI_ContextMenuMgr* contextMenuMgr() const
116 return myContextMenuMgr;
119 //! Creates and adds a new workbench (menu group) with the given name and returns it
120 AppElements_Workbench* addWorkbench(const QString& theName);
122 //! Returns an object which provides interface to Salome Module (LightApp_Module)
123 XGUI_SalomeConnector* salomeConnector() const
125 return mySalomeConnector;
128 //! Provides an object which provides interface to Salome Viewer
129 ModuleBase_IViewer* salomeViewer() const;
131 //! Returns true if the application works as SALOME module
132 bool isSalomeMode() const
134 return mySalomeConnector != 0;
137 //! Returns Object browser
138 XGUI_ObjectsBrowser* objectBrowser() const
140 return myObjectBrowser;
143 /// This method is called by Salome module when selection is changed
144 void salomeViewerSelectionChanged();
146 /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
147 XGUI_ViewerProxy* viewer() const
149 return myViewerProxy;
152 /// Returns the module connector
153 /// \returns the instance of connector
154 XGUI_ModuleConnector* moduleConnector() const
156 return myModuleConnector;
159 /// Returns a desktop
160 /// \return a desktop instance
161 QMainWindow* desktop() const;
164 void deleteObjects();
166 //! Returns true if the selected feature can be moved to the position after the current feature
167 //! \return boolean value
168 bool canMoveFeature();
170 //! Move selected features to be after the current feature
173 //! Returns true if the object can be shaded. If the object is a compsolid result, the method
174 //! checks subobjects of the result
175 //! \return boolean value
176 bool canBeShaded(const ObjectPtr& theObject) const;
178 //! Returns true if there is at least one selected body/construction/group result
179 //! \return boolean value
180 bool canChangeColor() const;
182 //! Change color of the features if it is possible
183 //! The operation is available for construction, body and group results
184 //! theObjects a list of selected objects
185 void changeColor(const QObjectPtrList& theObjects);
187 //! Show the given features in 3d Viewer
188 void showObjects(const QObjectPtrList& theList, bool isVisible);
190 //! Show the given features in 3d Viewer
191 void showOnlyObjects(const QObjectPtrList& theList);
193 /// Set display mode for the given objects
194 /// \param theList a list of displayed objects
195 /// \param theMode a mode to set (see \ref XGUI_Displayer)
196 void setDisplayMode(const QObjectPtrList& theList, int theMode);
198 /// Returns current module
199 ModuleBase_IModule* module() const
204 /// Returns current directory which contains data files
205 QString currentDataDir() const { return myCurrentDir; }
207 /// Returns current directory which contains data files
208 void setCurrentDataDir(const QString& theDir) { myCurrentDir = theDir; }
211 * Save the current document into a directory
212 * \param theName - path to the directory
213 * \param theFileNames - returned file names created in this directory
215 void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
218 * If there is an active (uncommitted) operation shows a prompt to abort it
219 * and performs abortion if user agreed. Returns true if
220 * - operation aborted successfully
221 * - there is no active operation
223 bool abortAllOperations();
225 //! Delete features. Delete the referenced features. There can be a question with a list of referenced
227 //! \param theList an objects to be deleted
228 //! \param theIgnoredFeatures a list of features to be ignored during delete
229 //! \param theParent a parent widget for the question message box
230 //! \param theAskAboutDeleteReferences if true, the message box with a list of references to the
231 //! objects features appear. If the user chose do not continue, the deletion is not performed
232 //! \return the success of the delete
233 bool deleteFeatures(const QObjectPtrList& theList,
234 const std::set<FeaturePtr>& theIgnoredFeatures = std::set<FeaturePtr>(),
235 QWidget* theParent = 0,
236 const bool theAskAboutDeleteReferences = false);
238 /// Deactivates the object, if it is active and the module returns that the activation
239 /// of selection for the object is not possible currently(the current operation uses it)
240 /// \param theObject an object
241 /// \param theUpdateViewer a boolean flag to update viewer immediately
242 void deactivateActiveObject(const ObjectPtr& theObject, const bool theUpdateViewer);
244 /// Returns true if the action of the feature is created to contain Accept/Cancel button
245 /// \param theFeature a feature
246 bool isFeatureOfNested(const FeaturePtr& theFeature);
248 /// Has to be called in order to display objects with visibility status = true
249 void synchronizeViewer();
251 /// Has to be called in order to display objects from a cpecifed group with visibility status = true
252 /// \param theDoc the document for objects synchronisation
253 /// \param theGroup the group name
254 /// \param theUpdateViewer update viewer flag
255 void synchronizeGroupInViewer(const DocumentPtr& theDoc, const std::string& theGroup, bool theUpdateViewer);
258 /// Emitted when selection happens in Salome viewer
259 void salomeViewerSelection();
261 /// Emitted when error in application happens
262 void errorOccurred(const QString&);
264 //! the signal about the workshop actions states are updated.
265 void commandStatusUpdated();
267 //! the application is started
268 void applicationStarted();
270 //! Signal to update Undo history list
271 void updateUndoHistory(const QList<ActionInfo>&);
273 //! Signal to update Redo history list
274 void updateRedoHistory(const QList<ActionInfo>&);
277 /// Update of commands status
278 void updateCommandStatus();
280 /// update history list (undo/redo commands)
281 void updateHistory();
283 /// Create a new document
286 /// Open document from file
289 /// Save current document
292 /// Save current document to a file selected by user
298 /// Undo last command
299 void onUndo(int times = 1);
301 /// Redo previous command
302 void onRedo(int times = 1);
304 /// Rebuild data tree
307 /// Open preferences dialog box
308 void onPreferences();
310 /// Show property panel
311 void showPropertyPanel();
313 /// Hide property panel
314 void hidePropertyPanel();
316 /// Show object Browser
317 void showObjectBrowser();
319 /// Hide object Browser
320 void hideObjectBrowser();
323 void closeDocument();
326 /// Sets the granted operations for the parameter operation. Firstly, it finds the nested features
327 /// and set them into the operation. Secondly, it asks the module about ids of granted operations.
328 /// \param theOperation an operation
329 void setGrantedFeatures(ModuleBase_Operation* theOperation);
331 /// Update the property panel content by the XML description of the operation and set the panel
332 /// into the operation
333 /// \param theOperation an operation
334 void setPropertyPanel(ModuleBase_Operation* theOperation);
337 /// Display all results
338 //void displayAllResults();
340 /// Display results from document
341 /// \param theDoc a document
342 void displayDocumentResults(DocumentPtr theDoc);
344 /// Display results from a group
345 void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
348 /// SLOT, that is called after the operation is started. Update workshop state according to
349 /// the started operation, e.g. visualizes the property panel and connect to it.
350 /// \param theOpertion a started operation
351 void onOperationStarted(ModuleBase_Operation* theOperation);
353 /// SLOT, that is called after the operation is resumed. Update workshop state according to
354 /// the started operation, e.g. visualizes the property panel and connect to it.
355 /// \param theOpertion a resumed operation
356 virtual void onOperationResumed(ModuleBase_Operation* theOperation);
358 /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
359 /// hides the property panel and update the command status.
360 /// \param theOpertion a stopped operation
361 virtual void onOperationStopped(ModuleBase_Operation* theOperation);
363 /// SLOT, that is called after the operation is committed.
364 /// \param theOpertion a committed operation
365 virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
367 /// SLOT, that is called after the operation is aborted.
368 /// \param theOpertion an aborted operation
369 void onOperationAborted(ModuleBase_Operation* theOperation);
371 /// Slot, which reacts to the context popup menu call
372 /// \param theId the data value of the clicked action
373 /// \param isChecked a state of toggle if the action is checkable
374 void onContextMenuCommand(const QString& theId, bool isChecked);
376 /// Set waiting cursor
377 void onStartWaiting();
379 /// Called by Ok button clicked in the property panel. Asks the error manager whether
380 /// the operation can be committed and do it if it returns true.
381 void onAcceptActionClicked();
383 /// Listens the corresponded signal from operation manager and send it with the Ok
384 /// action to operation manager.
385 /// \param theEnabled an enabled state for the action
386 //void onValidationStateChanged(bool theEnabled);
388 //connect(myOperationMgr, SIGNAL(validationStateChanged(bool)),
389 // aOkAct, SLOT(setEnabled(bool)));
396 /// Register validators
397 void registerValidators() const;
399 /// Load module from external library
400 /// \param theModule name of the module
401 ModuleBase_IModule* loadModule(const QString& theModule);
406 /// Create object browser widget
407 /// \param theParent a parent of widget
408 QDockWidget* createObjectBrowser(QWidget* theParent);
410 /// Create property panel widget
411 /// \param theParent a parent of widget
412 QDockWidget* createPropertyPanel(QWidget* theParent);
414 // Creates Dock widgets: Object browser and Property panel
415 void createDockWidgets();
417 //! Extends undo/redo toolbutton's with history menu
418 //! \param theObject - in the OpenParts it is a QToolButton by itself,
419 //! in salome mode - QAction that creates a button.
420 //! \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
421 //! \param theSlot - onUndo(int) or onRedo(int) SLOT
422 void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
424 //! Creates list of actions (commands) by given history list from session
425 QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
428 AppElements_MainWindow* myMainWindow;
429 ModuleBase_IModule* myModule;
430 XGUI_ErrorMgr* myErrorMgr;
431 XGUI_ObjectsBrowser* myObjectBrowser;
432 XGUI_PropertyPanel* myPropertyPanel;
433 XGUI_SelectionMgr* mySelector;
434 XGUI_Displayer* myDisplayer;
435 XGUI_OperationMgr* myOperationMgr; ///< manager to manipulate through the operations
436 XGUI_ActionsMgr* myActionsMgr;
437 XGUI_SalomeConnector* mySalomeConnector;
438 XGUI_ErrorDialog* myErrorDlg;
439 XGUI_ViewerProxy* myViewerProxy;
440 XGUI_ContextMenuMgr* myContextMenuMgr;
441 XGUI_ModuleConnector* myModuleConnector;
442 XGUI_WorkshopListener* myEventsListener;
444 QString myCurrentDir;