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