Salome HOME
updated copyright message
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetIntValue.h
1 // Copyright (C) 2014-2023  CEA, EDF
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_WidgetIntValue_H
21 #define ModuleBase_WidgetIntValue_H
22
23 #include "ModuleBase.h"
24 #include "ModuleBase_ModelWidget.h"
25
26 class ModuleBase_ParamSpinBox;
27 class Config_WidgetAPI;
28 class QWidget;
29 class QLabel;
30 class QTimer;
31
32 /**
33 * \ingroup GUI
34 * A class of property panel widget for integer value input
35 * It can be defined with "integervalue" keyword. For example:
36 * \code
37 * <integervalue id="x" label="X:" icon=":pictures/x_point.png" tooltip="X coordinate"/>
38 * \endcode
39 */
40 class MODULEBASE_EXPORT ModuleBase_WidgetIntValue : public ModuleBase_ModelWidget
41 {
42 Q_OBJECT
43  public:
44   /// Constructor
45   /// \param theParent the parent object
46   /// \param theData the widget configuration. The attribute of the model widget is obtained from
47   ModuleBase_WidgetIntValue(QWidget* theParent, const Config_WidgetAPI* theData);
48
49   virtual ~ModuleBase_WidgetIntValue();
50
51   /// The methiod called when widget is activated
52   virtual void activateCustom();
53
54   /// Select the internal content if it can be selected. It is empty in the default realization
55   virtual void selectContent();
56
57   /// Returns list of widget controls
58   /// \return a control list
59   virtual QList<QWidget*> getControls() const;
60
61   /// Returns True if data of its feature was modified during operation
62   virtual bool isModified() const;
63
64 protected:
65   /// Returns true if the event is processed.
66   virtual bool processEnter();
67
68   /// Saves the internal parameters to the given feature
69   /// \return True in success
70   virtual bool storeValueCustom();
71
72   //! Read value of corresponded attribute from data model to the input control
73   // \return True in success
74   virtual bool restoreValueCustom();
75
76   /// Fills the widget with default values
77   /// \return true if the widget current value is reset
78   virtual bool resetCustom();
79
80 protected:
81   /// Label of the widget
82   QLabel* myLabel;
83
84   /// Input value control
85   ModuleBase_ParamSpinBox* mySpinBox;
86
87   FeaturePtr myParameter;
88
89   int myDefVal;
90   bool myHasDefault;
91 };
92
93 #endif