#include "XGUI.h"
#include <ModuleBase_Operation.h>
+#include "ModelAPI_Feature.h"
#include <QList>
#include <QObject>
class QKeyEvent;
+class ModuleBase_IWorkshop;
+class XGUI_Workshop;
+
/**\class XGUI_OperationMgr
* \ingroup GUI
* \brief Operation manager. Servers to manipulate to the workshop operations. Contains a stack
public:
/// Constructor
/// \param theParent the parent
- XGUI_OperationMgr(QObject* theParent);
+ /// \param theWorkshop a reference to workshop
+ XGUI_OperationMgr(QObject* theParent, ModuleBase_IWorkshop* theWorkshop);
+
/// Destructor
virtual ~XGUI_OperationMgr();
+ /// Set reference to workshop
+ /// \param theWorkshop reference to workshop
+ void setWorkshop(ModuleBase_IWorkshop* theWorkshop)
+ { myWorkshop = theWorkshop; };
+
/// Returns the current operation or NULL
/// \return the current operation
ModuleBase_Operation* currentOperation() const;
/// Returns true is operation manager has an operation with given Id.
bool hasOperation(const QString& theId) const;
+ /// Returns true if the operation can be aborted. If the operation is modified,
+ /// the warning message box is shown.
+ /// \param theOperation an operation which is checked on stop
+ bool canStopOperation(ModuleBase_Operation* theOperation);
+
/// Find and return operation by its Id.
ModuleBase_Operation* findOperation(const QString& theId) const;
/// else, or if there is no parent - returns NULL
ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
+ /// Redefinition of virtual function
virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
/// Start the operation and append it to the stack of operations
/// \return the state whether the current operation is started
bool startOperation(ModuleBase_Operation* theOperation);
- bool abortAllOperations();
-
/// Returns whether the operation can be started. Check if there is already started operation and
/// the granted parameter of the launched operation
/// \param theId id of the operation which is going to start
- bool canStartOperation(QString theId);
+ /// \param isAdditionallyGranted a boolean flag whether the id operation is granted in the previous one
+ bool canStartOperation(const QString& theId, const bool isAdditionallyGranted = false);
+
+ /// Aborts the parameter operation if it is current, else abort operations from the stack
+ /// of operations until the operation is found. All operations upper the parameter one are
+ /// not aborted.
+ /// \param theOperation an aborted operation
+ void abortOperation(ModuleBase_Operation* theOperation);
/// Blocking/unblocking enabling of Ok button in property panel.
/// It is used when operation can not be validated even all attributes are valid
- void setLockValidating(bool toLock) { myIsValidationLock = toLock; }
+ void setLockValidating(bool toLock);
/// Returns state of validation locking
bool isValidationLocked() const { return myIsValidationLock; }
- /// Sets apply state to the value and emit signal about this state is changed
- /// \param theEnabled the state value
- void setApplyEnabled(const bool theEnabled);
-
/// Returns enable apply state
/// \return theEnabled a boolean value
bool isApplyEnabled() const;
- public slots:
+ /// Returns valid state of the parent operation. If the current operation is the last one
+ /// it returns the valid state of the operation
+ /// \return boolean value
+ bool isParentOperationValid() const;
+
+public slots:
/// Slot that commits the current operation.
void onCommitOperation();
/// Slot that aborts the current operation.
void onAbortOperation();
/// Slot that validates the current operation using the validateOperation method.
void onValidateOperation();
+ /// Commit all operations
+ bool commitAllOperations();
+ /// Abort all operations
+ bool abortAllOperations();
signals:
/// Signal about an operation is started. It is emitted after the start() of operation is done.
/// Emitted when current operation is aborted
void operationAborted(ModuleBase_Operation* theOperation);
- /// Signal is emitted after the apply enable state changed.
- void applyEnableChanged(bool);
-
/// Signal is emitted after the current operation is filled with existing preselection.
void operationActivatedByPreselection();
/// Signal is emitted after the key released click.
void keyEnterReleased();
-
protected:
- /// Returns true if the operation can be aborted
- bool canStopOperation();
+ /// Sets apply state to the value and emit signal about this state is changed
+ /// \param theEnabled the state value
+ void setApplyEnabled(const bool theEnabled);
+
+public: // TEMPORARY, it should be protected and be performed automatically
+ /// Emits nestedStateChange for operations with an information about validity of the operation
+ /// \param theOperation the sent operation. If it is NULL, all operations in the stack are sent.
+ void updateApplyOfOperations(ModuleBase_Operation* theOperation = 0);
/// Commits the current operatin if it is valid
bool commitOperation();
+
+protected: // TEMPORARY
/// Sets the current operation or NULL
/// \param theOperation the started operation
- /// \param isCheckBeforeStart the flag whether to check whether the operation can be started
- /// \return the state whether the operation is resumed
void resumeOperation(ModuleBase_Operation* theOperation);
+ /// Returns whether the parameter operation is granted in relation to the previous operation
+ /// in a stack of started operations. It is used in canStopOperation to avoid warning message
+ /// when granted operation is aborted, e.g. SketchLine in Sketch
+ /// \param theId id of the operation which is checked
+ /// \return boolean result
+ bool isGrantedOperation(const QString& theId);
+
+ /// Sets the feature as a current in the document
+ /// \param theFeature a feature
+ void setCurrentFeature(const FeaturePtr& theFeature);
+
public slots:
/// SLOT, that is called by the key in the property panel is clicked.
- /// \param theName the attribute name
/// \param theEvent the mouse event
bool onKeyReleased(QKeyEvent* theEvent);
/// Slot that is called by an operation stop. Removes the stopped operation form the stack.
/// If there is a suspended operation, restart it.
void onOperationStopped();
+
+ /// Slot called before operation started. Stores the previous current feature, set the feature
+ /// of the operation as a current in the document. The previous current feature should be restored
+ /// by the operation abort/commit
+ void onBeforeOperationStarted();
+
+ /// Slot called after operation started
void onOperationStarted();
+
+ /// Slot called before operation aborted. Restore the previous current operation
+ void onBeforeOperationAborted();
+
+ /// Slot called after operation aborted
void onOperationAborted();
+
+ /// Slot called before operation committed. Restore the previous current operation
+ void onBeforeOperationCommitted();
+
+ /// Slot called after operation committed
void onOperationCommitted();
+
+ /// Slot called on operation resume
void onOperationResumed();
+private:
+ XGUI_Workshop* workshop() const;
+
private:
typedef QList<ModuleBase_Operation*> Operations; ///< definition for a list of operations
Operations myOperations; ///< a stack of started operations. The active operation is on top,
// others are suspended and started by the active is finished
+ /// Current workshop
+ ModuleBase_IWorkshop* myWorkshop;
+
/// Lock/Unlock access to Ok button in property panel
bool myIsValidationLock;
/// Lock/Unlock access to Ok button in property panel
