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 an actions manager
96 XGUI_ActionsMgr* actionsMgr() const
101 //! Returns property panel widget
102 XGUI_PropertyPanel* propertyPanel() const
104 return myPropertyPanel;
107 //! Returns context menu manager object
108 XGUI_ContextMenuMgr* contextMenuMgr() const
110 return myContextMenuMgr;
113 //! Creates and adds a new workbench (menu group) with the given name and returns it
114 AppElements_Workbench* addWorkbench(const QString& theName);
116 //! Returns an object which provides interface to Salome Module (LightApp_Module)
117 XGUI_SalomeConnector* salomeConnector() const
119 return mySalomeConnector;
122 //! Provides an object which provides interface to Salome Viewer
123 ModuleBase_IViewer* salomeViewer() const;
125 //! Returns true if the application works as SALOME module
126 bool isSalomeMode() const
128 return mySalomeConnector != 0;
131 //! Returns Object browser
132 XGUI_ObjectsBrowser* objectBrowser() const
134 return myObjectBrowser;
137 /// This method is called by Salome module when selection is changed
138 void salomeViewerSelectionChanged();
140 /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
141 XGUI_ViewerProxy* viewer() const
143 return myViewerProxy;
146 /// Returns the module connectory
147 /// \returns the instance of connector
148 XGUI_ModuleConnector* moduleConnector() const
150 return myModuleConnector;
153 /// Returns a desktop
154 /// \return a desktop instance
155 QMainWindow* desktop() const;
158 void deleteObjects();
160 //! Returns true if the selected feature can be moved to the position after the current feature
161 //! \return boolean value
162 bool canMoveFeature();
164 //! Move selected features to be after the current feature
167 //! Returns true if the object can be shaded. If the object is a compsolid result, the method
168 //! checks subobjects of the result
169 //! \return boolean value
170 bool canBeShaded(const ObjectPtr& theObject) const;
172 //! Returns true if there is at least one selected body/construction/group result
173 //! \return boolean value
174 bool canChangeColor() const;
176 //! Change color of the features if it is possible
177 //! The operation is available for construction, body and group results
178 //! theObjects a list of selected objects
179 void changeColor(const QObjectPtrList& theObjects);
181 //! Show the given features in 3d Viewer
182 void showObjects(const QObjectPtrList& theList, bool isVisible);
184 //! Show the given features in 3d Viewer
185 void showOnlyObjects(const QObjectPtrList& theList);
187 /// Set display mode for the given onjects
188 /// \param theList a list of displayed objects
189 /// \param theMode a mode to set (see \ref XGUI_Displayer)
190 void setDisplayMode(const QObjectPtrList& theList, int theMode);
192 /// Returns current module
193 ModuleBase_IModule* module() const
198 /// Returns current directory whic contains data files
199 QString currentDataDir() const { return myCurrentDir; }
201 /// Returns current directory whic contains data files
202 void setCurrentDataDir(const QString& theDir) { myCurrentDir = theDir; }
205 * Save the current document into a directory
206 * \param theName - path to the directory
207 * \param theFileNames - returned file names created in this directory
209 void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
212 * If there is an active (uncommited) operation shows a prompt to abort it
213 * and performs abortion if user agreed. Returns true if
214 * - operation aborted successfully
215 * - there is no active operation
217 bool abortAllOperations();
219 //! Delete features. Delete the referenced features. There can be a question with a list of referenced
221 //! \param theList an objects to be deleted
222 //! \param theIgnoredFeatures a list of features to be ignored during delete
223 //! \param theParent a parent widget for the question message box
224 //! \param theAskAboutDeleteReferences if true, the message box with a list of references to the
225 //! objects features appear. If the user chose do not continue, the deletion is not performed
226 //! \return the success of the delete
227 bool deleteFeatures(const QObjectPtrList& theList,
228 const std::set<FeaturePtr>& theIgnoredFeatures = std::set<FeaturePtr>(),
229 QWidget* theParent = 0,
230 const bool theAskAboutDeleteReferences = false);
232 /// Deactivates the object, if it is active and the module returns that the activation
233 /// of selection for the object is not possible currently(the current operation uses it)
234 /// \param theObject an object
235 /// \param theUpdateViewer a boolean flag to update viewer immediately
236 void deactivateActiveObject(const ObjectPtr& theObject, const bool theUpdateViewer);
239 /// Emitted when selection happens in Salome viewer
240 void salomeViewerSelection();
242 /// Emitted when error in applivation happens
243 void errorOccurred(const QString&);
245 //! the signal about the workshop actions states are updated.
246 void commandStatusUpdated();
248 //! the application is started
249 void applicationStarted();
251 //! Signal to update Undo history list
252 void updateUndoHistory(const QList<ActionInfo>&);
254 //! Signal to update Redo history list
255 void updateRedoHistory(const QList<ActionInfo>&);
258 /// Update of commands status
259 void updateCommandStatus();
261 /// update history list (undo/redo commands)
262 void updateHistory();
264 /// Create a new dokument
267 /// Open document from file
270 /// Save current document
273 /// Save current document to a file selected by user
279 /// Undo last command
280 void onUndo(int times = 1);
282 /// Redo previous command
283 void onRedo(int times = 1);
285 /// Rebuild data tree
288 /// Open preferences dialog box
289 void onPreferences();
291 /// Show property panel
292 void showPropertyPanel();
294 /// Hide property panel
295 void hidePropertyPanel();
297 /// Show object Browser
298 void showObjectBrowser();
300 /// Hide object Browser
301 void hideObjectBrowser();
304 void closeDocument();
307 /// Sets the granted operations for the parameter operation. Firtsly, it finds the nested features
308 /// and set them into the operation. Secondly, it asks the module about ids of granted operations.
309 /// \param theOperation an operation
310 void setGrantedFeatures(ModuleBase_Operation* theOperation);
312 /// Update the property panel content by the XML description of the operation and set the panel
313 /// into the operation
314 /// \param theOperation an operation
315 void setPropertyPanel(ModuleBase_Operation* theOperation);
318 /// Display all results
319 //void displayAllResults();
321 /// Displau results from document
322 /// \param theDoc a document
323 void displayDocumentResults(DocumentPtr theDoc);
325 /// Display results from a group
326 void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
329 /// SLOT, that is called after the operation is started. Update workshop state according to
330 /// the started operation, e.g. visualizes the property panel and connect to it.
331 /// \param theOpertion a started operation
332 void onOperationStarted(ModuleBase_Operation* theOperation);
334 /// SLOT, that is called after the operation is resumed. Update workshop state according to
335 /// the started operation, e.g. visualizes the property panel and connect to it.
336 /// \param theOpertion a resumed operation
337 virtual void onOperationResumed(ModuleBase_Operation* theOperation);
339 /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
340 /// hides the property panel and udpate the command status.
341 /// \param theOpertion a stopped operation
342 virtual void onOperationStopped(ModuleBase_Operation* theOperation);
344 /// SLOT, that is called after the operation is committed.
345 /// \param theOpertion a commmitted operation
346 virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
348 /// SLOT, that is called after the operation is aborted.
349 /// \param theOpertion an aborted operation
350 void onOperationAborted(ModuleBase_Operation* theOperation);
352 /// Slot, which reacts to the context popup menu call
353 /// \param theId the data value of the clicked action
354 /// \param isChecked a state of toggle if the action is checkable
355 void onContextMenuCommand(const QString& theId, bool isChecked);
357 /// Set waiting cursor
358 void onStartWaiting();
364 /// Register validators
365 void registerValidators() const;
367 /// Load module from external library
368 /// \param theModule name of the module
369 ModuleBase_IModule* loadModule(const QString& theModule);
374 /// Create object browser widget
375 /// \param theParent a parent of widget
376 QDockWidget* createObjectBrowser(QWidget* theParent);
378 /// Create property panel widget
379 /// \param theParent a parent of widget
380 QDockWidget* createPropertyPanel(QWidget* theParent);
382 // Creates Dock widgets: Object browser and Property panel
383 void createDockWidgets();
385 //! Extends undo/redo toolbutton's with history menu
386 //! \param theObject - in the OpenParts it is a QToolButton by itself,
387 //! in salome mode - QAction that creates a button.
388 //! \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
389 //! \param theSlot - onUndo(int) or onRedo(int) SLOT
390 void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
392 //! Creates list of actions (commands) by given history list from session
393 QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
396 AppElements_MainWindow* myMainWindow;
397 ModuleBase_IModule* myModule;
398 XGUI_ErrorMgr* myErrorMgr;
399 XGUI_ObjectsBrowser* myObjectBrowser;
400 XGUI_PropertyPanel* myPropertyPanel;
401 XGUI_SelectionMgr* mySelector;
402 XGUI_Displayer* myDisplayer;
403 XGUI_OperationMgr* myOperationMgr; ///< manager to manipulate through the operations
404 XGUI_ActionsMgr* myActionsMgr;
405 XGUI_SalomeConnector* mySalomeConnector;
406 XGUI_ErrorDialog* myErrorDlg;
407 XGUI_ViewerProxy* myViewerProxy;
408 XGUI_ContextMenuMgr* myContextMenuMgr;
409 XGUI_ModuleConnector* myModuleConnector;
410 XGUI_WorkshopListener* myEventsListener;
412 QString myCurrentDir;