-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File: XGUI_OperationMgr.h
-// Created: 20 Apr 2014
-// Author: Natalia ERMOLAEVA
+// Copyright (C) 2014-2023 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
#include <QStringList>
class QKeyEvent;
+class QMessageBox;
class ModuleBase_IWorkshop;
class XGUI_Workshop;
+class XGUI_ShortCutListener;
/**\class XGUI_OperationMgr
* \ingroup GUI
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
/// \param theWorkshop a reference to workshop
/// 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;
/// 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);
+ /// \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;
/// 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);
+ /// 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
/// 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(const QString& theId);
+ /// \param isCommitted boolean value if the operation was committed otherwise it was aborted
+ bool canStartOperation(const QString& theId, bool& isCommitted);
+
+ /// 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
/// \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 commits the current operation.
- void onCommitOperation();
/// 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();
- /// Abort all operations
- bool abortAllOperations();
signals:
- /// Signal about an operation is started. It is emitted after the start() of operation is done.
- void operationStarted(ModuleBase_Operation* theOperation);
-
/// 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);
/// Emitted when current operation is aborted
void operationAborted(ModuleBase_Operation* theOperation);
- /// Signal is emitted after the current operation is filled with existing preselection.
- void operationActivatedByPreselection();
-
/// Signal is emitted after the key released click.
void keyEnterReleased();
/// \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
public slots:
/// 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
- bool onKeyReleased(QKeyEvent* theEvent);
+ bool onKeyReleased(QObject *theObject, QKeyEvent* theEvent);
- 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
- bool onProcessEnter();
+ /// 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
+ bool onKeyPressed(QObject *theObject, QKeyEvent* theEvent);
/// 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
- bool onProcessDelete();
+ /// \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 onOperationResumed();
private:
- XGUI_Workshop* workshop() const;
+ /// 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<ModuleBase_Operation*> Operations; ///< definition for a list of operations
/// Current workshop
ModuleBase_IWorkshop* myWorkshop;
+ QMessageBox* myActiveMessageBox;
+ XGUI_ShortCutListener* myShortCutListener;
+ bool mySHIFTPressed;
};
#endif
