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);
101 /// Blocking/unblocking enabling of Ok button in property panel.
102 /// It is used when operation can not be validated even all attributes are valid
103 void setLockValidating(bool toLock);
105 /// Returns state of validation locking
106 bool isValidationLocked() const { return myIsValidationLock; }
108 /// Returns enable apply state
109 /// \return theEnabled a boolean value
110 bool isApplyEnabled() const;
112 /// Returns valid state of the parent operation. If the current operation is the last one
113 /// it returns the valid state of the operation
114 /// \return boolean value
115 bool isParentOperationValid() const;
118 /// Slot that commits the current operation.
119 void onCommitOperation();
120 /// Slot that aborts the current operation.
121 void onAbortOperation();
122 /// Slot that validates the current operation using the validateOperation method.
123 void onValidateOperation();
124 /// Commit all operations
125 bool commitAllOperations();
126 /// Abort all operations
127 bool abortAllOperations();
130 /// Signal about an operation is started. It is emitted after the start() of operation is done.
131 void operationStarted(ModuleBase_Operation* theOperation);
133 /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
134 /// \param theOperation a stopped operation
135 void operationStopped(ModuleBase_Operation* theOperation);
137 /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
138 void operationResumed(ModuleBase_Operation* theOperation);
140 /// Emitted when current operation is Committed
141 void operationCommitted(ModuleBase_Operation* theOperation);
143 /// Emitted when current operation is aborted
144 void operationAborted(ModuleBase_Operation* theOperation);
146 /// Signal is emitted after the current operation is filled with existing preselection.
147 void operationActivatedByPreselection();
149 /// Signal is emitted after the key released click.
150 void keyEnterReleased();
153 /// Sets apply state to the value and emit signal about this state is changed
154 /// \param theEnabled the state value
155 void setApplyEnabled(const bool theEnabled);
157 public: // TEMPORARY, it should be protected and be performed automatically
158 /// Emits nestedStateChange for operations with an information about validity of the operation
159 /// \param theOperation the sent operation. If it is NULL, all operations in the stack are sent.
160 void updateApplyOfOperations(ModuleBase_Operation* theOperation = 0);
162 /// Commits the current operatin if it is valid
163 bool commitOperation();
165 protected: // TEMPORARY
166 /// Sets the current operation or NULL
167 /// \param theOperation the started operation
168 void resumeOperation(ModuleBase_Operation* theOperation);
170 /// Returns whether the parameter operation is granted in relation to the previous operation
171 /// in a stack of started operations. It is used in canStopOperation to avoid warning message
172 /// when granted operation is aborted, e.g. SketchLine in Sketch
173 /// \param theId id of the operation which is checked
174 /// \return boolean result
175 bool isGrantedOperation(const QString& theId);
177 /// Sets the feature as a current in the document
178 /// \param theFeature a feature
179 void setCurrentFeature(const FeaturePtr& theFeature);
182 /// SLOT, that is called by the key in the property panel is clicked.
183 /// \param theEvent the mouse event
184 bool onKeyReleased(QKeyEvent* theEvent);
187 /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
188 /// If there is a suspended operation, restart it.
189 void onOperationStopped();
191 /// Slot called before operation started. Stores the previous current feature, set the feature
192 /// of the operation as a current in the document. The previous current feature should be restored
193 /// by the operation abort/commit
194 void onBeforeOperationStarted();
196 /// Slot called after operation started
197 void onOperationStarted();
199 /// Slot called before operation aborted. Restore the previous current operation
200 void onBeforeOperationAborted();
202 /// Slot called after operation aborted
203 void onOperationAborted();
205 /// Slot called before operation committed. Restore the previous current operation
206 void onBeforeOperationCommitted();
208 /// Slot called after operation committed
209 void onOperationCommitted();
211 /// Slot called on operation resume
212 void onOperationResumed();
215 XGUI_Workshop* workshop() const;
218 typedef QList<ModuleBase_Operation*> Operations; ///< definition for a list of operations
219 Operations myOperations; ///< a stack of started operations. The active operation is on top,
220 // others are suspended and started by the active is finished
223 ModuleBase_IWorkshop* myWorkshop;
225 /// Lock/Unlock access to Ok button in property panel
226 bool myIsValidationLock;
227 /// Lock/Unlock access to Ok button in property panel
228 bool myIsApplyEnabled;