Salome HOME
9f55dab1e56e48bc4799670bfb66a4c56f53ab5a
[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 <memory>
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(QWidget* theParent, const Config_WidgetAPI* theData,
36                          const std::string& theParentId);
37   /// Destructor
38   virtual ~ModuleBase_ModelWidget()
39   {
40   }
41
42   /// Returns the state whether the attribute of the feature is initialized
43   /// \param theObject a model feature to be checked
44   /// \return the boolean result
45   bool isInitialized(ObjectPtr theObject) const;
46
47   /// Returns true, if default value of the widget should be computed
48   /// on operation's execute, like radius for circle's constraint (can not be zero)
49   bool isComputedDefault() { return myIsComputedDefault; }
50
51   /// Defines if it is supposed that the widget should interact with the viewer.
52   virtual bool isViewerSelector() { return false; }
53
54   /// Set the given wrapped value to the current widget
55   /// This value should be processed in the widget according to the needs
56   /// \param theValue the wrapped widget value
57   virtual bool setValue(ModuleBase_WidgetValue* theValue)
58   {
59     return false;
60   }
61
62   /// Saves the internal parameters to the given feature
63   /// \param theObject a model feature to be changed
64   virtual bool storeValue() const = 0;
65
66   virtual bool restoreValue() = 0;
67
68   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
69   /// If the widget has the NonFocus focus policy, it is skipped.
70   /// \return the state whether the widget can accept the focus
71   virtual bool focusTo();
72
73   /// The methiod called when widget is activated
74   virtual void activate() {}
75
76   /// The methiod called when widget is deactivated
77   virtual void deactivate() {}
78
79   /// Returns the internal parent wiget control, that can be shown anywhere
80   /// \returns the widget
81   virtual QWidget* getControl() const = 0;
82
83   /// Returns list of widget controls
84   /// \return a control list
85   virtual QList<QWidget*> getControls() const = 0;
86
87
88   /// FocusIn events processing
89   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
90
91
92   void enableFocusProcessing();
93
94   void setHighlighted(bool isHighlighted);
95
96   /// Returns the attribute name
97   /// \returns the string value
98   std::string attributeID() const
99   {
100     return myAttributeID;
101   }
102
103   /// Returns the parent of the attribute
104   /// \returns the string value
105   std::string parentID() const
106   {
107     return myParentId;
108   }
109
110   FeaturePtr feature() const
111   {
112     return myFeature;
113   }
114
115   void setFeature(const FeaturePtr& theFeature)
116   {
117     myFeature = theFeature;
118   }
119
120 signals:
121   /// The signal about widget values changed
122   void valuesChanged();
123   /// The signal about key release on the control, that corresponds to the attribute
124   /// \param theAttributeName a name of the attribute
125   /// \param theEvent key release event
126   void keyReleased(QKeyEvent* theEvent);
127   /// The signal about the widget is get focus
128   /// \param theWidget the model base widget
129   void focusInWidget(ModuleBase_ModelWidget* theWidget);
130   /// The signal about the widget is lost focus
131   /// \param theWidget the model base widget
132   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
133
134  protected:
135   /// Returns the attribute name
136   /// \returns the string value
137   void setAttributeID(const std::string& theAttribute)
138   {
139     myAttributeID = theAttribute;
140   }
141
142   void updateObject(ObjectPtr theObj) const;
143
144  protected:
145   std::string myAttributeID; /// the attribute name of the model feature
146   std::string myParentId;    /// name of parent
147   FeaturePtr myFeature;
148
149   bool myIsComputedDefault; /// Value should be computed on execute,
150                             /// like radius for circle's constraint (can not be zero)
151 };
152
153 #endif