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 ModifiedInPP, /// modification has not been finished and set to the model yet
39 ModifiedInViewer, /// modification performed by viewer events
40 Reset }; /// the value is reset
43 /// \param theParent the parent object
44 /// \param theData the widget configuration. The attribute of the model widget is obtained from
45 /// \param theParentId is Id of a parent of the current attribute
46 ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData,
47 const std::string& theParentId);
49 virtual ~ModuleBase_ModelWidget()
53 /// Fills the widget with default values. It calls the resetCustom method and change
54 /// the widget state to Reset if the reset is performed.
55 /// \return true if the widget current value is reset
58 /// Returns the state whether the attribute of the feature is initialized
59 /// \param theObject a model feature to be checked
60 /// \return the boolean result
61 bool isInitialized(ObjectPtr theObject) const;
63 /// Returns true, if default value of the widget should be computed
64 /// on operation's execute, like radius for circle's constraint (can not be zero)
65 bool isComputedDefault() const { return myIsComputedDefault; }
67 /// Returns true, if default value of the widget is defined in the XML and it is not the
69 /// \return the boolean result
70 std::string getDefaultValue() const { return myDefaultValue; }
72 /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value
73 /// \return the boolean result
74 bool isObligatory() const { return myIsObligatory; }
76 /// Returns this parameter value in the xml file
77 /// \return the boolean result
78 bool isUseReset() const { return myUseReset; }
80 /// Returns this widget value state
81 /// \return the enumeration result
82 ValueState getValueState() const { return myState; }
84 /// Defines if it is supposed that the widget should interact with the viewer.
85 virtual bool isViewerSelector() { return false; }
87 /// Defines if it is supported to set the value in this widget
88 /// By default it returns true
89 virtual bool canSetValue() const { return true; };
91 /// Set the given wrapped value to the current widget
92 /// This value should be processed in the widget according to the needs
93 /// \param theValues the wrapped selection values
94 /// \param theToValidate the boolean value whether the value should be checked by filters
95 virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
96 const bool theToValidate)
101 /// Restore value from attribute data to the widget's control. Emits signals before and after store
102 /// \return True in success
105 /// Set focus to the first control of the current widget. The focus policy of the control is checked.
106 /// If the widget has the NonFocus focus policy, it is skipped.
107 /// \return the state whether the widget can accept the focus
108 virtual bool focusTo();
110 /// The method called when widget is activated
113 /// The method called when widget is deactivated
114 virtual void deactivate();
116 /// Returns list of widget controls
117 /// \return a control list
118 virtual QList<QWidget*> getControls() const = 0;
120 /// Returns the first or the last control that can accept the focus
121 /// \param isFirst if true, the first controls is returned or the last one
122 /// \return a control from a list of controls
123 QWidget* getControlAcceptingFocus(const bool isFirst);
125 /// FocusIn events processing
126 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
128 /// \brief Enables processing of focus event on all controls by the widget
129 /// if this widget is not obligatory and set no-focus policy otherwise
130 virtual void enableFocusProcessing();
132 //! Switch On/Off highlighting of the widget
133 virtual void setHighlighted(bool isHighlighted);
135 /// Returns the attribute name
136 /// \returns the string value
137 std::string attributeID() const
139 return myAttributeID;
142 /// Returns the parent of the attribute
143 /// \returns the string value
144 std::string parentID() const
149 /// \return Current feature
150 FeaturePtr feature() const
155 /// Set feature which is processing by active operation
156 /// \param theFeature a feature object
157 /// \param theToStoreValue a value about necessity to store the widget value to the feature
158 void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
160 /// Editing mode depends on mode of current operation. This value is defined by it.
161 void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
163 /// \return Current Editing mode
164 bool isEditingMode() const { return myIsEditing; }
166 /// Returns true if the event is processed.
167 virtual bool processEnter();
169 /// Sends Update and Redisplay for the given object
170 /// \param theObj is updating object
171 static void updateObject(ObjectPtr theObj);
173 /// Sends Move event for the given object
174 /// \param theObj is object for moving
175 static void moveObject(ObjectPtr theObj);
178 /// The signal about widget values are to be changed
179 void beforeValuesChanged();
180 /// The signal about widget values changed
181 void valuesChanged();
182 /// The signal about widget values modified
183 void valuesModified();
184 /// The signal about widget values are to be changed
185 void afterValuesChanged();
187 /// The signal about widget values are to be restored
188 void beforeValuesRestored();
189 /// The signal about widget values are to be restored
190 void afterValuesRestored();
192 /// The signal about key release on the control, that corresponds to the attribute
193 /// \param theEvent key release event
194 void keyReleased(QKeyEvent* theEvent);
196 /// The signal about the widget is get focus
197 /// \param theWidget the model base widget
198 void focusInWidget(ModuleBase_ModelWidget* theWidget);
200 /// The signal about the widget is lost focus
201 /// \param theWidget the model base widget
202 void focusOutWidget(ModuleBase_ModelWidget* theWidget);
204 /// The signal about value state modification
205 void valueStateChanged(int theState);
208 /// Sets default value of widget. Normally, widget should fetch this value
209 /// from the xml. However, some widgets derived widgets could define it
210 void setDefaultValue(const std::string& theValue);
211 /// \brief Set the attribute name
212 /// \param theAttribute the string value with attribute name
213 void setAttributeID(const std::string& theAttribute)
215 myAttributeID = theAttribute;
218 /// Sets the current value state. If the value is changed, the signal is emitted
219 /// If the current value state is Blocked, this method do nothing
220 /// \param theState a new state
221 /// \return the previous value state
222 ValueState setValueState(const ValueState& theState);
224 /// Blocks the value state change.
225 /// \param theBlocked a block state
226 /// \return the previous value
227 bool blockValueState(const bool theBlocked);
229 /// Compute the feature default value and fill the controls with it
230 /// or store the control value to the feature
231 virtual void initializeValueByActivate();
233 /// Saves the internal parameters to the given feature. Emits signals before and after store
234 /// \return True in success
237 /// Saves the internal parameters to the given feature
238 /// \return True in success
239 virtual bool storeValueCustom() const = 0;
241 /// Restore value from attribute data to the widget's control
242 virtual bool restoreValueCustom() = 0;
244 /// Fills the widget with default values
245 /// \return true if the widget current value is reset
246 virtual bool resetCustom() { return false; };
248 /// The method called when widget is activated
249 virtual void activateCustom() {};
251 /// Sends a message about block/unblock viewer updating
252 /// \param theValue a boolean value
253 static void blockUpdateViewer(const bool theValue);
256 /// Processing of values changed in model widget by store the current value to the feature
257 void onWidgetValuesChanged();
259 /// Changes widget state.
260 void onWidgetValuesModified();
264 /// The attribute name of the model feature
265 std::string myAttributeID;
268 std::string myParentId;
270 /// A feature which is processing by active operation
271 FeaturePtr myFeature;
273 /// Flag which shows that current operation is in editing mode
276 /// Flag which shows whether current widget is obligatory
277 /// The non-obligatory widgets should not accept the focus in the property panel
280 /// The widget value state
284 /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
285 bool myIsComputedDefault;
287 /// the default value, which is defined in the XML for this attribute
288 std::string myDefaultValue;
290 /// the reset state. If it is false, the reset method of the widget is not performed
292 /// blocked flag of modification of the value state
293 bool myIsValueStateBlocked;