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 <Events_Listener.h>
9 #include <ModuleBase_Definitions.h>
10 #include <ModelAPI_Document.h>
11 #include <ModelAPI_Feature.h>
13 #include <ModuleBase_ActionInfo.h>
17 #include <QKeySequence>
20 class AppElements_MainWindow;
21 class AppElements_Command;
22 class AppElements_Workbench;
24 class XGUI_SelectionMgr;
26 class XGUI_OperationMgr;
27 class XGUI_SalomeConnector;
28 class XGUI_ObjectsBrowser;
29 class XGUI_ActionsMgr;
30 class XGUI_ErrorDialog;
31 class XGUI_SalomeViewer;
32 class XGUI_ViewerProxy;
33 class XGUI_PropertyPanel;
34 class XGUI_ContextMenuMgr;
35 class XGUI_ModuleConnector;
37 class ModuleBase_Operation;
38 class ModuleBase_IModule;
39 class ModuleBase_IViewer;
41 class Config_FeatureMessage;
42 class Config_PointerMessage;
48 class ModelAPI_ObjectUpdatedMessage;
49 class ModelAPI_ObjectDeletedMessage;
50 class ModelAPI_ResultPart;
53 /**\class XGUI_Workshop
55 * \brief Class which defines a configuration of the application (Workshop) and launches it.
57 class XGUI_EXPORT XGUI_Workshop : public QObject, public Events_Listener
62 /// \param theConnector a Salome connector object.
63 /// Used only if the workshop is launched in Salome environment
64 XGUI_Workshop(XGUI_SalomeConnector* theConnector = 0);
65 virtual ~XGUI_Workshop();
67 //! Starting of the application
68 void startApplication();
70 //! Returns main window (Desktop) of the application
71 AppElements_MainWindow* mainWindow() const
76 //! Returns selection manager object
77 XGUI_SelectionMgr* selector() const
83 XGUI_Displayer* displayer() const
88 //! ! Returns operation manager.
89 XGUI_OperationMgr* operationMgr() const
91 return myOperationMgr;
94 //! ! Returns an actions manager
95 XGUI_ActionsMgr* actionsMgr() const
100 //! Returns property panel widget
101 XGUI_PropertyPanel* propertyPanel() const
103 return myPropertyPanel;
106 //! Returns context menu manager object
107 XGUI_ContextMenuMgr* contextMenuMgr() const
109 return myContextMenuMgr;
112 //! Creates and adds a new workbench (menu group) with the given name and returns it
113 AppElements_Workbench* addWorkbench(const QString& theName);
115 //! Redefinition of Events_Listener method
116 virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
118 //! Returns an object which provides interface to Salome Module (LightApp_Module)
119 XGUI_SalomeConnector* salomeConnector() const
121 return mySalomeConnector;
124 //! Provides an object which provides interface to Salome Viewer
125 ModuleBase_IViewer* salomeViewer() const;
127 //! Returns true if the application works as SALOME module
128 bool isSalomeMode() const
130 return mySalomeConnector != 0;
133 //! Returns Object browser
134 XGUI_ObjectsBrowser* objectBrowser() const
136 return myObjectBrowser;
139 /// This method is called by Salome module when selection is changed
140 void salomeViewerSelectionChanged();
142 /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
143 XGUI_ViewerProxy* viewer() const
145 return myViewerProxy;
148 /// Returns the module connectory
149 /// \returns the instance of connector
150 XGUI_ModuleConnector* moduleConnector() const
152 return myModuleConnector;
155 /// Returns a desktop
156 /// \return a desktop instance
157 QMainWindow* desktop() const;
159 //! Returns icon name according to feature
160 static QIcon featureIcon(const FeaturePtr& theFeature);
162 //! Activates or deactivates a part
163 //! If PartPtr is Null pointer then PartSet will be activated
164 void activatePart(std::shared_ptr<ModelAPI_ResultPart> theFeature);
167 void deleteObjects(const QObjectPtrList& theList);
169 //! Show the given features in 3d Viewer
170 void showObjects(const QObjectPtrList& theList, bool isVisible);
172 //! Show the given features in 3d Viewer
173 void showOnlyObjects(const QObjectPtrList& theList);
175 /// Set display mode for the given onjects
176 /// \param theList a list of displayed objects
177 /// \param theMode a mode to set (see \ref XGUI_Displayer)
178 void setDisplayMode(const QObjectPtrList& theList, int theMode);
180 /// Returns current module
181 ModuleBase_IModule* module() const
186 /// Returns current directory whic contains data files
187 QString currentDataDir() const { return myCurrentDir; }
189 /// Returns current directory whic contains data files
190 void setCurrentDataDir(const QString& theDir) { myCurrentDir = theDir; }
193 * Save the current document into a directory
194 * \param theName - path to the directory
195 * \param theFileNames - returned file names created in this directory
197 void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
200 * If there is an active (uncommited) operation shows a prompt to abort it
201 * and performs abortion if user agreed. Returns true if
202 * - operation aborted successfully
203 * - there is no active operation
205 bool isActiveOperationAborted();
208 /// Emitted when selection happens in Salome viewer
209 void salomeViewerSelection();
211 /// Emitted when error in applivation happens
212 void errorOccurred(const QString&);
214 //! the signal about the workshop actions states are updated.
215 void commandStatusUpdated();
217 //! the application is started
218 void applicationStarted();
220 void updateUndoHistory(const QList<ActionInfo>&);
221 void updateRedoHistory(const QList<ActionInfo>&);
224 /// Update of commands status
225 void updateCommandStatus();
227 /// update history list (undo/redo commands)
228 void updateHistory();
230 /// Create a new dokument
233 /// Open document from file
236 /// Save current document
239 /// Save current document to a file selected by user
245 /// Undo last command
246 void onUndo(int times = 1);
248 /// Redo previous command
249 void onRedo(int times = 1);
251 /// Rebuild data tree
254 /// Open preferences dialog box
255 void onPreferences();
257 /// Show property panel
258 void showPropertyPanel();
260 /// Hide property panel
261 void hidePropertyPanel();
263 /// Show object Browser
264 void showObjectBrowser();
266 /// Hide object Browser
267 void hideObjectBrowser();
269 /// Reaction on command call
270 void onFeatureTriggered();
272 /// Change active document
273 /// \param theObj a part object. If it is NULL then active document is a main document
274 void changeCurrentDocument(ObjectPtr theObj);
276 //void activateLastPart();
279 void closeDocument();
282 /// Find the nested features and set them into the operation
283 /// \param theOperation an operation
284 void setNestedFeatures(ModuleBase_Operation* theOperation);
286 /// Update the property panel content by the XML description of the operation and set the panel
287 /// into the operation
288 /// \param theOperation an operation
289 void setPropertyPanel(ModuleBase_Operation* theOperation);
291 /// Procedure to process postponed events
292 bool event(QEvent * theEvent);
294 //Event-loop processing methods:
296 /// Process event "Add a feature"
297 void addFeature(const std::shared_ptr<Config_FeatureMessage>&);
299 /// Connect to operation signals
300 /// \param theOperation an operation
301 void connectWithOperation(ModuleBase_Operation* theOperation);
303 /// Process feature update message
304 void onFeatureUpdatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
306 ///Process feature created message
307 void onFeatureCreatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
309 /// Process feature redisplay message
310 void onFeatureRedisplayMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
312 /// Process feature delete message
313 void onObjectDeletedMsg(const std::shared_ptr<ModelAPI_ObjectDeletedMessage>& );
315 /// Display all results
316 void displayAllResults();
318 /// Displau results from document
319 /// \param theDoc a document
320 void displayDocumentResults(DocumentPtr theDoc);
322 /// Display results from a group
323 void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
326 /// SLOT, that is called after the operation is started. Update workshop state according to
327 /// the started operation, e.g. visualizes the property panel and connect to it.
328 /// \param theOpertion a started operation
329 void onOperationStarted(ModuleBase_Operation* theOperation);
331 /// SLOT, that is called after the operation is resumed. Update workshop state according to
332 /// the started operation, e.g. visualizes the property panel and connect to it.
333 /// \param theOpertion a resumed operation
334 virtual void onOperationResumed(ModuleBase_Operation* theOperation);
336 /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
337 /// hides the property panel and udpate the command status.
338 /// \param theOpertion a stopped operation
339 virtual void onOperationStopped(ModuleBase_Operation* theOperation);
341 /// SLOT, that is called after the operation is committed.
342 /// \param theOpertion a commmitted operation
343 virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
345 /// SLOT, that is called after the operation is aborted.
346 /// \param theOpertion an aborted operation
347 void onOperationAborted(ModuleBase_Operation* theOperation);
349 /// Slot, which reacts to the context popup menu call
350 /// \param theId the data value of the clicked action
351 /// \param isChecked a state of toggle if the action is checkable
352 void onContextMenuCommand(const QString& theId, bool isChecked);
354 /// Processing of values changed in model widget
355 void onWidgetValuesChanged();
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);
372 bool activateModule();
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 /// Displaus object and fit all viewer if the object is first (update viewer will not be called)
386 void displayObject(ObjectPtr theObj);
388 //! Extends undo/redo toolbutton's with history menu
389 //! \param theObject - in the OpenParts it is a QToolButton by itself,
390 //! in salome mode - QAction that creates a button.
391 //! \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
392 //! \param theSlot - onUndo(int) or onRedo(int) SLOT
393 void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
396 AppElements_MainWindow* myMainWindow;
397 ModuleBase_IModule* myModule;
398 XGUI_ObjectsBrowser* myObjectBrowser;
399 XGUI_PropertyPanel* myPropertyPanel;
400 XGUI_SelectionMgr* mySelector;
401 XGUI_Displayer* myDisplayer;
402 XGUI_OperationMgr* myOperationMgr; ///< manager to manipulate through the operations
403 XGUI_ActionsMgr* myActionsMgr;
404 XGUI_SalomeConnector* mySalomeConnector;
405 XGUI_ErrorDialog* myErrorDlg;
406 XGUI_ViewerProxy* myViewerProxy;
407 XGUI_ContextMenuMgr* myContextMenuMgr;
408 XGUI_ModuleConnector* myModuleConnector;
410 QString myCurrentDir;
411 static QMap<QString, QString> myIcons;
415 // Flag to check that part document is in process of activating
416 bool myPartActivating;