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;
23 class XGUI_ShortCutListener;
25 /**\class XGUI_OperationMgr
27 * \brief Operation manager. Servers to manipulate to the workshop operations. Contains a stack
28 * of started operations. In simple case, if only one operation is started, the stack contains
29 * one operation. It is possible for some kind of operations to start them above already
30 * started one. In that case, the previous active operation becomes suspended, a new one - active.
31 * The new operation is added to the top of the stack. Then it is finished, it is removed from
32 * the stack and the previous operation is activated.
34 class XGUI_EXPORT XGUI_OperationMgr : public QObject
39 /// \param theParent the parent
40 /// \param theWorkshop a reference to workshop
41 XGUI_OperationMgr(QObject* theParent, ModuleBase_IWorkshop* theWorkshop);
44 virtual ~XGUI_OperationMgr();
46 /// Switch on short cut listener
48 /// Switch off short cut listener
51 /// Set reference to workshop
52 /// \param theWorkshop reference to workshop
53 void setWorkshop(ModuleBase_IWorkshop* theWorkshop)
54 { myWorkshop = theWorkshop; };
56 /// Returns the current operation or NULL
57 /// \return the current operation
58 ModuleBase_Operation* currentOperation() const;
60 /// Check if the given operation is active operation.
61 /// Also, returns false is ther is no active operation.
62 bool isCurrentOperation(ModuleBase_Operation* theOperation);
64 /// Returns true is operation manager has at least one non-null operation.
65 bool hasOperation() const;
67 /// Returns true is operation manager has an operation with given Id.
68 bool hasOperation(const QString& theId) const;
70 /// Returns true if the operation can be aborted. If the operation is modified,
71 /// the warning message box is shown.
72 /// \param theOperation an operation which is checked on stop
73 bool canStopOperation(ModuleBase_Operation* theOperation);
75 /// Find and return operation by its Id.
76 ModuleBase_Operation* findOperation(const QString& theId) const;
78 /// Returns number of operations in the stack
79 int operationsCount() const;
81 /// Returns list of all operations IDs
82 QStringList operationList() const;
84 /// Returns previous (parent) operation if given operation started.
85 /// else, or if there is no parent - returns NULL
86 ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
88 /// Redefinition of virtual function
89 /// \param theObject a sender of the event
90 virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
92 /// Start the operation and append it to the stack of operations
93 /// \param theOperation the started operation
94 /// \return the state whether the current operation is started
95 bool startOperation(ModuleBase_Operation* theOperation);
97 /// Returns whether the operation can be started. Check if there is already started operation and
98 /// the granted parameter of the launched operation
99 /// \param theId id of the operation which is going to start
100 bool canStartOperation(const QString& theId);
102 /// Aborts the parameter operation if it is current, else abort operations from the stack
103 /// of operations until the operation is found. All operations upper the parameter one are
105 /// \param theOperation an aborted operation
106 void abortOperation(ModuleBase_Operation* theOperation);
109 /// Slot that commits the current operation.
110 void onCommitOperation();
111 /// Slot that aborts the current operation.
112 void onAbortOperation();
113 /// Slot that validates the current operation using the validateOperation method.
114 void onValidateOperation();
115 /// Commit all operations
116 bool commitAllOperations();
117 /// Abort all operations
118 bool abortAllOperations();
121 /// Signal about an operation is started. It is emitted after the start() of operation is done.
122 void operationStarted(ModuleBase_Operation* theOperation);
124 /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
125 /// \param theOperation a stopped operation
126 void operationStopped(ModuleBase_Operation* theOperation);
128 /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
129 void operationResumed(ModuleBase_Operation* theOperation);
131 /// Emitted when current operation is Committed
132 void operationCommitted(ModuleBase_Operation* theOperation);
134 /// Emitted when current operation is aborted
135 void operationAborted(ModuleBase_Operation* theOperation);
137 /// Signal is emitted after the key released click.
138 void keyEnterReleased();
140 public: // TEMPORARY, it should be protected and be performed automatically
141 /// Emits nestedStateChange for operations with an information about validity of the operation
142 /// \param theOperation the sent operation. If it is NULL, all operations in the stack are sent.
143 void updateApplyOfOperations(ModuleBase_Operation* theOperation = 0);
145 /// Commits the current operatin if it is valid
146 bool commitOperation();
148 protected: // TEMPORARY
149 /// Sets the current operation or NULL
150 /// \param theOperation the started operation
151 void resumeOperation(ModuleBase_Operation* theOperation);
153 /// Returns whether the parameter operation is granted in relation to the previous operation
154 /// in a stack of started operations. It is used in canStopOperation to avoid warning message
155 /// when granted operation is aborted, e.g. SketchLine in Sketch
156 /// \param theId id of the operation which is checked
157 /// \return boolean result
158 bool isGrantedOperation(const QString& theId);
160 /// Sets the feature as a current in the document
161 /// \param theFeature a feature
162 void setCurrentFeature(const FeaturePtr& theFeature);
165 /// SLOT, that is called by the key in the property panel is clicked.
166 /// \param theObject a sender of the event
167 /// \param theEvent the mouse event
168 bool onKeyReleased(QObject *theObject, QKeyEvent* theEvent);
170 /// The functionaly, that should be done by delete click
171 /// Fistly the active widget processes it, then workshop. If no one does not
172 /// process it, do nothing
173 /// \param theObject a sender of the event
174 bool onProcessDelete(QObject* theObject);
177 /// The functionaly, that should be done by enter click
178 /// Fistly the active widget processes it, then module. If no one does not
179 /// process it, the current operation is committed
180 /// \param theObject a sender of the event
181 bool onProcessEnter(QObject *theObject);
183 /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
184 /// If there is a suspended operation, restart it.
185 void onOperationStopped();
187 /// Slot called before operation started. Stores the previous current feature, set the feature
188 /// of the operation as a current in the document. The previous current feature should be restored
189 /// by the operation abort/commit
190 void onBeforeOperationStarted();
192 /// Slot called after operation started
193 void onOperationStarted();
195 /// Slot called before operation aborted. Restore the previous current operation
196 void onBeforeOperationAborted();
198 /// Slot called after operation aborted
199 void onOperationAborted();
201 /// Slot called before operation committed. Restore the previous current operation
202 void onBeforeOperationCommitted();
204 /// Slot called after operation committed
205 void onOperationCommitted();
207 /// Slot called on operation resume
208 void onOperationResumed();
211 XGUI_Workshop* workshop() const;
213 /// Checks if the object is a parent or a child under
214 /// \param theObject an investivated object
215 /// \param theParent a candidate to be a parent
216 static bool isChildObject(const QObject* theObject, const QObject* theParent);
219 typedef QList<ModuleBase_Operation*> Operations; ///< definition for a list of operations
220 Operations myOperations; ///< a stack of started operations. The active operation is on top,
221 // others are suspended and started by the active is finished
224 ModuleBase_IWorkshop* myWorkshop;
226 XGUI_ShortCutListener* myShortCutListener;