X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FXGUI%2FXGUI_OperationMgr.h;h=2c7af1ef1a0c135a53f2d95105725ad2ec220e18;hb=HEAD;hp=b028731a4f3319cd6d89abf311be15ee08181d06;hpb=69147ab3e4b228b773dd84f8458e46df6028e2de;p=modules%2Fshaper.git diff --git a/src/XGUI/XGUI_OperationMgr.h b/src/XGUI/XGUI_OperationMgr.h index b028731a4..2c7af1ef1 100644 --- a/src/XGUI/XGUI_OperationMgr.h +++ b/src/XGUI/XGUI_OperationMgr.h @@ -1,6 +1,21 @@ -// File: XGUI_OperationMgr.h -// Created: 20 Apr 2014 -// Author: Natalia ERMOLAEVA +// Copyright (C) 2014-2024 CEA, EDF +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef XGUI_OperationMgr_H #define XGUI_OperationMgr_H @@ -8,12 +23,18 @@ #include "XGUI.h" #include +#include "ModelAPI_Feature.h" #include #include #include class QKeyEvent; +class QMessageBox; + +class ModuleBase_IWorkshop; +class XGUI_Workshop; +class XGUI_ShortCutListener; /**\class XGUI_OperationMgr * \ingroup GUI @@ -27,20 +48,66 @@ class QKeyEvent; class XGUI_EXPORT XGUI_OperationMgr : public QObject { Q_OBJECT - public: +public: + /// Enumeration of kind of message that is used when trying to stop the active operation + enum XGUI_MessageKind + { + XGUI_AbortOperationMessage, ///< warns and give possibility to abort current operation + XGUI_InformationMessage ///< ask to apply the current operation before performing something + }; + +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(); + /// Switch on short cut listener + void activate(); + /// Switch off short cut listener + void deactivate(); + + /// Set reference to workshop + /// \param theWorkshop reference to workshop + void setWorkshop(ModuleBase_IWorkshop* theWorkshop) + { myWorkshop = theWorkshop; }; + + /// Current workshop + ModuleBase_IWorkshop* workshop() const { return myWorkshop; } + + /// Current workshop + XGUI_Workshop* xworkshop() const; + /// Returns the current operation or NULL /// \return the current operation ModuleBase_Operation* currentOperation() const; + + /// Check if the given operation is active operation. + /// Also, returns false is ther is no active operation. + bool isCurrentOperation(ModuleBase_Operation* theOperation); + /// Returns true is operation manager has at least one non-null operation. bool hasOperation() 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 + /// \param theMessageKind a kind of message in warning message box + bool canStopOperation(ModuleBase_Operation* theOperation, + const XGUI_MessageKind& theMessageKind = XGUI_AbortOperationMessage); + + /// Find and return operation by its Id. + ModuleBase_Operation* findOperation(const QString& theId) const; + /// Returns number of operations in the stack int operationsCount() const; + /// Returns list of all operations IDs QStringList operationList() const; @@ -48,76 +115,174 @@ Q_OBJECT /// else, or if there is no parent - returns NULL ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const; - virtual bool eventFilter(QObject *theObject, QEvent *theEvent); + /// Returns an active widget of the current operation. + /// \return widget or NULL + ModuleBase_ModelWidget* activeWidget() const; /// Start the operation and append it to the stack of operations /// \param theOperation the started operation /// \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 + /// \param isCommitted boolean value if the operation was committed otherwise it was aborted + bool canStartOperation(const QString& theId, bool& isCommitted); - public slots: - /// Slot that commits the current operation. - void onCommitOperation(); + /// If Apply is enabled and operation has modification, it is applyed, otherwise aborted + /// \param theOperation the started operation + /// \param isCommitted boolean value if the operation was committed otherwise it was aborted + void stopOperation(ModuleBase_Operation* theOperation, bool& isCommitted); + + /// 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); + + /// Abort all operations + /// \param theMessageKind kind of shown warning message + bool abortAllOperations(const XGUI_MessageKind& theMessageKind = XGUI_AbortOperationMessage); + + /// Commits the current operation. + bool commitOperation(); + + /// Returns true if SHIFT is pressed + /// \param thePressed new boolean state + void setSHIFTPressed(const bool thePressed) { mySHIFTPressed = thePressed; } + + /// Returns true if SHIFT is pressed + /// \return boolean value + bool hasSHIFTPressed() const { return mySHIFTPressed; } + +public slots: /// Slot that aborts the current operation. void onAbortOperation(); + /// Slot that aborts all operations. It shows aborting message + void onAbortAllOperation(); /// Slot that validates the current operation using the validateOperation method. void onValidateOperation(); + /// Commit all operations + bool commitAllOperations(); signals: - /// Signal about an operation is started. It is emitted after the start() of operation is done. - void operationStarted(); /// Signal about an operation is stopped. It is emitted after the stop() of operation is done. /// \param theOperation a stopped operation void operationStopped(ModuleBase_Operation* theOperation); + /// Signal about an operation is resumed. It is emitted after the resume() of operation is done. - void operationResumed(); - /// Signal is emitted after the validate methods calls. - void operationValidated(bool); - /// Signal about the necessety of the next widget activating - /// \param theWidget the model widget - void activateNextWidget(ModuleBase_ModelWidget* theWidget); + void operationResumed(ModuleBase_Operation* theOperation); - protected: + /// Emitted when current operation is Committed + void operationCommitted(ModuleBase_Operation* theOperation); - /// Commits the current operatin if it is valid - bool commitOperation(); + /// Emitted when current operation is aborted + void operationAborted(ModuleBase_Operation* theOperation); + + /// Signal is emitted after the key released click. + void keyEnterReleased(); + +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); + +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 operation can be started. Check if there is already started operation and - /// the granted parameter of the launched operation - /// \param theOperation an operation to check - bool canStartOperation(ModuleBase_Operation* theOperation); - - bool canStopOperation(); + /// 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); - /// Returns true if the operation can be aborted - bool canAbortOperation(); + /// 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 theObject a sender of the event + /// \param theEvent the mouse event + bool onKeyReleased(QObject *theObject, QKeyEvent* theEvent); + + /// SLOT, that is called by the key in the property panel is clicked. + /// \param theObject a sender of the event /// \param theEvent the mouse event - void onKeyReleased(QKeyEvent* theEvent); + bool onKeyPressed(QObject *theObject, QKeyEvent* theEvent); - /// SLOT, that reacts to the widget activation - /// \param theWidget an activated widget - void onWidgetActivated(ModuleBase_ModelWidget* theWidget); + /// The functionaly, that should be done by delete click + /// Fistly the active widget processes it, then workshop. If no one does not + /// process it, do nothing + /// \param theObject a sender of the event + bool onProcessDelete(QObject* theObject); protected slots: + /// The functionaly, that should be done by enter click + /// Fistly the active widget processes it, then module. If no one does not + /// process it, the current operation is committed + /// \param theObject a sender of the event + bool onProcessEnter(QObject *theObject); + /// 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: + /// Checks if the object is a parent or a child under + /// \param theObject an investivated object + /// \param theParent a candidate to be a parent + static bool isChildObject(const QObject* theObject, const QObject* theParent); + + /// Creates question message box with OK/Cancel buttons, where Cancel is default button, + /// Escape is Null button + /// \param theMessage text of the message + /// \return message box + static QMessageBox* createMessageBox(const QString& theMessage); + + /// Creates information message box with OK button, + /// Escape is Null button + /// \param theMessage text of the message + /// \return message box + static QMessageBox* createInformationBox(const QString& theMessage); + private: typedef QList 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; + QMessageBox* myActiveMessageBox; + XGUI_ShortCutListener* myShortCutListener; + bool mySHIFTPressed; }; #endif