Salome HOME
Fix SketcherSetEqual.test_length_equality
[modules/shaper.git] / src / ModuleBase / ModuleBase_OperationAction.h
index 4667840b0e076436131a395e486fb8766ea390b2..3e9c283a956e4abb0d2f68f256dab783bc60586f 100755 (executable)
 /*!
  * \class ModuleBase_OperationAction
  * \ingroup GUI
- * \brief Base class for all operations
+ * \brief Base class for action operations
  *
- *  Base class for all operations. If you perform an action it is reasonable to create
- *  operation intended for this. This is a base class for all operations which provides
- *  mechanism for correct starting operations, starting operations above already started
- *  ones, committing operations and so on. To create own operation it is reasonable to
- *  inherit it from this class and redefines virtual methods to provide own behavior
+ *  This is an action-like operation, which modifies the structure of data through
+ *  starting/comitting transactions in the document. This operations are single stepped,
+ *  and have no filled property panel, like Delete/Detach.
  */
 
 class MODULEBASE_EXPORT ModuleBase_OperationAction : public ModuleBase_Operation
@@ -31,13 +29,17 @@ class MODULEBASE_EXPORT ModuleBase_OperationAction : public ModuleBase_Operation
 Q_OBJECT
 
  public:
-
   /// Constructor
   /// \param theId the operation identifier
   /// \param theParent the QObject parent
   ModuleBase_OperationAction(const QString& theId = "", QObject* theParent = 0);
   /// Destructor
   virtual ~ModuleBase_OperationAction();
+
+ public slots:
+  /// Commits the operation. Change is modified state to true value.
+  /// \return the result of commit
+  virtual bool commit();
 };
 
 #endif