1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModuleBase_ModelWidget.h
4 // Created: 25 Apr 2014
5 // Author: Natalia ERMOLAEVA
7 #ifndef MODULEBASE_MODELWIDGET_H
8 #define MODULEBASE_MODELWIDGET_H
10 #include <ModuleBase.h>
11 #include <ModuleBase_ViewerPrs.h>
13 #include <ModelAPI_Feature.h>
19 class Config_WidgetAPI;
22 /**\class ModuleBase_ModelWidget
24 * \brief An abstract custom widget class. This class realization is assumed to create some controls.
25 * The controls values modification should send signal about values change.
27 * Common interface for widgets in the property panel.
28 * Every widget are able to save/restore data from the model and/or to contain other widgets.
31 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget
36 /// \param theParent the parent object
37 /// \param theData the widget configuation. The attribute of the model widget is obtained from
38 /// \param theParentId is Id of a parent of the current attribute
39 ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData,
40 const std::string& theParentId);
42 virtual ~ModuleBase_ModelWidget()
46 //TODO: nds stabilization hotfix
47 virtual void disconnectSignals() {};
49 /// Fills the widget with default values
50 virtual void reset() {};
52 /// Returns the state whether the attribute of the feature is initialized
53 /// \param theObject a model feature to be checked
54 /// \return the boolean result
55 bool isInitialized(ObjectPtr theObject) const;
57 /// Returns true, if default value of the widget should be computed
58 /// on operation's execute, like radius for circle's constraint (can not be zero)
59 bool isComputedDefault() const { return myIsComputedDefault; }
61 /// Returns true, if default value of the widget is defined in the XML and it is not the
63 /// \return the boolean result
64 std::string getDefaultValue() const { return myDefaultValue; }
66 /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value
67 /// \return the boolean result
68 bool isObligatory() const { return myIsObligatory; }
70 /// Returns this parameter value in the xml file
71 /// \return the boolean result
72 bool isUseReset() const { return myUseReset; }
74 /// Defines if it is supposed that the widget should interact with the viewer.
75 virtual bool isViewerSelector() { return false; }
77 /// Defines if it is supported to set the value in this widget
78 /// By default it returns true
79 virtual bool canSetValue() const { return true; };
81 /// Set the given wrapped value to the current widget
82 /// This value should be processed in the widget according to the needs
83 /// \param theValues the wrapped selection values
84 /// \param thePosition an index in the list of values, the values should be get from the index
85 virtual bool setSelection(const QList<ModuleBase_ViewerPrs>& theValues, int& thePosition)
90 /// Restore value from attribute data to the widget's control
91 virtual bool restoreValue() = 0;
93 /// Set focus to the first control of the current widget. The focus policy of the control is checked.
94 /// If the widget has the NonFocus focus policy, it is skipped.
95 /// \return the state whether the widget can accept the focus
96 virtual bool focusTo();
98 /// The methiod called when widget is activated
101 /// The methiod called when widget is deactivated
102 virtual void deactivate() {}
104 /// Returns list of widget controls
105 /// \return a control list
106 virtual QList<QWidget*> getControls() const = 0;
108 /// FocusIn events processing
109 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
111 /// \brief Enables processing of focus event on all controls by the widget
112 /// if this widget is not obligatory and set no-focus policy otherwise
113 virtual void enableFocusProcessing();
115 //! Switch On/Off highlighting of the widget
116 virtual void setHighlighted(bool isHighlighted);
118 /// Returns the attribute name
119 /// \returns the string value
120 std::string attributeID() const
122 return myAttributeID;
125 /// Returns the parent of the attribute
126 /// \returns the string value
127 std::string parentID() const
132 /// \return Current feature
133 FeaturePtr feature() const
138 /// Set feature which is processing by active operation
139 /// \param theToStoreValue a value about necessity to store the widget value to the feature
140 void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
142 /// Editing mode depends on mode of current operation. This value is defined by it.
143 void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
145 /// \return Current Editing mode
146 bool isEditingMode() const { return myIsEditing; }
149 /// The signal about widget values are to be changed
150 void beforeValuesChanged();
151 /// The signal about widget values changed
152 void valuesChanged();
153 /// The signal about widget values are to be changed
154 void afterValuesChanged();
156 /// The signal about key release on the control, that corresponds to the attribute
157 /// \param theEvent key release event
158 void keyReleased(QKeyEvent* theEvent);
160 /// The signal about the widget is get focus
161 /// \param theWidget the model base widget
162 void focusInWidget(ModuleBase_ModelWidget* theWidget);
164 /// The signal about the widget is lost focus
165 /// \param theWidget the model base widget
166 void focusOutWidget(ModuleBase_ModelWidget* theWidget);
169 /// Sets default value of widget. Nornaly, widget should fetch this value
170 /// from the xml. However, some widgets derived widgets could define it
171 void setDefaultValue(const std::string& theValue);
172 /// \brief Set the attribute name
173 /// \param theAttribute the string value with attribute name
174 void setAttributeID(const std::string& theAttribute)
176 myAttributeID = theAttribute;
179 /// Saves the internal parameters to the given feature. Emits signals before and after store
180 /// \return True in success
183 /// Saves the internal parameters to the given feature
184 /// \return True in success
185 virtual bool storeValueCustom() const = 0;
187 /// The methiod called when widget is activated
188 virtual void activateCustom() {};
190 /// Sends Update and Redisplay for the given object
191 /// \param theObj is updating object
192 void updateObject(ObjectPtr theObj) const;
194 /// Sends Move event for the given object
195 /// \param theObj is object for moving
196 void moveObject(ObjectPtr theObj) const;
199 /// Processing of values changed in model widget by store the current value to the feature
200 void onWidgetValuesChanged();
204 /// The attribute name of the model feature
205 std::string myAttributeID;
208 std::string myParentId;
210 /// A feature which is processing by active operation
211 FeaturePtr myFeature;
213 /// Flag which shows that current operation is in editing mode
216 /// Flag which shows whether current widget is obligatory
217 /// The non-obligatory widgets should not accept the focus in the property panel
221 /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
222 bool myIsComputedDefault;
224 /// the default value, which is defined in the XML for this attribute
225 std::string myDefaultValue;
227 /// the reset state. If it is false, the reset method of the widget is not performed