src/ModuleBase/ModuleBase_OperationAction.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef ModuleBase_OperationAction_H
  22 #define ModuleBase_OperationAction_H
  23
  24 #include <ModuleBase.h>
  25
  26 #include <ModuleBase_Operation.h>
  27
  28 /*!
  29  * \class ModuleBase_OperationAction
  30  * \ingroup GUI
  31  * \brief Base class for action operations
  32  *
  33  *  This is an action-like operation, which modifies the structure of data through
  34  *  starting/comitting transactions in the document. This operations are single stepped,
  35  *  and have no filled property panel, like Delete/Detach.
  36  */
  37
  38 class MODULEBASE_EXPORT ModuleBase_OperationAction : public ModuleBase_Operation
  39 {
  40 Q_OBJECT
  41
  42  public:
  43   /// Constructor
  44   /// \param theId the operation identifier
  45   /// \param theParent the QObject parent
  46   ModuleBase_OperationAction(const QString& theId = "", QObject* theParent = 0);
  47   /// Destructor
  48   virtual ~ModuleBase_OperationAction();
  49
  50  public slots:
  51   /// Commits the operation. Change is modified state to true value.
  52   /// \return the result of commit
  53   virtual bool commit();
  54 };
  55
  56 #endif