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;
20 class ModuleBase_IWorkshop;
23 /**\class ModuleBase_ModelWidget
25 * \brief An abstract custom widget class. This class realization is assumed to create some controls.
26 * The controls values modification should send signal about values change.
28 * Common interface for widgets in the property panel.
29 * Every widget are able to save/restore data from the model and/or to contain other widgets.
32 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget
36 /// State of the widget
37 enum ValueState { Stored, /// modification is finished and applyed to the model
38 Modified, /// modification has not been finished and set to the model yet
42 /// \param theParent the parent object
43 /// \param theData the widget configuration. The attribute of the model widget is obtained from
44 /// \param theParentId is Id of a parent of the current attribute
45 ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData,
46 const std::string& theParentId);
48 virtual ~ModuleBase_ModelWidget()
52 /// Fills the widget with default values. It calls the resetCustom method and change
53 /// the widget state to Reset if the reset is performed.
54 /// \return true if the widget current value is reset
57 /// Returns the state whether the attribute of the feature is initialized
58 /// \param theObject a model feature to be checked
59 /// \return the boolean result
60 bool isInitialized(ObjectPtr theObject) const;
62 /// Returns true, if default value of the widget should be computed
63 /// on operation's execute, like radius for circle's constraint (can not be zero)
64 bool isComputedDefault() const { return myIsComputedDefault; }
66 /// Returns true, if default value of the widget is defined in the XML and it is not the
68 /// \return the boolean result
69 std::string getDefaultValue() const { return myDefaultValue; }
71 /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value
72 /// \return the boolean result
73 bool isObligatory() const { return myIsObligatory; }
75 /// Returns this parameter value in the xml file
76 /// \return the boolean result
77 bool isUseReset() const { return myUseReset; }
79 /// Returns this widget value state
80 /// \return the enumeration result
81 ValueState getValueState() const { return myState; }
83 /// Defines if it is supposed that the widget should interact with the viewer.
84 virtual bool isViewerSelector() { return false; }
86 /// Defines if it is supported to set the value in this widget
87 /// By default it returns true
88 virtual bool canSetValue() const { return true; };
90 /// Set the given wrapped value to the current widget
91 /// This value should be processed in the widget according to the needs
92 /// \param theValues the wrapped selection values
93 /// \param theToValidate the boolean value whether the value should be checked by filters
94 virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
95 const bool theToValidate)
100 /// Restore value from attribute data to the widget's control. Emits signals before and after store
101 /// \return True in success
104 /// Saves the internal parameters to the given feature. Emits signals before and after store
105 /// \return True in success
106 void storeValueByApply();
108 /// Set focus to the first control of the current widget. The focus policy of the control is checked.
109 /// If the widget has the NonFocus focus policy, it is skipped.
110 /// \return the state whether the widget can accept the focus
111 virtual bool focusTo();
113 /// The method called when widget is activated
116 /// The method called when widget is deactivated
117 virtual void deactivate() {}
119 /// Returns list of widget controls
120 /// \return a control list
121 virtual QList<QWidget*> getControls() const = 0;
123 /// Returns the first or the last control that can accept the focus
124 /// \param isFirst if true, the first controls is returned or the last one
125 /// \return a control from a list of controls
126 QWidget* getControlAcceptingFocus(const bool isFirst);
128 /// FocusIn events processing
129 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
131 /// \brief Enables processing of focus event on all controls by the widget
132 /// if this widget is not obligatory and set no-focus policy otherwise
133 virtual void enableFocusProcessing();
135 //! Switch On/Off highlighting of the widget
136 virtual void setHighlighted(bool isHighlighted);
138 /// Returns the attribute name
139 /// \returns the string value
140 std::string attributeID() const
142 return myAttributeID;
145 /// Returns the parent of the attribute
146 /// \returns the string value
147 std::string parentID() const
152 /// \return Current feature
153 FeaturePtr feature() const
158 /// Set feature which is processing by active operation
159 /// \param theFeature a feature object
160 /// \param theToStoreValue a value about necessity to store the widget value to the feature
161 void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
163 /// Editing mode depends on mode of current operation. This value is defined by it.
164 void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
166 /// \return Current Editing mode
167 bool isEditingMode() const { return myIsEditing; }
169 /// Returns true if the event is processed.
170 virtual bool processEnter();
172 /// Sends Update and Redisplay for the given object
173 /// \param theObj is updating object
174 static void updateObject(ObjectPtr theObj);
176 /// Sends Move event for the given object
177 /// \param theObj is object for moving
178 static void moveObject(ObjectPtr theObj);
181 /// The signal about widget values are to be changed
182 void beforeValuesChanged();
183 /// The signal about widget values changed
184 void valuesChanged();
185 /// The signal about widget values modified
186 void valuesModified();
187 /// The signal about widget values are to be changed
188 void afterValuesChanged();
190 /// The signal about widget values are to be restored
191 void beforeValuesRestored();
192 /// The signal about widget values are to be restored
193 void afterValuesRestored();
195 /// The signal about key release on the control, that corresponds to the attribute
196 /// \param theEvent key release event
197 void keyReleased(QKeyEvent* theEvent);
199 /// The signal about the widget is get focus
200 /// \param theWidget the model base widget
201 void focusInWidget(ModuleBase_ModelWidget* theWidget);
203 /// The signal about the widget is lost focus
204 /// \param theWidget the model base widget
205 void focusOutWidget(ModuleBase_ModelWidget* theWidget);
207 /// The signal about value state modification
208 void valueStateChanged();
210 void focusNextPrev();
214 /// Sets default value of widget. Normally, widget should fetch this value
215 /// from the xml. However, some widgets derived widgets could define it
216 void setDefaultValue(const std::string& theValue);
217 /// \brief Set the attribute name
218 /// \param theAttribute the string value with attribute name
219 void setAttributeID(const std::string& theAttribute)
221 myAttributeID = theAttribute;
224 /// Sets the current value state. If the value is changed, the signal is emitted
225 /// \param theState a new state
226 void setValueState(const ValueState& theState);
228 /// Saves the internal parameters to the given feature. Emits signals before and after store
229 /// \return True in success
232 /// Saves the internal parameters to the given feature
233 /// \return True in success
234 virtual bool storeValueCustom() const = 0;
236 /// Restore value from attribute data to the widget's control
237 virtual bool restoreValueCustom() = 0;
239 /// Fills the widget with default values
240 /// \return true if the widget current value is reset
241 virtual bool resetCustom() { return false; };
243 /// The method called when widget is activated
244 virtual void activateCustom() {};
246 /// Sends a message about block/unblock viewer updating
247 /// \param theValue a boolean value
248 static void blockUpdateViewer(const bool theValue);
251 /// Processing of values changed in model widget by store the current value to the feature
252 void onWidgetValuesChanged();
254 /// Changes widget state.
255 void onWidgetValuesModified();
259 /// The attribute name of the model feature
260 std::string myAttributeID;
263 std::string myParentId;
265 /// A feature which is processing by active operation
266 FeaturePtr myFeature;
268 /// Flag which shows that current operation is in editing mode
271 /// Flag which shows whether current widget is obligatory
272 /// The non-obligatory widgets should not accept the focus in the property panel
275 /// The widget value state
279 /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
280 bool myIsComputedDefault;
282 /// the default value, which is defined in the XML for this attribute
283 std::string myDefaultValue;
285 /// the reset state. If it is false, the reset method of the widget is not performed