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
37 /// \param theParent the parent object
38 /// \param theData the widget configuration. The attribute of the model widget is obtained from
39 /// \param theParentId is Id of a parent of the current attribute
40 ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData,
41 const std::string& theParentId);
43 virtual ~ModuleBase_ModelWidget()
47 /// Fills the widget with default values
48 /// \return true if the widget current value is reset
49 virtual bool reset() { return false; };
51 /// Returns the state whether the attribute of the feature is initialized
52 /// \param theObject a model feature to be checked
53 /// \return the boolean result
54 bool isInitialized(ObjectPtr theObject) const;
56 /// Returns true, if default value of the widget should be computed
57 /// on operation's execute, like radius for circle's constraint (can not be zero)
58 bool isComputedDefault() const { return myIsComputedDefault; }
60 /// Returns true, if default value of the widget is defined in the XML and it is not the
62 /// \return the boolean result
63 std::string getDefaultValue() const { return myDefaultValue; }
65 /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value
66 /// \return the boolean result
67 bool isObligatory() const { return myIsObligatory; }
69 /// Returns this parameter value in the xml file
70 /// \return the boolean result
71 bool isUseReset() const { return myUseReset; }
73 /// Defines if it is supposed that the widget should interact with the viewer.
74 virtual bool isViewerSelector() { return false; }
76 /// Defines if it is supported to set the value in this widget
77 /// By default it returns true
78 virtual bool canSetValue() const { return true; };
80 /// Set the given wrapped value to the current widget
81 /// This value should be processed in the widget according to the needs
82 /// \param theValues the wrapped selection values
83 /// \param theToValidate the boolean value whether the value should be checked by filters
84 virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
85 const bool theToValidate)
90 /// Restore value from attribute data to the widget's control. Emits signals before and after store
91 /// \return True in success
94 /// Set focus to the first control of the current widget. The focus policy of the control is checked.
95 /// If the widget has the NonFocus focus policy, it is skipped.
96 /// \return the state whether the widget can accept the focus
97 virtual bool focusTo();
99 /// The method called when widget is activated
102 /// The method called when widget is deactivated
103 virtual void deactivate() {}
105 /// Returns list of widget controls
106 /// \return a control list
107 virtual QList<QWidget*> getControls() const = 0;
109 /// FocusIn events processing
110 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
112 /// \brief Enables processing of focus event on all controls by the widget
113 /// if this widget is not obligatory and set no-focus policy otherwise
114 virtual void enableFocusProcessing();
116 //! Switch On/Off highlighting of the widget
117 virtual void setHighlighted(bool isHighlighted);
119 /// Returns the attribute name
120 /// \returns the string value
121 std::string attributeID() const
123 return myAttributeID;
126 /// Returns the parent of the attribute
127 /// \returns the string value
128 std::string parentID() const
133 /// \return Current feature
134 FeaturePtr feature() const
139 /// Set feature which is processing by active operation
140 /// \param theFeature a feature object
141 /// \param theToStoreValue a value about necessity to store the widget value to the feature
142 void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
144 /// Editing mode depends on mode of current operation. This value is defined by it.
145 void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
147 /// \return Current Editing mode
148 bool isEditingMode() const { return myIsEditing; }
150 /// Sends Update and Redisplay for the given object
151 /// \param theObj is updating object
152 static void updateObject(ObjectPtr theObj);
154 /// Sends Move event for the given object
155 /// \param theObj is object for moving
156 static void moveObject(ObjectPtr theObj);
159 /// The signal about widget values are to be changed
160 void beforeValuesChanged();
161 /// The signal about widget values changed
162 void valuesChanged();
163 /// The signal about widget values are to be changed
164 void afterValuesChanged();
166 /// The signal about widget values are to be restored
167 void beforeValuesRestored();
168 /// The signal about widget values are to be restored
169 void afterValuesRestored();
171 /// The signal about key release on the control, that corresponds to the attribute
172 /// \param theEvent key release event
173 void keyReleased(QKeyEvent* theEvent);
175 /// The signal about the widget is get focus
176 /// \param theWidget the model base widget
177 void focusInWidget(ModuleBase_ModelWidget* theWidget);
179 /// The signal about the widget is lost focus
180 /// \param theWidget the model base widget
181 void focusOutWidget(ModuleBase_ModelWidget* theWidget);
184 /// Sets default value of widget. Normally, widget should fetch this value
185 /// from the xml. However, some widgets derived widgets could define it
186 void setDefaultValue(const std::string& theValue);
187 /// \brief Set the attribute name
188 /// \param theAttribute the string value with attribute name
189 void setAttributeID(const std::string& theAttribute)
191 myAttributeID = theAttribute;
194 /// Saves the internal parameters to the given feature. Emits signals before and after store
195 /// \return True in success
198 /// Saves the internal parameters to the given feature
199 /// \return True in success
200 virtual bool storeValueCustom() const = 0;
202 /// Restore value from attribute data to the widget's control
203 virtual bool restoreValueCustom() = 0;
205 /// The method called when widget is activated
206 virtual void activateCustom() {};
208 /// Sends a message about block/unblock viewer updating
209 /// \param theValue a boolean value
210 static void blockUpdateViewer(const bool theValue);
213 /// Processing of values changed in model widget by store the current value to the feature
214 void onWidgetValuesChanged();
218 /// The attribute name of the model feature
219 std::string myAttributeID;
222 std::string myParentId;
224 /// A feature which is processing by active operation
225 FeaturePtr myFeature;
227 /// Flag which shows that current operation is in editing mode
230 /// Flag which shows whether current widget is obligatory
231 /// The non-obligatory widgets should not accept the focus in the property panel
235 /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
236 bool myIsComputedDefault;
238 /// the default value, which is defined in the XML for this attribute
239 std::string myDefaultValue;
241 /// the reset state. If it is false, the reset method of the widget is not performed