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 manipulate to the workshop operations. Contains a stack
21 * of started operations. In simple case, if only one operation 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 becomes 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 void validateCurrentOperation();
61 /// Signal about an operation is started. It is emitted after the start() of operation is done.
62 void operationStarted();
63 /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
64 /// \param theOperation a stopped operation
65 void operationStopped(ModuleBase_Operation* theOperation);
66 /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
67 void operationResumed();
68 /// Signal is emitted after the validate methods calls.
69 void operationValidated(bool);
70 /// Signal about the necessety of the next widget activating
71 /// \param theWidget the model widget
72 void activateNextWidget(ModuleBase_ModelWidget* theWidget);
75 /// Sets the current operation or NULL
76 /// \param theOperation the started operation
77 /// \param isCheckBeforeStart the flag whether to check whether the operation can be started
78 /// \return the state whether the operation is resumed
79 void resumeOperation(ModuleBase_Operation* theOperation);
81 /// Returns whether the operation can be started. Check if there is already started operation and
82 /// the granted parameter of the launched operation
83 /// \param theOperation an operation to check
84 bool canStartOperation(ModuleBase_Operation* theOperation);
86 /// Returns whether the operation can be stopped.
87 bool canStopOperation();
89 /// Returns true if the operation can be aborted
90 bool canAbortOperation();
92 void validateOperation(ModuleBase_Operation* theOperation);
95 /// Slot that commits the current operation.
96 void onCommitOperation();
97 /// Slot that aborts the current operation.
98 void onAbortOperation();
100 /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
101 /// If there is a suspended operation, restart it.
102 void onOperationStopped();
104 /// SLOT, that is called by the key in the property panel is clicked.
105 /// \param theName the attribute name
106 /// \param theEvent the mouse event
107 void onKeyReleased(const std::string& theName, QKeyEvent* theEvent);
109 /// SLOT, that reacts to the widget activation
110 /// \param theWidget an activated widget
111 void onWidgetActivated(ModuleBase_ModelWidget* theWidget);
114 typedef QList<ModuleBase_Operation*> Operations; ///< definition for a list of operations
115 Operations myOperations; ///< a stack of started operations. The active operation is on top,
116 // others are suspended and started by the active is finished