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>
35 class ModuleBase_IWorkshop;
37 class XGUI_ShortCutListener;
39 /**\class XGUI_OperationMgr
41 * \brief Operation manager. Servers to manipulate to the workshop operations. Contains a stack
42 * of started operations. In simple case, if only one operation is started, the stack contains
43 * one operation. It is possible for some kind of operations to start them above already
44 * started one. In that case, the previous active operation becomes suspended, a new one - active.
45 * The new operation is added to the top of the stack. Then it is finished, it is removed from
46 * the stack and the previous operation is activated.
48 class XGUI_EXPORT XGUI_OperationMgr : public QObject
52 /// Enumeration of kind of message that is used when trying to stop the active operation
55 XGUI_AbortOperationMessage, //< warns and give possibility to abort current operation
56 XGUI_InformationMessage //< ask to apply the current operation before performing something
61 /// \param theParent the parent
62 /// \param theWorkshop a reference to workshop
63 XGUI_OperationMgr(QObject* theParent, ModuleBase_IWorkshop* theWorkshop);
66 virtual ~XGUI_OperationMgr();
68 /// Switch on short cut listener
70 /// Switch off short cut listener
73 /// Set reference to workshop
74 /// \param theWorkshop reference to workshop
75 void setWorkshop(ModuleBase_IWorkshop* theWorkshop)
76 { myWorkshop = theWorkshop; };
79 ModuleBase_IWorkshop* workshop() const { return myWorkshop; }
81 /// Returns the current operation or NULL
82 /// \return the current operation
83 ModuleBase_Operation* currentOperation() const;
85 /// Check if the given operation is active operation.
86 /// Also, returns false is ther is no active operation.
87 bool isCurrentOperation(ModuleBase_Operation* theOperation);
89 /// Returns true is operation manager has at least one non-null operation.
90 bool hasOperation() const;
92 /// Returns true is operation manager has an operation with given Id.
93 bool hasOperation(const QString& theId) const;
95 /// Returns true if the operation can be aborted. If the operation is modified,
96 /// the warning message box is shown.
97 /// \param theOperation an operation which is checked on stop
98 /// \param theMessageKind a kind of message in warning message box
99 bool canStopOperation(ModuleBase_Operation* theOperation,
100 const XGUI_MessageKind& theMessageKind = XGUI_AbortOperationMessage);
102 /// Find and return operation by its Id.
103 ModuleBase_Operation* findOperation(const QString& theId) const;
105 /// Returns number of operations in the stack
106 int operationsCount() const;
108 /// Returns list of all operations IDs
109 QStringList operationList() const;
111 /// Returns previous (parent) operation if given operation started.
112 /// else, or if there is no parent - returns NULL
113 ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
115 /// Start the operation and append it to the stack of operations
116 /// \param theOperation the started operation
117 /// \return the state whether the current operation is started
118 bool startOperation(ModuleBase_Operation* theOperation);
120 /// Returns whether the operation can be started. Check if there is already started operation and
121 /// the granted parameter of the launched operation
122 /// \param theId id of the operation which is going to start
123 /// \param isCommitted boolean value if the operation was committed otherwise it was aborted
124 bool canStartOperation(const QString& theId, bool& isCommitted);
126 /// If Apply is enabled and operation has modification, it is applyed, otherwise aborted
127 /// \param theOperation the started operation
128 /// \param isCommitted boolean value if the operation was committed otherwise it was aborted
129 void stopOperation(ModuleBase_Operation* theOperation, bool& isCommitted);
131 /// Aborts the parameter operation if it is current, else abort operations from the stack
132 /// of operations until the operation is found. All operations upper the parameter one are
134 /// \param theOperation an aborted operation
135 void abortOperation(ModuleBase_Operation* theOperation);
137 /// Abort all operations
138 /// \param theMessageKind kind of shown warning message
139 bool abortAllOperations(const XGUI_MessageKind& theMessageKind = XGUI_AbortOperationMessage);
141 /// Commits the current operation.
142 bool commitOperation();
144 /// Returns true if SHIFT is pressed
145 /// \param thePressed new boolean state
146 void setSHIFTPressed(const bool thePressed) { mySHIFTPressed = thePressed; }
148 /// Returns true if SHIFT is pressed
149 /// \return boolean value
150 bool hasSHIFTPressed() const { return mySHIFTPressed; }
153 /// Slot that aborts the current operation.
154 void onAbortOperation();
155 /// Slot that aborts all operations. It shows aborting message
156 void onAbortAllOperation();
157 /// Slot that validates the current operation using the validateOperation method.
158 void onValidateOperation();
159 /// Commit all operations
160 bool commitAllOperations();
163 /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
164 /// \param theOperation a stopped operation
165 void operationStopped(ModuleBase_Operation* theOperation);
167 /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
168 void operationResumed(ModuleBase_Operation* theOperation);
170 /// Emitted when current operation is Committed
171 void operationCommitted(ModuleBase_Operation* theOperation);
173 /// Emitted when current operation is aborted
174 void operationAborted(ModuleBase_Operation* theOperation);
176 /// Signal is emitted after the key released click.
177 void keyEnterReleased();
179 public: // TEMPORARY, it should be protected and be performed automatically
180 /// Emits nestedStateChange for operations with an information about validity of the operation
181 /// \param theOperation the sent operation. If it is NULL, all operations in the stack are sent.
182 void updateApplyOfOperations(ModuleBase_Operation* theOperation = 0);
184 /// Updates the current operation state after undo/redo actions calling
185 void updateOperationByUndoRedo();
187 protected: // TEMPORARY
188 /// Sets the current operation or NULL
189 /// \param theOperation the started operation
190 void resumeOperation(ModuleBase_Operation* theOperation);
192 /// Returns whether the parameter operation is granted in relation to the previous operation
193 /// in a stack of started operations. It is used in canStopOperation to avoid warning message
194 /// when granted operation is aborted, e.g. SketchLine in Sketch
195 /// \param theId id of the operation which is checked
196 /// \return boolean result
197 bool isGrantedOperation(const QString& theId);
199 /// Sets the feature as a current in the document
200 /// \param theFeature a feature
201 void setCurrentFeature(const FeaturePtr& theFeature);
204 /// SLOT, that is called by the key in the property panel is clicked.
205 /// \param theObject a sender of the event
206 /// \param theEvent the mouse event
207 bool onKeyReleased(QObject *theObject, QKeyEvent* theEvent);
209 /// The functionaly, that should be done by delete click
210 /// Fistly the active widget processes it, then workshop. If no one does not
211 /// process it, do nothing
212 /// \param theObject a sender of the event
213 bool onProcessDelete(QObject* theObject);
216 /// The functionaly, that should be done by enter click
217 /// Fistly the active widget processes it, then module. If no one does not
218 /// process it, the current operation is committed
219 /// \param theObject a sender of the event
220 bool onProcessEnter(QObject *theObject);
222 /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
223 /// If there is a suspended operation, restart it.
224 void onOperationStopped();
226 /// Slot called before operation started. Stores the previous current feature, set the feature
227 /// of the operation as a current in the document. The previous current feature should be restored
228 /// by the operation abort/commit
229 void onBeforeOperationStarted();
231 /// Slot called after operation started
232 void onOperationStarted();
234 /// Slot called before operation aborted. Restore the previous current operation
235 void onBeforeOperationAborted();
237 /// Slot called after operation aborted
238 void onOperationAborted();
240 /// Slot called before operation committed. Restore the previous current operation
241 void onBeforeOperationCommitted();
243 /// Slot called after operation committed
244 void onOperationCommitted();
246 /// Slot called on operation resume
247 void onOperationResumed();
250 /// Checks if the object is a parent or a child under
251 /// \param theObject an investivated object
252 /// \param theParent a candidate to be a parent
253 static bool isChildObject(const QObject* theObject, const QObject* theParent);
256 typedef QList<ModuleBase_Operation*> Operations; ///< definition for a list of operations
257 Operations myOperations; ///< a stack of started operations. The active operation is on top,
258 // others are suspended and started by the active is finished
261 ModuleBase_IWorkshop* myWorkshop;
263 XGUI_ShortCutListener* myShortCutListener;