1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef XGUI_OperationMgr_H
22 #define XGUI_OperationMgr_H
26 #include <ModuleBase_Operation.h>
27 #include "ModelAPI_Feature.h"
31 #include <QStringList>
36 class ModuleBase_IWorkshop;
38 class XGUI_ShortCutListener;
40 /**\class XGUI_OperationMgr
42 * \brief Operation manager. Servers to manipulate to the workshop operations. Contains a stack
43 * of started operations. In simple case, if only one operation is started, the stack contains
44 * one operation. It is possible for some kind of operations to start them above already
45 * started one. In that case, the previous active operation becomes suspended, a new one - active.
46 * The new operation is added to the top of the stack. Then it is finished, it is removed from
47 * the stack and the previous operation is activated.
49 class XGUI_EXPORT XGUI_OperationMgr : public QObject
53 /// Enumeration of kind of message that is used when trying to stop the active operation
56 XGUI_AbortOperationMessage, //< warns and give possibility to abort current operation
57 XGUI_InformationMessage //< ask to apply the current operation before performing something
62 /// \param theParent the parent
63 /// \param theWorkshop a reference to workshop
64 XGUI_OperationMgr(QObject* theParent, ModuleBase_IWorkshop* theWorkshop);
67 virtual ~XGUI_OperationMgr();
69 /// Switch on short cut listener
71 /// Switch off short cut listener
74 /// Set reference to workshop
75 /// \param theWorkshop reference to workshop
76 void setWorkshop(ModuleBase_IWorkshop* theWorkshop)
77 { myWorkshop = theWorkshop; };
80 ModuleBase_IWorkshop* workshop() const { return myWorkshop; }
82 /// Returns the current operation or NULL
83 /// \return the current operation
84 ModuleBase_Operation* currentOperation() const;
86 /// Check if the given operation is active operation.
87 /// Also, returns false is ther is no active operation.
88 bool isCurrentOperation(ModuleBase_Operation* theOperation);
90 /// Returns true is operation manager has at least one non-null operation.
91 bool hasOperation() const;
93 /// Returns true is operation manager has an operation with given Id.
94 bool hasOperation(const QString& theId) const;
96 /// Returns true if the operation can be aborted. If the operation is modified,
97 /// the warning message box is shown.
98 /// \param theOperation an operation which is checked on stop
99 /// \param theMessageKind a kind of message in warning message box
100 bool canStopOperation(ModuleBase_Operation* theOperation,
101 const XGUI_MessageKind& theMessageKind = XGUI_AbortOperationMessage);
103 /// Find and return operation by its Id.
104 ModuleBase_Operation* findOperation(const QString& theId) const;
106 /// Returns number of operations in the stack
107 int operationsCount() const;
109 /// Returns list of all operations IDs
110 QStringList operationList() const;
112 /// Returns previous (parent) operation if given operation started.
113 /// else, or if there is no parent - returns NULL
114 ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
116 /// Start the operation and append it to the stack of operations
117 /// \param theOperation the started operation
118 /// \return the state whether the current operation is started
119 bool startOperation(ModuleBase_Operation* theOperation);
121 /// Returns whether the operation can be started. Check if there is already started operation and
122 /// the granted parameter of the launched operation
123 /// \param theId id of the operation which is going to start
124 /// \param isCommitted boolean value if the operation was committed otherwise it was aborted
125 bool canStartOperation(const QString& theId, bool& isCommitted);
127 /// If Apply is enabled and operation has modification, it is applyed, otherwise aborted
128 /// \param theOperation the started operation
129 /// \param isCommitted boolean value if the operation was committed otherwise it was aborted
130 void stopOperation(ModuleBase_Operation* theOperation, bool& isCommitted);
132 /// Aborts the parameter operation if it is current, else abort operations from the stack
133 /// of operations until the operation is found. All operations upper the parameter one are
135 /// \param theOperation an aborted operation
136 void abortOperation(ModuleBase_Operation* theOperation);
138 /// Abort all operations
139 /// \param theMessageKind kind of shown warning message
140 bool abortAllOperations(const XGUI_MessageKind& theMessageKind = XGUI_AbortOperationMessage);
142 /// Commits the current operation.
143 bool commitOperation();
145 /// Returns true if SHIFT is pressed
146 /// \param thePressed new boolean state
147 void setSHIFTPressed(const bool thePressed) { mySHIFTPressed = thePressed; }
149 /// Returns true if SHIFT is pressed
150 /// \return boolean value
151 bool hasSHIFTPressed() const { return mySHIFTPressed; }
154 /// Slot that aborts the current operation.
155 void onAbortOperation();
156 /// Slot that aborts all operations. It shows aborting message
157 void onAbortAllOperation();
158 /// Slot that validates the current operation using the validateOperation method.
159 void onValidateOperation();
160 /// Commit all operations
161 bool commitAllOperations();
164 /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
165 /// \param theOperation a stopped operation
166 void operationStopped(ModuleBase_Operation* theOperation);
168 /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
169 void operationResumed(ModuleBase_Operation* theOperation);
171 /// Emitted when current operation is Committed
172 void operationCommitted(ModuleBase_Operation* theOperation);
174 /// Emitted when current operation is aborted
175 void operationAborted(ModuleBase_Operation* theOperation);
177 /// Signal is emitted after the key released click.
178 void keyEnterReleased();
180 public: // TEMPORARY, it should be protected and be performed automatically
181 /// Emits nestedStateChange for operations with an information about validity of the operation
182 /// \param theOperation the sent operation. If it is NULL, all operations in the stack are sent.
183 void updateApplyOfOperations(ModuleBase_Operation* theOperation = 0);
185 protected: // TEMPORARY
186 /// Sets the current operation or NULL
187 /// \param theOperation the started operation
188 void resumeOperation(ModuleBase_Operation* theOperation);
190 /// Returns whether the parameter operation is granted in relation to the previous operation
191 /// in a stack of started operations. It is used in canStopOperation to avoid warning message
192 /// when granted operation is aborted, e.g. SketchLine in Sketch
193 /// \param theId id of the operation which is checked
194 /// \return boolean result
195 bool isGrantedOperation(const QString& theId);
197 /// Sets the feature as a current in the document
198 /// \param theFeature a feature
199 void setCurrentFeature(const FeaturePtr& theFeature);
202 /// SLOT, that is called by the key in the property panel is clicked.
203 /// \param theObject a sender of the event
204 /// \param theEvent the mouse event
205 bool onKeyReleased(QObject *theObject, QKeyEvent* theEvent);
207 /// SLOT, that is called by the key in the property panel is clicked.
208 /// \param theObject a sender of the event
209 /// \param theEvent the mouse event
210 bool onKeyPressed(QObject *theObject, QKeyEvent* theEvent);
212 /// The functionaly, that should be done by delete click
213 /// Fistly the active widget processes it, then workshop. If no one does not
214 /// process it, do nothing
215 /// \param theObject a sender of the event
216 bool onProcessDelete(QObject* theObject);
219 /// The functionaly, that should be done by enter click
220 /// Fistly the active widget processes it, then module. If no one does not
221 /// process it, the current operation is committed
222 /// \param theObject a sender of the event
223 bool onProcessEnter(QObject *theObject);
225 /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
226 /// If there is a suspended operation, restart it.
227 void onOperationStopped();
229 /// Slot called before operation started. Stores the previous current feature, set the feature
230 /// of the operation as a current in the document. The previous current feature should be restored
231 /// by the operation abort/commit
232 void onBeforeOperationStarted();
234 /// Slot called after operation started
235 void onOperationStarted();
237 /// Slot called before operation aborted. Restore the previous current operation
238 void onBeforeOperationAborted();
240 /// Slot called after operation aborted
241 void onOperationAborted();
243 /// Slot called before operation committed. Restore the previous current operation
244 void onBeforeOperationCommitted();
246 /// Slot called after operation committed
247 void onOperationCommitted();
249 /// Slot called on operation resume
250 void onOperationResumed();
253 /// Checks if the object is a parent or a child under
254 /// \param theObject an investivated object
255 /// \param theParent a candidate to be a parent
256 static bool isChildObject(const QObject* theObject, const QObject* theParent);
258 /// Creates question message box with OK/Cancel buttons, where Cancel is default button,
259 /// Escape is Null button
260 /// \param theMessage text of the message
261 /// \return message box
262 static QMessageBox* createMessageBox(const QString& theMessage);
265 typedef QList<ModuleBase_Operation*> Operations; ///< definition for a list of operations
266 Operations myOperations; ///< a stack of started operations. The active operation is on top,
267 // others are suspended and started by the active is finished
270 ModuleBase_IWorkshop* myWorkshop;
271 QMessageBox* myActiveMessageBox;
272 XGUI_ShortCutListener* myShortCutListener;