1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef MODULEBASE_MODELWIDGET_H
22 #define MODULEBASE_MODELWIDGET_H
24 #include <ModuleBase.h>
25 #include <ModuleBase_ActionType.h>
26 #include <ModuleBase_OperationFeature.h>
27 #include <ModelAPI_Feature.h>
33 class Config_WidgetAPI;
34 class Events_InfoMessage;
35 class ModuleBase_IPropertyPanel;
36 class ModuleBase_IWorkshop;
37 class ModuleBase_ViewerPrs;
38 class ModuleBase_WidgetValidator;
41 /**\class ModuleBase_ModelWidget
43 * \brief An abstract custom widget class. This class realization is assumed
44 * to create some controls.
45 * The controls values modification should send signal about values change.
47 * Common interface for widgets in the property panel.
48 * Every widget are able to save/restore data from the model and/or to contain other widgets.
51 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget
55 /// State of the widget
56 enum ValueState { Stored, /// modification is finished and applyed to the model
57 ModifiedInPP, /// modification has not been finished and set to the model yet
58 ModifiedInViewer, /// modification performed by viewer events
59 Reset }; /// the value is reset
61 enum EnableState { On, /// the widget value is always enabled
62 Off, /// the widget value is always disabled
63 /// the widget value enable state is defined in preferences
64 DefinedInPreferences };
67 /// \param theParent the parent object
68 /// \param theData the widget configuration. The attribute of the model widget is obtained from
69 /// a low-level API for reading xml definitions of widgets
70 ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData);
72 virtual ~ModuleBase_ModelWidget();
74 /// Fills the widget with default values. It calls the resetCustom method and change
75 /// the widget state to Reset if the reset is performed.
76 /// \return true if the widget current value is reset
79 /// Returns the state whether the attribute of the feature is initialized
80 /// \param theObject a model feature to be checked
81 /// \return the boolean result
82 bool isInitialized(ObjectPtr theObject) const;
84 /// Returns true, if default value of the widget should be computed
85 /// on operation's execute, like radius for circle's constraint (can not be zero)
86 bool isComputedDefault() const { return myIsComputedDefault; }
88 /// Returns true, if default value of the widget is defined in the XML and it is not the
90 /// \return the boolean result
91 std::string getDefaultValue() const { return myDefaultValue; }
93 /// Returns true, if widget is internal
94 /// \return the boolean result
95 bool isInternal() const { return myIsInternal; }
97 /// Returns true, if the obligatory value of the widget is
98 /// not defined in the XML or has true value
99 /// \return the boolean result
100 bool isObligatory() const { return myIsObligatory; }
102 /// Returns true, if the widget value is enabled and might be modified manualy.
103 /// It returns false if the application preferences allow having disabled value
104 /// and the internal state tells to disable
105 /// \return the boolean result
106 virtual bool isValueEnabled() const;
108 /// Returns this parameter value in the xml file
109 /// \return the boolean result
110 bool isUseReset() const { return myUseReset; }
112 /// Returns this parameter value in the xml file
113 /// \return the boolean result
114 std::string isModifiedInEdit() const { return myIsModifiedInEdit; }
116 /// Returns this widget value state
117 /// \return the enumeration result
118 ValueState getValueState() const { return myState; }
120 /// Stores the widget value if it is modified
121 void processValueState();
123 /// Returns an attribute error according to the value state
124 /// It exists in all cases excepring the "Store" case
125 Events_InfoMessage getValueStateError() const;
127 /// Defines if it is supposed that the widget should interact with the viewer.
128 virtual bool isViewerSelector() { return false; }
130 /// Defines if it is supported to set the value in this widget
131 /// By default it returns true
132 virtual bool canAcceptFocus() const { return true; };
134 //! Returns the widget error, get it from the attribute validator and state of the widget
135 //! If the feature is correct, it returns an empty value
136 //! \param theValueStateChecked the boolean flag if the state of the widget should be checked
137 //! \return string value
138 QString getError(const bool theValueStateChecked = true) const;
140 /// Set the given wrapped value to the current widget
141 /// This value should be processed in the widget according to the needs
142 /// \param theValues the wrapped selection values
143 /// \param theToValidate the boolean value whether the value should be checked by filters
144 virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
145 const bool theToValidate)
150 /// Returns values which should be highlighted when the whidget is active
151 /// \param theValues a list of presentations
152 virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) {};
154 /// Checks if the selection presentation is valid in widget
155 /// \param theValue a selected presentation in the view
156 /// \return a boolean value
157 virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue)
160 /// Returns widget validator, by default it is NULL. To be created in a child if necessary
161 ModuleBase_WidgetValidator* widgetValidator() { return myWidgetValidator; }
163 /// Restore value from attribute data to the widget's control.
164 /// Emits signals before and after store
165 /// \return True in success
168 /// Saves the internal parameters to the given feature. Emits signals before and after store
169 /// \return True in success
172 /// Set focus to the first control of the current widget.
173 /// The focus policy of the control is checked.
174 /// If the widget has the NonFocus focus policy, it is skipped.
175 /// \return the state whether the widget can accept the focus
176 virtual bool focusTo();
178 /// Select the internal content if it can be selected. It is empty in the default realization
179 virtual void selectContent() {}
181 /// The method called when widget is activated
184 /// The method called when widget is deactivated
185 virtual void deactivate();
187 /// The method called if widget should be activated always
188 virtual bool needToBeActiated() { return false; }
190 /// Returns list of widget controls
191 /// \return a control list
192 virtual QList<QWidget*> getControls() const = 0;
194 /// Returns the first or the last control that can accept the focus
195 /// \param isFirst if true, the first controls is returned or the last one
196 /// \return a control from a list of controls
197 QWidget* getControlAcceptingFocus(const bool isFirst);
199 /// FocusIn events processing
200 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
202 /// \brief Enables processing of focus event on all controls by the widget
203 /// if this widget is not obligatory and set no-focus policy otherwise
204 virtual void enableFocusProcessing();
206 //! Switch On/Off highlighting of the widget
207 virtual void setHighlighted(bool isHighlighted);
209 /// Returns the attribute name
210 /// \returns the string value
211 std::string attributeID() const
213 return myAttributeID;
216 /// \return Current feature
217 FeaturePtr feature() const
222 /// \return Context for translation
223 virtual std::string context() const {
225 std::string aContext = myFeatureId;
226 if(!aContext.empty() && !myAttributeID.empty()) {
229 aContext += myAttributeID;
234 /// Set feature which is processing by active operation
235 /// \param theFeature a feature object
236 /// \param theToStoreValue a value about necessity to store the widget value to the feature
237 /// \param isUpdateFlushed a flag if update should be flushed on store value
238 void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false,
239 const bool isUpdateFlushed = true);
241 /// Editing mode depends on mode of current operation. This value is defined by it.
242 virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
244 /// \return Current Editing mode
245 bool isEditingMode() const { return myIsEditing; }
247 /// Returns true if the action can be processed. By default it is empty and returns false.
248 /// \param theActionType an action type
249 /// \param isActionEnabled if true, the enable state of the action
250 virtual bool canProcessAction(ModuleBase_ActionType theActionType, bool& isActionEnabled);
252 /// Returns true if the event is processed. The default implementation is empty, returns false.
253 virtual bool processAction(ModuleBase_ActionType theActionType);
255 /// Sends Update and Redisplay for the given object
256 /// \param theObj is updating object
257 void updateObject(ObjectPtr theObj);
259 /// Translate passed string with widget context()
260 virtual QString translate(const std::string& theStr) const;
262 /// Emit focus in widget to set this control as active in propety panel
263 void emitFocusInWidget() { emit focusInWidget(this); }
265 /// Finds model widget parent of the given sub widget
266 /// \param theWidget a candidate to be a child of the model widget
267 /// \param theProp a property panel instance
268 /// \return a model widget or NULL
269 static ModuleBase_ModelWidget* findModelWidget(ModuleBase_IPropertyPanel* theProp,
272 /// The signal about widget values are to be changed
273 void beforeValuesChanged();
274 /// The signal about widget values changed
275 void valuesChanged();
276 /// The signal about widget values modified
277 void valuesModified();
278 /// The signal about widget values are to be changed
279 void afterValuesChanged();
281 /// The signal about widget values are to be restored
282 void beforeValuesRestored();
283 /// The signal about widget values are to be restored
284 void afterValuesRestored();
286 /// The signal about key release on the control, that corresponds to the attribute
287 /// \param theObject a sender of the event
288 /// \param theEvent key release event
289 void keyReleased(QObject* theObject, QKeyEvent* theEvent);
291 /// The signal is emitted if the enter is clicked in the control of the widget
292 /// \param theObject a sender of the event
293 void enterClicked(QObject* theObject);
295 /// The signal about the widget is get focus
296 /// \param theWidget the model base widget
297 void focusInWidget(ModuleBase_ModelWidget* theWidget);
299 /// The signal about the widget is lost focus
300 /// \param theWidget the model base widget
301 void focusOutWidget(ModuleBase_ModelWidget* theWidget);
303 /// The signal about value state modification
304 void valueStateChanged(int theState);
306 /// The signal is emitted after flush of updates singal for the widget
307 void objectUpdated();
310 /// Sets default value of widget. Normally, widget should fetch this value
311 /// from the xml. However, some widgets derived widgets could define it
312 void setDefaultValue(const std::string& theValue);
313 /// \brief Set the attribute name
314 /// \param theAttribute the string value with attribute name
315 void setAttributeID(const std::string& theAttribute)
317 myAttributeID = theAttribute;
320 /// Sets the current value state. If the value is changed, the signal is emitted
321 /// If the current value state is Blocked, this method do nothing
322 /// \param theState a new state
323 /// \return the previous value state
324 ValueState setValueState(const ValueState& theState);
326 /// Blocks the value state change.
327 /// \param theBlocked a block state
328 /// \return the previous value
329 bool blockValueState(const bool theBlocked);
331 /// Compute the feature default value and fill the controls with it
332 /// or store the control value to the feature
333 virtual void initializeValueByActivate();
335 /// Saves the internal parameters to the given feature
336 /// \return True in success
337 virtual bool storeValueCustom() = 0;
339 /// Restore value from attribute data to the widget's control
340 virtual bool restoreValueCustom() = 0;
342 /// Fills the widget with default values
343 /// \return true if the widget current value is reset
344 virtual bool resetCustom() { return false; };
346 /// The method called when widget is activated
347 virtual void activateCustom() {};
349 //// Returns true if the event is processed. The default implementation is empty, returns false.
350 virtual bool processEnter();
352 //// Returns true if the event is processed. The default implementation is empty, returns false.
353 virtual bool processEscape();
355 //// Returns true if the event is processed. The default implementation is empty, returns false.
356 virtual bool processDelete();
359 /// Processing of values changed in model widget by store the current value to the feature
360 void onWidgetValuesChanged();
362 /// Changes widget state.
363 void onWidgetValuesModified();
366 /// own validator, by default it is zero
367 ModuleBase_WidgetValidator* myWidgetValidator;
369 /// The attribute name of the model feature
370 std::string myAttributeID;
372 /// A feature which is processing by active operation
373 FeaturePtr myFeature;
376 std::string myFeatureId;
378 /// Flag which shows that current operation is in editing mode
381 /// Flag which shows whether current widget is obligatory
382 /// The non-obligatory widgets should not accept the focus in the property panel
385 /// Flag about value of the control is enabled (can be modified)
386 EnableState myIsValueEnabled;
388 /// The widget value state
392 /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
393 bool myIsComputedDefault;
395 /// the default value, which is defined in the XML for this attribute
396 std::string myDefaultValue;
398 /// an XML internal state
401 // an XML state, the value is not stored into model if the widget is in edit mode
402 std::string myIsModifiedInEdit;
404 /// the reset state. If it is false, the reset method of the widget is not performed
406 /// blocked flag of modification of the value state
407 bool myIsValueStateBlocked;
408 /// do not flush updated signal
409 bool myFlushUpdateBlocked;