src/ModuleBase/ModuleBase_Operation.h

   1 // Copyright (C) 2014-2020  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef ModuleBase_Operation_H
  21 #define ModuleBase_Operation_H
  22
  23 #include <ModuleBase.h>
  24
  25 #include <QObject>
  26 #include <QString>
  27 #include <QStringList>
  28
  29 class ModuleBase_ModelWidget;
  30 class ModuleBase_OperationDescription;
  31 class ModuleBase_IPropertyPanel;
  32
  33 class QKeyEvent;
  34
  35 /*!
  36  * \class ModuleBase_Operation
  37  * \ingroup GUI
  38  * \brief Base class for all operations
  39  *
  40  *  Base class for all operations. If you perform an action it is reasonable to create
  41  *  operation intended for this. This is a base class for all operations which provides
  42  *  mechanism for correct starting operations, starting operations above already started
  43  *  ones, committing operations and so on. To create own operation it is reasonable to
  44  *  inherit it from this class and redefines virtual methods to provide own behavior
  45  *  Main virtual methods are
  46  *  - virtual bool      isReadyToStart();
  47  *  - virtual void      startOperation();
  48  *  - virtual void      abortOperation();
  49  *  - virtual void      commitOperation();
  50  */
  51
  52 class MODULEBASE_EXPORT ModuleBase_Operation : public QObject
  53 {
  54 Q_OBJECT
  55
  56  public:
  57   /// Constructor
  58   /// \param theId the operation identifier
  59   /// \param theParent the QObject parent
  60   ModuleBase_Operation(const QString& theId = "", QObject* theParent = 0);
  61
  62   /// Destructor
  63   virtual ~ModuleBase_Operation();
  64
  65   /// Returns the operation description
  66   /// /returns the instance of the description class
  67   ModuleBase_OperationDescription* getDescription() const { return myDescription; }
  68
  69   /// Returns list of granted operation indices
  70   const QStringList& grantedOperationIds() const;
  71
  72   /// Sets list of operation indices, which can be started without the current operation stop
  73   /// \param theList an ids
  74   void setGrantedOperationIds(const QStringList& theList);
  75
  76   /// Must return true if this operation can be launched as nested for any current operation
  77   /// and it is not necessary to check this operation on validity. By default
  78   /// the operation is not granted.
  79   /// The method has to be redefined for granted operations.
  80   virtual bool isGranted(QString theId) const;
  81
  82   /// Returns True if data of its feature was modified during operation
  83   virtual bool isModified() const;
  84
  85   /// Returns operations Id from it's description
  86   QString id() const;
  87
  88   /// Must return True if the operation's feature is valid.
  89   /// Since IOperation does not have any feature returns false.
  90   virtual bool isValid() const;
  91
  92   /// \brief Set property pane to the operation
  93   /// \param theProp a property panel instance
  94   virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp);
  95
  96   /// \return Currently installed property panel
  97   ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; }
  98
  99   QString helpFileName() const { return myHelpFileName; }
 100
 101   void setHelpFileName(QString theName) {
 102     myHelpFileName = theName;
 103   }
 104
 105   void setHideFacesVisible(bool isVisible) { myHideFacesVisibilityState = isVisible; }
 106
 107   bool isHideFacesVisible() const { return myHideFacesVisibilityState; }
 108
 109 signals:
 110   /// The operation is started
 111   void beforeStarted();
 112   /// The operation is started
 113   void started();
 114
 115   /// The operation is aborted
 116   void beforeAborted();
 117   /// The operation is aborted
 118   void aborted();
 119
 120   /// The operation is committed
 121   void beforeCommitted();
 122   /// The operation is committed
 123   void committed();
 124
 125   /// The operation is aborted or committed
 126   void stopped();
 127
 128   /// The operation is resumed
 129   void resumed();
 130
 131   /// The operation is postponed
 132   void postponed();
 133
 134  public slots:
 135   /// Starts operation
 136   /// Public slot. Verifies whether operation can be started and starts operation.
 137   /// This slot is not virtual and cannot be redefined. Redefine startOperation method
 138   /// to change behavior of operation. There is no point in using this method. It would
 139   /// be better to inherit own operator from base one and redefine startOperation method
 140   /// instead.
 141   /// \return true if the start is successful
 142   virtual bool start();
 143
 144   /// Deactivates current operation which can be resumed later.
 145   virtual void postpone();
 146
 147   /// Resumes operation
 148   /// Public slot. Verifies whether operation can be started and starts operation.
 149   /// This slot is not virtual and cannot be redefined. Redefine startOperation method
 150   /// to change behavior of operation. There is no point in using this method. It would
 151   /// be better to inherit own operator from base one and redefine startOperation method
 152   /// instead.
 153   virtual void resume();
 154
 155   /// Aborts operation
 156   /// Public slot. Aborts operation. This slot is not virtual and cannot be redefined.
 157   /// Redefine abortOperation method to change behavior of operation instead
 158   virtual void abort();
 159
 160   /// Commits operation
 161   /// Public slot. Commits operation. This slot is not virtual and cannot be redefined.
 162   /// Redefine commitOperation method to change behavior of operation instead
 163   virtual bool commit();
 164
 165   /// Changes the modified flag of the operation
 166   void onValuesChanged();
 167
 168   /// Changes the modified flag of the operation if the current state of the widget is modified
 169   /// \param thePreviousState the previous vlaue state of the widget
 170   void onValueStateChanged(int thePreviousState);
 171
 172  protected:
 173   /// Virtual method called when operation started (see start() method for more description)
 174   /// Default impl calls corresponding slot and commits immediately.
 175    virtual void startOperation() {}
 176
 177   /// Implementation of specific steps on postpone operation
 178   virtual void postponeOperation() {}
 179
 180   /// Virtual method called when operation stopped - committed or aborted.
 181   virtual void stopOperation() {}
 182
 183   /// Virtual method called when operation aborted (see abort() method for more description)
 184   virtual void abortOperation() {}
 185
 186   /// Virtual method called when operation committed (see commit() method for more description)
 187   virtual void commitOperation() {};
 188
 189   /// Virtual method called after operation committed (see commit() method for more description)
 190   virtual void afterCommitOperation() {}
 191
 192   /// Virtual method called after operation resume (see resume() method for more description)
 193   virtual void resumeOperation() {}
 194
 195   /// Verifies whether this operator can be commited.
 196   /// \return Returns TRUE if current operation can be committed, e.g. all parameters are filled
 197   virtual bool canBeCommitted() const;
 198
 199 private:
 200   /// the container to have the operation description
 201   ModuleBase_OperationDescription* myDescription;
 202
 203   /// Modified feature flag
 204   bool myIsModified;
 205
 206   /// List of operations IDs which are granted of the current operation
 207   QStringList myGrantedIds;
 208
 209   /// Access to property panel
 210   ModuleBase_IPropertyPanel* myPropertyPanel;
 211
 212   QString myHelpFileName;
 213
 214   /// Visibility state of HideFaces panel before the operation launch
 215   bool myHideFacesVisibilityState;
 216 };
 217
 218 #endif