src/ModuleBase/ModuleBase_WidgetSelectorStore.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_WidgetSelectorStore_H
  22 #define ModuleBase_WidgetSelectorStore_H
  23
  24 #include "ModuleBase.h"
  25
  26 #include <ModelAPI_Object.h>
  27 #include <ModelAPI_Attribute.h>
  28 #include <GeomAPI_Shape.h>
  29
  30 class ModuleBase_IWorkshop;
  31
  32 /**
  33 * \ingroup GUI
  34   Provides for an attribute backup of values.
  35   It is possible to store/ restore the attribute values.
  36 */
  37 class ModuleBase_WidgetSelectorStore
  38 {
  39  public:
  40
  41   /// Constructor
  42   MODULEBASE_EXPORT ModuleBase_WidgetSelectorStore();
  43   /// Destructor
  44   MODULEBASE_EXPORT virtual ~ModuleBase_WidgetSelectorStore() {}
  45
  46   /// Creates a backup of the current values of the attribute
  47   /// \param theAttribute a model attribute which parameters are to be stored
  48   /// \param theWorkshop a current workshop
  49   MODULEBASE_EXPORT void storeAttributeValue(const AttributePtr& theAttribute,
  50                                              ModuleBase_IWorkshop* theWorkshop);
  51
  52   /// Creates a backup of the current values of the attribute
  53   /// \param theAttribute a model attribute which parameters are to be restored
  54   /// \param theWorkshop a current workshop
  55   MODULEBASE_EXPORT void restoreAttributeValue(const AttributePtr& theAttribute,
  56                                                ModuleBase_IWorkshop* theWorkshop);
  57
  58 private:
  59   /// backup parameters of the model attribute. The class processes three types of attribute:
  60   /// Reference, RefAttr and Selection.
  61   /// Depending on the attribute type, only the attribute parameter
  62   /// values are reserved in the backup
  63   /// An attribute object
  64   ObjectPtr myObject;
  65   /// An attribute shape
  66   GeomShapePtr myShape;
  67   /// A reference of the attribute
  68   AttributePtr myRefAttribute;
  69   /// A boolean value whether refAttr uses reference of object
  70   bool myIsObject;
  71
  72   /// Variable of selection type
  73   std::string mySelectionType;
  74   /// Variable of GeomSelection
  75   int mySelectionCount; // number of elements in the attribute selection list when store
  76
  77 };
  78
  79 #endif