1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: XGUI_OperationMgr.h
4 // Created: 20 Apr 2014
5 // Author: Natalia ERMOLAEVA
7 #ifndef XGUI_OperationMgr_H
8 #define XGUI_OperationMgr_H
12 #include <ModuleBase_Operation.h>
13 #include "ModelAPI_Feature.h"
17 #include <QStringList>
21 class ModuleBase_IWorkshop;
24 /**\class XGUI_OperationMgr
26 * \brief Operation manager. Servers to manipulate to the workshop operations. Contains a stack
27 * of started operations. In simple case, if only one operation is started, the stack contains
28 * one operation. It is possible for some kind of operations to start them above already
29 * started one. In that case, the previous active operation becomes suspended, a new one - active.
30 * The new operation is added to the top of the stack. Then it is finished, it is removed from
31 * the stack and the previous operation is activated.
33 class XGUI_EXPORT XGUI_OperationMgr : public QObject
38 /// \param theParent the parent
39 /// \param theWorkshop a reference to workshop
40 XGUI_OperationMgr(QObject* theParent, ModuleBase_IWorkshop* theWorkshop);
43 virtual ~XGUI_OperationMgr();
45 /// Set reference to workshop
46 /// \param theWorkshop reference to workshop
47 void setWorkshop(ModuleBase_IWorkshop* theWorkshop)
48 { myWorkshop = theWorkshop; };
50 /// Returns the current operation or NULL
51 /// \return the current operation
52 ModuleBase_Operation* currentOperation() const;
54 /// Check if the given operation is active operation.
55 /// Also, returns false is ther is no active operation.
56 bool isCurrentOperation(ModuleBase_Operation* theOperation);
58 /// Returns true is operation manager has at least one non-null operation.
59 bool hasOperation() const;
61 /// Returns true is operation manager has an operation with given Id.
62 bool hasOperation(const QString& theId) const;
64 /// Returns true if the operation can be aborted. If the operation is modified,
65 /// the warning message box is shown.
66 /// \param theOperation an operation which is checked on stop
67 bool canStopOperation(ModuleBase_Operation* theOperation);
69 /// Find and return operation by its Id.
70 ModuleBase_Operation* findOperation(const QString& theId) const;
72 /// Returns number of operations in the stack
73 int operationsCount() const;
75 /// Returns list of all operations IDs
76 QStringList operationList() const;
78 /// Returns previous (parent) operation if given operation started.
79 /// else, or if there is no parent - returns NULL
80 ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
82 /// Redefinition of virtual function
83 virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
85 /// Start the operation and append it to the stack of operations
86 /// \param theOperation the started operation
87 /// \return the state whether the current operation is started
88 bool startOperation(ModuleBase_Operation* theOperation);
90 /// Returns whether the operation can be started. Check if there is already started operation and
91 /// the granted parameter of the launched operation
92 /// \param theId id of the operation which is going to start
93 bool canStartOperation(const QString& theId);
95 /// Aborts the parameter operation if it is current, else abort operations from the stack
96 /// of operations until the operation is found. All operations upper the parameter one are
98 /// \param theOperation an aborted operation
99 void abortOperation(ModuleBase_Operation* theOperation);
102 /// Slot that commits the current operation.
103 void onCommitOperation();
104 /// Slot that aborts the current operation.
105 void onAbortOperation();
106 /// Slot that validates the current operation using the validateOperation method.
107 void onValidateOperation();
108 /// Commit all operations
109 bool commitAllOperations();
110 /// Abort all operations
111 bool abortAllOperations();
114 /// Signal about an operation is started. It is emitted after the start() of operation is done.
115 void operationStarted(ModuleBase_Operation* theOperation);
117 /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
118 /// \param theOperation a stopped operation
119 void operationStopped(ModuleBase_Operation* theOperation);
121 /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
122 void operationResumed(ModuleBase_Operation* theOperation);
124 /// Emitted when current operation is Committed
125 void operationCommitted(ModuleBase_Operation* theOperation);
127 /// Emitted when current operation is aborted
128 void operationAborted(ModuleBase_Operation* theOperation);
130 /// Signal is emitted after the current operation is filled with existing preselection.
131 void operationActivatedByPreselection();
133 /// Signal is emitted after the key released click.
134 void keyEnterReleased();
136 public: // TEMPORARY, it should be protected and be performed automatically
137 /// Emits nestedStateChange for operations with an information about validity of the operation
138 /// \param theOperation the sent operation. If it is NULL, all operations in the stack are sent.
139 void updateApplyOfOperations(ModuleBase_Operation* theOperation = 0);
141 /// Commits the current operatin if it is valid
142 bool commitOperation();
144 protected: // TEMPORARY
145 /// Sets the current operation or NULL
146 /// \param theOperation the started operation
147 void resumeOperation(ModuleBase_Operation* theOperation);
149 /// Returns whether the parameter operation is granted in relation to the previous operation
150 /// in a stack of started operations. It is used in canStopOperation to avoid warning message
151 /// when granted operation is aborted, e.g. SketchLine in Sketch
152 /// \param theId id of the operation which is checked
153 /// \return boolean result
154 bool isGrantedOperation(const QString& theId);
156 /// Sets the feature as a current in the document
157 /// \param theFeature a feature
158 void setCurrentFeature(const FeaturePtr& theFeature);
161 /// SLOT, that is called by the key in the property panel is clicked.
162 /// \param theEvent the mouse event
163 bool onKeyReleased(QKeyEvent* theEvent);
165 /// The functionaly, that should be done by delete click
166 /// Fistly the active widget processes it, then workshop. If no one does not
167 /// process it, do nothing
168 bool onProcessDelete();
171 /// The functionaly, that should be done by enter click
172 /// Fistly the active widget processes it, then module. If no one does not
173 /// process it, the current operation is committed
174 bool onProcessEnter();
176 /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
177 /// If there is a suspended operation, restart it.
178 void onOperationStopped();
180 /// Slot called before operation started. Stores the previous current feature, set the feature
181 /// of the operation as a current in the document. The previous current feature should be restored
182 /// by the operation abort/commit
183 void onBeforeOperationStarted();
185 /// Slot called after operation started
186 void onOperationStarted();
188 /// Slot called before operation aborted. Restore the previous current operation
189 void onBeforeOperationAborted();
191 /// Slot called after operation aborted
192 void onOperationAborted();
194 /// Slot called before operation committed. Restore the previous current operation
195 void onBeforeOperationCommitted();
197 /// Slot called after operation committed
198 void onOperationCommitted();
200 /// Slot called on operation resume
201 void onOperationResumed();
204 XGUI_Workshop* workshop() const;
207 typedef QList<ModuleBase_Operation*> Operations; ///< definition for a list of operations
208 Operations myOperations; ///< a stack of started operations. The active operation is on top,
209 // others are suspended and started by the active is finished
212 ModuleBase_IWorkshop* myWorkshop;