]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModuleBase/ModuleBase_ModelWidget.h
Salome HOME
Bugfix: treat attribute as valid and initialized if it's default value is equual...
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
1 // File:        ModuleBase_ModelWidget.h
2 // Created:     25 Apr 2014
3 // Author:      Natalia ERMOLAEVA
4
5 #ifndef ModuleBase_ModelWidget_H
6 #define ModuleBase_ModelWidget_H
7
8 #include <ModuleBase.h>
9
10 #include <ModelAPI_Feature.h>
11
12 #include <QObject>
13
14 #include <boost/shared_ptr.hpp>
15
16 class Config_WidgetAPI;
17 class ModuleBase_WidgetValue;
18 class QKeyEvent;
19
20 /**\class ModuleBase_ModelWidget
21  * \brief An abstract custom widget class. This class realization is assumed to create some controls.
22  * The controls values modification should send signal about values change.
23  *
24  * Common interface for widgets in the property panel.
25  * Every widget are able to save/restore data from the model and/or to contain other widgets.
26  *
27  */
28 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QObject
29 {
30 Q_OBJECT
31  public:
32   /// Constructor
33   /// \theParent the parent object
34   /// \theData the widget configuation. The attribute of the model widget is obtained from
35   ModuleBase_ModelWidget(QObject* theParent, const Config_WidgetAPI* theData,
36                          const std::string& theParentId);
37   /// Destructor
38   virtual ~ModuleBase_ModelWidget()
39   {
40   }
41
42   /// Set the given wrapped value to the current widget
43   /// This value should be processed in the widget according to the needs
44   /// \param theValue the wrapped widget value
45   virtual bool setValue(ModuleBase_WidgetValue* theValue)
46   {
47     return false;
48   }
49
50   /// Returns the state whether the attribute of the feature is initialized
51   /// \param theObject a model feature to be checked
52   /// \return the boolean result
53   bool isInitialized(ObjectPtr theObject) const;
54
55   /// Saves the internal parameters to the given feature
56   /// \param theObject a model feature to be changed
57   virtual bool storeValue() const = 0;
58
59   virtual bool restoreValue() = 0;
60
61   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
62   /// If the widget has the NonFocus focus policy, it is skipped.
63   /// \return the state whether the widget can accept the focus
64   virtual bool focusTo();
65
66   /// Returns list of widget controls
67   /// \return a control list
68   virtual QList<QWidget*> getControls() const = 0;
69
70   /// Returns the attribute name
71   /// \returns the string value
72   std::string attributeID() const
73   {
74     return myAttributeID;
75   }
76
77   /// Returns the parent of the attribute
78   /// \returns the string value
79   std::string parentID() const
80   {
81     return myParentId;
82   }
83
84   FeaturePtr feature() const
85   {
86     return myFeature;
87   }
88   void setFeature(const FeaturePtr& theFeature)
89   {
90     myFeature = theFeature;
91   }
92
93 signals:
94   /// The signal about widget values changed
95   void valuesChanged();
96   /// The signal about key release on the control, that corresponds to the attribute
97   /// \param theAttributeName a name of the attribute
98   /// \param theEvent key release event
99   void keyReleased(const std::string& theAttributeName, QKeyEvent* theEvent);
100   /// The signal about the widget is lost focus
101   /// \param theWidget the model base widget
102   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
103
104  protected:
105   /// Returns the attribute name
106   /// \returns the string value
107   void setAttributeID(const std::string& theAttribute)
108   {
109     myAttributeID = theAttribute;
110   }
111
112   void updateObject(ObjectPtr theObj) const;
113
114   std::string myAttributeID;  /// the attribute name of the model feature
115   std::string myParentId;    /// name of parent
116   FeaturePtr myFeature;
117 };
118
119 #endif