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 theData a low-level API for reading xml definitions of widgets
46 ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData);
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 widget is internal
72 /// \return the boolean result
73 bool isInternal() const { return myIsInternal; }
75 /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value
76 /// \return the boolean result
77 bool isObligatory() const { return myIsObligatory; }
79 /// Returns this parameter value in the xml file
80 /// \return the boolean result
81 bool isUseReset() const { return myUseReset; }
83 /// Returns this widget value state
84 /// \return the enumeration result
85 ValueState getValueState() const { return myState; }
87 /// Returns an attribute error according to the value state
88 /// It exists in all cases excepring the "Store" case
89 QString getValueStateError() const;
91 /// Defines if it is supposed that the widget should interact with the viewer.
92 virtual bool isViewerSelector() { return false; }
94 /// Defines if it is supported to set the value in this widget
95 /// By default it returns true
96 virtual bool canAcceptFocus() const { return true; };
98 //! Returns the widget error, get it from the attribute validator and state of the widget
99 //! If the feature is correct, it returns an empty value
100 //! \return string value
101 QString getError() const;
103 /// Set the given wrapped value to the current widget
104 /// This value should be processed in the widget according to the needs
105 /// \param theValues the wrapped selection values
106 /// \param theToValidate the boolean value whether the value should be checked by filters
107 virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
108 const bool theToValidate)
113 /// Returns values which should be highlighted when the whidget is active
114 /// \param theValues a list of presentations
115 virtual void getHighlighted(QList<ModuleBase_ViewerPrs>& theValues) {};
117 /// Restore value from attribute data to the widget's control. Emits signals before and after store
118 /// \return True in success
121 /// Set focus to the first control of the current widget. The focus policy of the control is checked.
122 /// If the widget has the NonFocus focus policy, it is skipped.
123 /// \return the state whether the widget can accept the focus
124 virtual bool focusTo();
126 /// Select the internal content if it can be selected. It is empty in the default realization
127 virtual void selectContent() {}
129 /// The method called when widget is activated
132 /// The method called when widget is deactivated
133 virtual void deactivate();
135 /// Returns list of widget controls
136 /// \return a control list
137 virtual QList<QWidget*> getControls() const = 0;
139 /// Returns the first or the last control that can accept the focus
140 /// \param isFirst if true, the first controls is returned or the last one
141 /// \return a control from a list of controls
142 QWidget* getControlAcceptingFocus(const bool isFirst);
144 /// FocusIn events processing
145 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
147 /// \brief Enables processing of focus event on all controls by the widget
148 /// if this widget is not obligatory and set no-focus policy otherwise
149 virtual void enableFocusProcessing();
151 //! Switch On/Off highlighting of the widget
152 virtual void setHighlighted(bool isHighlighted);
154 /// Returns the attribute name
155 /// \returns the string value
156 std::string attributeID() const
158 return myAttributeID;
161 /// \return Current feature
162 FeaturePtr feature() const
167 /// Set feature which is processing by active operation
168 /// \param theFeature a feature object
169 /// \param theToStoreValue a value about necessity to store the widget value to the feature
170 void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
172 /// Editing mode depends on mode of current operation. This value is defined by it.
173 void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
175 /// \return Current Editing mode
176 bool isEditingMode() const { return myIsEditing; }
178 /// Returns true if the event is processed. The default implementation is empty, returns false.
179 virtual bool processEnter();
181 /// Returns true if the event is processed. The default implementation is empty, returns false.
182 virtual bool processDelete();
184 /// Sends Update and Redisplay for the given object
185 /// \param theObj is updating object
186 static void updateObject(ObjectPtr theObj);
188 /// Sends Move event for the given object
189 /// \param theObj is object for moving
190 static void moveObject(ObjectPtr theObj);
192 /// Sends a message about block/unblock viewer updating
193 /// \param theValue a boolean value
194 static void blockUpdateViewer(const bool theValue);
197 /// The signal about widget values are to be changed
198 void beforeValuesChanged();
199 /// The signal about widget values changed
200 void valuesChanged();
201 /// The signal about widget values modified
202 void valuesModified();
203 /// The signal about widget values are to be changed
204 void afterValuesChanged();
206 /// The signal about widget values are to be restored
207 void beforeValuesRestored();
208 /// The signal about widget values are to be restored
209 void afterValuesRestored();
211 /// The signal about key release on the control, that corresponds to the attribute
212 /// \param theObject a sender of the event
213 /// \param theEvent key release event
214 void keyReleased(QObject* theObject, QKeyEvent* theEvent);
216 /// The signal is emitted if the enter is clicked in the control of the widget
217 /// \param theObject a sender of the event
218 void enterClicked(QObject* theObject);
220 /// The signal about the widget is get focus
221 /// \param theWidget the model base widget
222 void focusInWidget(ModuleBase_ModelWidget* theWidget);
224 /// The signal about the widget is lost focus
225 /// \param theWidget the model base widget
226 void focusOutWidget(ModuleBase_ModelWidget* theWidget);
228 /// The signal about value state modification
229 void valueStateChanged(int theState);
232 /// Sets default value of widget. Normally, widget should fetch this value
233 /// from the xml. However, some widgets derived widgets could define it
234 void setDefaultValue(const std::string& theValue);
235 /// \brief Set the attribute name
236 /// \param theAttribute the string value with attribute name
237 void setAttributeID(const std::string& theAttribute)
239 myAttributeID = theAttribute;
242 /// Sets the current value state. If the value is changed, the signal is emitted
243 /// If the current value state is Blocked, this method do nothing
244 /// \param theState a new state
245 /// \return the previous value state
246 ValueState setValueState(const ValueState& theState);
248 /// Blocks the value state change.
249 /// \param theBlocked a block state
250 /// \return the previous value
251 bool blockValueState(const bool theBlocked);
253 /// Compute the feature default value and fill the controls with it
254 /// or store the control value to the feature
255 virtual void initializeValueByActivate();
257 /// Saves the internal parameters to the given feature. Emits signals before and after store
258 /// \return True in success
261 /// Saves the internal parameters to the given feature
262 /// \return True in success
263 virtual bool storeValueCustom() const = 0;
265 /// Restore value from attribute data to the widget's control
266 virtual bool restoreValueCustom() = 0;
268 /// Fills the widget with default values
269 /// \return true if the widget current value is reset
270 virtual bool resetCustom() { return false; };
272 /// The method called when widget is activated
273 virtual void activateCustom() {};
276 /// Processing of values changed in model widget by store the current value to the feature
277 void onWidgetValuesChanged();
279 /// Changes widget state.
280 void onWidgetValuesModified();
284 /// The attribute name of the model feature
285 std::string myAttributeID;
287 /// A feature which is processing by active operation
288 FeaturePtr myFeature;
290 /// Flag which shows that current operation is in editing mode
293 /// Flag which shows whether current widget is obligatory
294 /// The non-obligatory widgets should not accept the focus in the property panel
297 /// The widget value state
301 /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
302 bool myIsComputedDefault;
304 /// the default value, which is defined in the XML for this attribute
305 std::string myDefaultValue;
307 /// an XML internal state
310 /// the reset state. If it is false, the reset method of the widget is not performed
312 /// blocked flag of modification of the value state
313 bool myIsValueStateBlocked;
315 friend class ModuleBase_OperationFeature; // to call storeValue() by commit if value state is ModifiedInPP