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_OperationFeature.h>
12 #include <ModelAPI_Feature.h>
18 class Config_WidgetAPI;
19 class ModuleBase_IWorkshop;
20 class ModuleBase_ViewerPrs;
21 class ModuleBase_WidgetValidator;
24 /**\class ModuleBase_ModelWidget
26 * \brief An abstract custom widget class. This class realization is assumed to create some controls.
27 * The controls values modification should send signal about values change.
29 * Common interface for widgets in the property panel.
30 * Every widget are able to save/restore data from the model and/or to contain other widgets.
33 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget
37 /// State of the widget
38 enum ValueState { Stored, /// modification is finished and applyed to the model
39 ModifiedInPP, /// modification has not been finished and set to the model yet
40 ModifiedInViewer, /// modification performed by viewer events
41 Reset }; /// the value is reset
44 /// \param theParent the parent object
45 /// \param theData the widget configuration. The attribute of the model widget is obtained from
46 /// \param theData a low-level API for reading xml definitions of widgets
47 ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData);
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 widget is internal
73 /// \return the boolean result
74 bool isInternal() const { return myIsInternal; }
76 /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value
77 /// \return the boolean result
78 bool isObligatory() const { return myIsObligatory; }
80 /// Returns this parameter value in the xml file
81 /// \return the boolean result
82 bool isUseReset() const { return myUseReset; }
84 /// Returns this widget value state
85 /// \return the enumeration result
86 ValueState getValueState() const { return myState; }
88 /// Returns an attribute error according to the value state
89 /// It exists in all cases excepring the "Store" case
90 QString getValueStateError() const;
92 /// Defines if it is supposed that the widget should interact with the viewer.
93 virtual bool isViewerSelector() { return false; }
95 /// Defines if it is supported to set the value in this widget
96 /// By default it returns true
97 virtual bool canAcceptFocus() const { return true; };
99 //! Returns the widget error, get it from the attribute validator and state of the widget
100 //! If the feature is correct, it returns an empty value
101 //! \return string value
102 QString getError() const;
104 /// Set the given wrapped value to the current widget
105 /// This value should be processed in the widget according to the needs
106 /// \param theValues the wrapped selection values
107 /// \param theToValidate the boolean value whether the value should be checked by filters
108 virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
109 const bool theToValidate)
114 /// Returns values which should be highlighted when the whidget is active
115 /// \param theValues a list of presentations
116 virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) {};
118 /// Checks if the selection presentation is valid in widget
119 /// \param theValue a selected presentation in the view
120 /// \return a boolean value
121 virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue) { return true; }
123 /// Returns widget validator, by default it is NULL. To be created in a child if necessary
124 ModuleBase_WidgetValidator* widgetValidator() { return myWidgetValidator; }
126 /// Restore value from attribute data to the widget's control. Emits signals before and after store
127 /// \return True in success
130 /// Saves the internal parameters to the given feature. Emits signals before and after store
131 /// \return True in success
134 /// Set focus to the first control of the current widget. The focus policy of the control is checked.
135 /// If the widget has the NonFocus focus policy, it is skipped.
136 /// \return the state whether the widget can accept the focus
137 virtual bool focusTo();
139 /// Select the internal content if it can be selected. It is empty in the default realization
140 virtual void selectContent() {}
142 /// The method called when widget is activated
145 /// The method called when widget is deactivated
146 virtual void deactivate();
148 /// Returns list of widget controls
149 /// \return a control list
150 virtual QList<QWidget*> getControls() const = 0;
152 /// Returns the first or the last control that can accept the focus
153 /// \param isFirst if true, the first controls is returned or the last one
154 /// \return a control from a list of controls
155 QWidget* getControlAcceptingFocus(const bool isFirst);
157 /// FocusIn events processing
158 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
160 /// \brief Enables processing of focus event on all controls by the widget
161 /// if this widget is not obligatory and set no-focus policy otherwise
162 virtual void enableFocusProcessing();
164 //! Switch On/Off highlighting of the widget
165 virtual void setHighlighted(bool isHighlighted);
167 /// Returns the attribute name
168 /// \returns the string value
169 std::string attributeID() const
171 return myAttributeID;
174 /// \return Current feature
175 FeaturePtr feature() const
180 /// Set feature which is processing by active operation
181 /// \param theFeature a feature object
182 /// \param theToStoreValue a value about necessity to store the widget value to the feature
183 void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
185 /// Editing mode depends on mode of current operation. This value is defined by it.
186 virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
188 /// \return Current Editing mode
189 bool isEditingMode() const { return myIsEditing; }
191 /// Returns true if the event is processed. The default implementation is empty, returns false.
192 virtual bool processEnter();
194 /// Returns true if the event is processed. The default implementation is empty, returns false.
195 virtual bool processDelete();
197 /// Sends Update and Redisplay for the given object
198 /// \param theObj is updating object
199 void updateObject(ObjectPtr theObj);
201 /// Sends Move event for the given object
202 /// \param theObj is object for moving
203 static void moveObject(ObjectPtr theObj);
206 /// The signal about widget values are to be changed
207 void beforeValuesChanged();
208 /// The signal about widget values changed
209 void valuesChanged();
210 /// The signal about widget values modified
211 void valuesModified();
212 /// The signal about widget values are to be changed
213 void afterValuesChanged();
215 /// The signal about widget values are to be restored
216 void beforeValuesRestored();
217 /// The signal about widget values are to be restored
218 void afterValuesRestored();
220 /// The signal about key release on the control, that corresponds to the attribute
221 /// \param theObject a sender of the event
222 /// \param theEvent key release event
223 void keyReleased(QObject* theObject, QKeyEvent* theEvent);
225 /// The signal is emitted if the enter is clicked in the control of the widget
226 /// \param theObject a sender of the event
227 void enterClicked(QObject* theObject);
229 /// The signal about the widget is get focus
230 /// \param theWidget the model base widget
231 void focusInWidget(ModuleBase_ModelWidget* theWidget);
233 /// The signal about the widget is lost focus
234 /// \param theWidget the model base widget
235 void focusOutWidget(ModuleBase_ModelWidget* theWidget);
237 /// The signal about value state modification
238 void valueStateChanged(int theState);
240 /// The signal is emitted after flush of updates singal for the widget
241 void objectUpdated();
244 /// Sets default value of widget. Normally, widget should fetch this value
245 /// from the xml. However, some widgets derived widgets could define it
246 void setDefaultValue(const std::string& theValue);
247 /// \brief Set the attribute name
248 /// \param theAttribute the string value with attribute name
249 void setAttributeID(const std::string& theAttribute)
251 myAttributeID = theAttribute;
254 /// Sets the current value state. If the value is changed, the signal is emitted
255 /// If the current value state is Blocked, this method do nothing
256 /// \param theState a new state
257 /// \return the previous value state
258 ValueState setValueState(const ValueState& theState);
260 /// Blocks the value state change.
261 /// \param theBlocked a block state
262 /// \return the previous value
263 bool blockValueState(const bool theBlocked);
265 /// Compute the feature default value and fill the controls with it
266 /// or store the control value to the feature
267 virtual void initializeValueByActivate();
269 /// Saves the internal parameters to the given feature
270 /// \return True in success
271 virtual bool storeValueCustom() = 0;
273 /// Restore value from attribute data to the widget's control
274 virtual bool restoreValueCustom() = 0;
276 /// Fills the widget with default values
277 /// \return true if the widget current value is reset
278 virtual bool resetCustom() { return false; };
280 /// The method called when widget is activated
281 virtual void activateCustom() {};
284 /// Processing of values changed in model widget by store the current value to the feature
285 void onWidgetValuesChanged();
287 /// Changes widget state.
288 void onWidgetValuesModified();
291 ModuleBase_WidgetValidator* myWidgetValidator; /// own validator, by default it is zero
293 /// The attribute name of the model feature
294 std::string myAttributeID;
296 /// A feature which is processing by active operation
297 FeaturePtr myFeature;
299 /// Flag which shows that current operation is in editing mode
302 /// Flag which shows whether current widget is obligatory
303 /// The non-obligatory widgets should not accept the focus in the property panel
306 /// The widget value state
310 /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
311 bool myIsComputedDefault;
313 /// the default value, which is defined in the XML for this attribute
314 std::string myDefaultValue;
316 /// an XML internal state
319 /// the reset state. If it is false, the reset method of the widget is not performed
321 /// blocked flag of modification of the value state
322 bool myIsValueStateBlocked;