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>
12 #include <ModuleBase_OperationFeature.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 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 canSetValue() 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<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<ModuleBase_ViewerPrs>& theValues) {};
118 /// Restore value from attribute data to the widget's control. Emits signals before and after store
119 /// \return True in success
122 /// Set focus to the first control of the current widget. The focus policy of the control is checked.
123 /// If the widget has the NonFocus focus policy, it is skipped.
124 /// \return the state whether the widget can accept the focus
125 virtual bool focusTo();
127 /// Select the internal content if it can be selected. It is empty in the default realization
128 virtual void selectContent() {}
130 /// The method called when widget is activated
133 /// The method called when widget is deactivated
134 virtual void deactivate();
136 /// Returns list of widget controls
137 /// \return a control list
138 virtual QList<QWidget*> getControls() const = 0;
140 /// Returns the first or the last control that can accept the focus
141 /// \param isFirst if true, the first controls is returned or the last one
142 /// \return a control from a list of controls
143 QWidget* getControlAcceptingFocus(const bool isFirst);
145 /// FocusIn events processing
146 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
148 /// \brief Enables processing of focus event on all controls by the widget
149 /// if this widget is not obligatory and set no-focus policy otherwise
150 virtual void enableFocusProcessing();
152 //! Switch On/Off highlighting of the widget
153 virtual void setHighlighted(bool isHighlighted);
155 /// Returns the attribute name
156 /// \returns the string value
157 std::string attributeID() const
159 return myAttributeID;
162 /// Returns the parent of the attribute
163 /// \returns the string value
164 std::string parentID() const
169 /// \return Current feature
170 FeaturePtr feature() const
175 /// Set feature which is processing by active operation
176 /// \param theFeature a feature object
177 /// \param theToStoreValue a value about necessity to store the widget value to the feature
178 void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
180 /// Editing mode depends on mode of current operation. This value is defined by it.
181 void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
183 /// \return Current Editing mode
184 bool isEditingMode() const { return myIsEditing; }
186 /// Returns true if the event is processed. The default implementation is empty, returns false.
187 virtual bool processEnter();
189 /// Returns true if the event is processed. The default implementation is empty, returns false.
190 virtual bool processDelete();
192 /// Sends Update and Redisplay for the given object
193 /// \param theObj is updating object
194 static void updateObject(ObjectPtr theObj);
196 /// Sends Move event for the given object
197 /// \param theObj is object for moving
198 static void moveObject(ObjectPtr theObj);
200 /// Sends a message about block/unblock viewer updating
201 /// \param theValue a boolean value
202 static void blockUpdateViewer(const bool theValue);
205 /// The signal about widget values are to be changed
206 void beforeValuesChanged();
207 /// The signal about widget values changed
208 void valuesChanged();
209 /// The signal about widget values modified
210 void valuesModified();
211 /// The signal about widget values are to be changed
212 void afterValuesChanged();
214 /// The signal about widget values are to be restored
215 void beforeValuesRestored();
216 /// The signal about widget values are to be restored
217 void afterValuesRestored();
219 /// The signal about key release on the control, that corresponds to the attribute
220 /// \param theObject a sender of the event
221 /// \param theEvent key release event
222 void keyReleased(QObject* theObject, QKeyEvent* theEvent);
224 /// The signal is emitted if the enter is clicked in the control of the widget
225 /// \param theObject a sender of the event
226 void enterClicked(QObject* theObject);
228 /// The signal about the widget is get focus
229 /// \param theWidget the model base widget
230 void focusInWidget(ModuleBase_ModelWidget* theWidget);
232 /// The signal about the widget is lost focus
233 /// \param theWidget the model base widget
234 void focusOutWidget(ModuleBase_ModelWidget* theWidget);
236 /// The signal about value state modification
237 void valueStateChanged(int theState);
240 /// Sets default value of widget. Normally, widget should fetch this value
241 /// from the xml. However, some widgets derived widgets could define it
242 void setDefaultValue(const std::string& theValue);
243 /// \brief Set the attribute name
244 /// \param theAttribute the string value with attribute name
245 void setAttributeID(const std::string& theAttribute)
247 myAttributeID = theAttribute;
250 /// Sets the current value state. If the value is changed, the signal is emitted
251 /// If the current value state is Blocked, this method do nothing
252 /// \param theState a new state
253 /// \return the previous value state
254 ValueState setValueState(const ValueState& theState);
256 /// Blocks the value state change.
257 /// \param theBlocked a block state
258 /// \return the previous value
259 bool blockValueState(const bool theBlocked);
261 /// Compute the feature default value and fill the controls with it
262 /// or store the control value to the feature
263 virtual void initializeValueByActivate();
265 /// Saves the internal parameters to the given feature. Emits signals before and after store
266 /// \return True in success
269 /// Saves the internal parameters to the given feature
270 /// \return True in success
271 virtual bool storeValueCustom() const = 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();
292 /// The attribute name of the model feature
293 std::string myAttributeID;
296 std::string myParentId;
298 /// A feature which is processing by active operation
299 FeaturePtr myFeature;
301 /// Flag which shows that current operation is in editing mode
304 /// Flag which shows whether current widget is obligatory
305 /// The non-obligatory widgets should not accept the focus in the property panel
308 /// The widget value state
312 /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
313 bool myIsComputedDefault;
315 /// the default value, which is defined in the XML for this attribute
316 std::string myDefaultValue;
318 /// an XML internal state
321 /// the reset state. If it is false, the reset method of the widget is not performed
323 /// blocked flag of modification of the value state
324 bool myIsValueStateBlocked;
326 friend class ModuleBase_OperationFeature; // to call storeValue() by commit if value state is ModifiedInPP