1 // File: XGUI_OperationMgr.h
2 // Created: 20 Apr 2014
3 // Author: Natalia ERMOLAEVA
5 #ifndef XGUI_OperationMgr_H
6 #define XGUI_OperationMgr_H
10 #include <ModuleBase_Operation.h>
14 #include <QStringList>
18 /**\class XGUI_OperationMgr
20 * \brief Operation manager. Servers to manupulate to the workshop operations. Contains a stack
21 * of started operations. In simple case, if only one operration is started, the stack contains
22 * one operation. It is possible for some kind of operations to start them above already
23 * started one. In that case, the previous active operation becames suspended, a new one - active.
24 * The new operation is added to the top of the stack. Then it is finished, it is removed from
25 * the stack and the previous operation is activated.
27 class XGUI_EXPORT XGUI_OperationMgr : public QObject
32 /// \param theParent the parent
33 XGUI_OperationMgr(QObject* theParent);
35 virtual ~XGUI_OperationMgr();
37 /// Returns the current operation or NULL
38 /// \return the current operation
39 ModuleBase_Operation* currentOperation() const;
40 /// Returns true is operation manager has at least one non-null operation.
41 bool hasOperation() const;
42 /// Returns number of operations in the stack
43 int operationsCount() const;
44 /// Start the operation and append it to the stack of operations
45 /// \param theOperation the started operation
46 /// \return the state whether the current operation is started
47 bool startOperation(ModuleBase_Operation* theOperation);
49 /// Abort the operation and append it to the stack of operations
50 /// \return the state whether the current operation is aborted
51 bool abortOperation();
52 ///Returns list of all operations IDs
53 QStringList operationList();
55 virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
58 /// Signal about an operation is started. It is emitted after the start() of operation is done.
59 void operationStarted();
60 /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
61 /// \param theOperation a stopped operation
62 void operationStopped(ModuleBase_Operation* theOperation);
63 /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
64 void operationResumed();
67 /// Sets the current operation or NULL
68 /// \param theOperation the started operation
69 /// \param isCheckBeforeStart the flag whether to check whether the operation can be started
70 /// \return the state whether the operation is resumed
71 void resumeOperation(ModuleBase_Operation* theOperation);
73 /// Returns whether the operation can be started. Check if there is already started operation and
74 /// the granted parameter of the launched operation
75 /// \param theOperation an operation to check
76 bool canStartOperation(ModuleBase_Operation* theOperation);
78 /// Returns whether the operation can be stopped.
79 bool canStopOperation();
82 /// Slot that commits the current operation.
83 void onCommitOperation();
84 /// Slot that aborts the current operation.
85 void onAbortOperation();
87 /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
88 /// If there is a suspended operation, restart it.
89 void onOperationStopped();
91 /// SLOT, that is called by the key in the property panel is clicked.
92 /// \param theName the attribute name
93 /// \param theEvent the mouse event
94 void onKeyReleased(const std::string& theName, QKeyEvent* theEvent);
97 typedef QList<ModuleBase_Operation*> Operations; ///< definition for a list of operations
98 Operations myOperations; ///< a stack of started operations. The active operation is on top,
99 // others are suspended and started by the active is finished