Salome HOME
Update copyrights
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetPointInput.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_WidgetPointInput_H
21 #define ModuleBase_WidgetPointInput_H
22
23 #include "ModuleBase.h"
24 #include "ModuleBase_WidgetSelector.h"
25
26 class ModuleBase_ParamSpinBox;
27
28 class MODULEBASE_EXPORT ModuleBase_WidgetPointInput : public ModuleBase_WidgetSelector
29 {
30   Q_OBJECT
31 public:
32   /// Constructor
33   /// \param theParent the parent object
34   /// \param theWorkshop a current workshop
35   /// \param theData the widget configuation. The attribute of the model widget is obtained from
36   ModuleBase_WidgetPointInput(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
37     const Config_WidgetAPI* theData);
38
39   /// Destructor
40   virtual ~ModuleBase_WidgetPointInput();
41
42   /// Returns list of widget controls
43   /// \return a control list
44   virtual QList<QWidget*> getControls() const;
45
46   /// Saves the internal parameters to the given feature
47   /// \return True in success
48   virtual bool storeValueCustom();
49
50   /// Restore value from attribute data to the widget's control
51   virtual bool restoreValueCustom();
52
53   /// Defines if it is supposed that the widget should interact with the viewer.
54   virtual bool isViewerSelector() { return true; }
55
56   /// Fills given container with selection modes if the widget has it
57   /// \param [out] theModuleSelectionModes module additional modes, -1 means all default modes
58   /// \param [out] theModes a container of modes
59   virtual void selectionModes(int& theModuleSelectionModes, QIntList& theModes);
60
61   /// Fills the attribute with the value of the selected owner
62   /// \param thePrs a selected owner
63   virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
64     const bool theToValidate);
65
66 protected:
67   /// Retunrs a list of possible shape types
68   /// \return a list of shapes
69   virtual QIntList shapeTypes() const;
70
71   /// Returns true if the event is processed.
72   virtual bool processEnter();
73
74 protected:
75   ModuleBase_ParamSpinBox* myXSpin;
76   ModuleBase_ParamSpinBox* myYSpin;
77   ModuleBase_ParamSpinBox* myZSpin;
78
79   FeaturePtr myXParam;
80   FeaturePtr myYParam;
81   FeaturePtr myZParam;
82
83   double myDefaultValue[3];
84 };
85
86
87 #endif