]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModuleBase/ModuleBase_ModelWidget.h
Salome HOME
Merge branch 'Dev_2.8.0'
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef MODULEBASE_MODELWIDGET_H
22 #define MODULEBASE_MODELWIDGET_H
23
24 #include <ModuleBase.h>
25 #include <ModuleBase_OperationFeature.h>
26 #include <ModelAPI_Feature.h>
27
28 #include <QWidget>
29
30 #include <memory>
31
32 class Config_WidgetAPI;
33 class Events_InfoMessage;
34 class ModuleBase_IPropertyPanel;
35 class ModuleBase_IWorkshop;
36 class ModuleBase_ViewerPrs;
37 class ModuleBase_WidgetValidator;
38 class QKeyEvent;
39
40 /**\class ModuleBase_ModelWidget
41  * \ingroup GUI
42  * \brief An abstract custom widget class. This class realization is assumed 
43  * to create some controls.
44  * The controls values modification should send signal about values change.
45  *
46  * Common interface for widgets in the property panel.
47  * Every widget are able to save/restore data from the model and/or to contain other widgets.
48  *
49  */
50 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget
51 {
52 Q_OBJECT
53  public:
54    /// State of the widget
55    enum ValueState { Stored, /// modification is finished and applyed to the model
56                      ModifiedInPP, /// modification has not been finished and set to the model yet
57                      ModifiedInViewer, /// modification performed by viewer events
58                      Reset }; /// the value is reset
59
60    enum EnableState { On,  /// the widget value is always enabled
61                       Off, /// the widget value is always disabled
62                       /// the widget value enable state is defined in preferences
63                       DefinedInPreferences };
64
65   /// Constructor
66   /// \param theParent the parent object
67   /// \param theData the widget configuration. The attribute of the model widget is obtained from
68   /// a low-level API for reading xml definitions of widgets
69   ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData);
70   /// Destructor
71   virtual ~ModuleBase_ModelWidget();
72
73   /// Fills the widget with default values. It calls the resetCustom method and change
74   /// the widget state to Reset if the reset is performed.
75   /// \return true if the widget current value is reset
76   bool reset();
77
78   /// Returns the state whether the attribute of the feature is initialized
79   /// \param theObject a model feature to be checked
80   /// \return the boolean result
81   bool isInitialized(ObjectPtr theObject) const;
82
83   /// Returns true, if default value of the widget should be computed
84   /// on operation's execute, like radius for circle's constraint (can not be zero)
85   bool isComputedDefault() const { return myIsComputedDefault; }
86
87   /// Returns true, if default value of the widget is defined in the XML and it is not the
88   /// computed value
89   /// \return the boolean result
90   std::string getDefaultValue() const { return myDefaultValue; }
91
92   /// Returns true, if widget is internal
93   /// \return the boolean result
94   bool isInternal() const { return myIsInternal; }
95
96   /// Returns true, if the obligatory value of the widget is
97   /// not defined in the XML or has true value
98   /// \return the boolean result
99   bool isObligatory() const { return myIsObligatory; }
100
101   /// Returns true, if the widget value is enabled and might be modified manualy.
102   /// It returns false if the application preferences allow having disabled value
103   /// and the internal state tells to disable
104   /// \return the boolean result
105   virtual bool isValueEnabled() const;
106
107   /// Returns this parameter value in the xml file
108   /// \return the boolean result
109   bool isUseReset() const { return myUseReset; }
110
111   /// Returns this parameter value in the xml file
112   /// \return the boolean result
113   std::string isModifiedInEdit() const { return myIsModifiedInEdit; }
114
115   /// Returns this widget value state
116   /// \return the enumeration result
117   ValueState getValueState() const { return myState; }
118
119   /// Stores the widget value if it is modified
120   void processValueState();
121
122   /// Returns an attribute error according to the value state
123   /// It exists in all cases excepring the "Store" case
124   Events_InfoMessage getValueStateError() const;
125
126   /// Defines if it is supposed that the widget should interact with the viewer.
127   virtual bool isViewerSelector() { return false; }
128
129   /// Defines if it is supported to set the value in this widget
130   /// By default it returns true
131   virtual bool canAcceptFocus() const { return true; };
132
133   //! Returns the widget error, get it from the attribute validator and state of the widget
134   //! If the feature is correct, it returns an empty value
135   //! \param theValueStateChecked the boolean flag if the state of the widget should be checked
136   //! \return string value
137   QString getError(const bool theValueStateChecked = true) const;
138
139   /// Set the given wrapped value to the current widget
140   /// This value should be processed in the widget according to the needs
141   /// \param theValues the wrapped selection values
142   /// \param theToValidate the boolean value whether the value should be checked by filters
143   virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
144                             const bool theToValidate)
145   {
146     return false;
147   }
148
149   /// Returns values which should be highlighted when the whidget is active
150   /// \param theValues a list of presentations
151   virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) {};
152
153   /// Checks if the selection presentation is valid in widget
154   /// \param theValue a selected presentation in the view
155   /// \return a boolean value
156   virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue)
157   { return true; }
158
159   /// Returns widget validator, by default it is NULL. To be created in a child if necessary
160   ModuleBase_WidgetValidator* widgetValidator() { return myWidgetValidator; }
161
162   /// Restore value from attribute data to the widget's control.
163   /// Emits signals before and after store
164   /// \return True in success
165   bool restoreValue();
166
167   /// Saves the internal parameters to the given feature. Emits signals before and after store
168   /// \return True in success
169   bool storeValue();
170
171   /// Set focus to the first control of the current widget.
172   /// The focus policy of the control is checked.
173   /// If the widget has the NonFocus focus policy, it is skipped.
174   /// \return the state whether the widget can accept the focus
175   virtual bool focusTo();
176
177   /// Select the internal content if it can be selected. It is empty in the default realization
178   virtual void selectContent() {}
179
180   /// The method called when widget is activated
181   void activate();
182
183   /// The method called when widget is deactivated
184   virtual void deactivate();
185
186   /// Returns list of widget controls
187   /// \return a control list
188   virtual QList<QWidget*> getControls() const = 0;
189
190   /// Returns the first or the last control that can accept the focus
191   /// \param isFirst if true, the first controls is returned or the last one
192   /// \return a control from a list of controls
193   QWidget* getControlAcceptingFocus(const bool isFirst);
194
195   /// FocusIn events processing
196   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
197
198   /// \brief Enables processing of focus event on all controls by the widget
199   /// if this widget is not obligatory and set no-focus policy otherwise
200   virtual void enableFocusProcessing();
201
202   //! Switch On/Off highlighting of the widget
203   virtual void setHighlighted(bool isHighlighted);
204
205   /// Returns the attribute name
206   /// \returns the string value
207   std::string attributeID() const
208   {
209     return myAttributeID;
210   }
211
212   /// \return Current feature
213   FeaturePtr feature() const
214   {
215     return myFeature;
216   }
217
218   /// \return Context for translation
219   virtual std::string context() const {
220
221     std::string aContext = myFeatureId;
222     if(!aContext.empty() && !myAttributeID.empty()) {
223       aContext += ":";
224     }
225     aContext += myAttributeID;
226
227     return aContext;
228   }
229
230   /// Set feature which is processing by active operation
231   /// \param theFeature a feature object
232   /// \param theToStoreValue a value about necessity to store the widget value to the feature
233   /// \param isUpdateFlushed a flag if update should be flushed on store value
234   void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false,
235                   const bool isUpdateFlushed = true);
236
237   /// Editing mode depends on mode of current operation. This value is defined by it.
238   virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
239
240   /// \return Current Editing mode
241   bool isEditingMode() const { return myIsEditing; }
242
243   /// Returns true if the event is processed. The default implementation is empty, returns false.
244   virtual bool processEnter();
245
246   /// Returns true if the event is processed. The default implementation is empty, returns false.
247   virtual bool processEscape();
248
249   /// Returns true if the event is processed. The default implementation is empty, returns false.
250   virtual bool processDelete();
251
252   /// Sends Update and Redisplay for the given object
253   /// \param theObj is updating object
254   void updateObject(ObjectPtr theObj);
255
256   /// Translate passed string with widget context()
257   virtual QString translate(const std::string& theStr) const;
258
259   /// Emit focus in widget to set this control as active in propety panel
260   void emitFocusInWidget() { emit focusInWidget(this); }
261
262   /// Finds model widget parent of the given sub widget
263   /// \param theWidget a candidate to be a child of the model widget
264   /// \param theProp a property panel instance
265   /// \return a model widget or NULL
266   static ModuleBase_ModelWidget* findModelWidget(ModuleBase_IPropertyPanel* theProp,
267                                                  QWidget* theWidget);
268 signals:
269   /// The signal about widget values are to be changed
270   void beforeValuesChanged();
271   /// The signal about widget values changed
272   void valuesChanged();
273   /// The signal about widget values modified
274   void valuesModified();
275   /// The signal about widget values are to be changed
276   void afterValuesChanged();
277
278   /// The signal about widget values are to be restored
279   void beforeValuesRestored();
280   /// The signal about widget values are to be restored
281   void afterValuesRestored();
282
283   /// The signal about key release on the control, that corresponds to the attribute
284   /// \param theObject a sender of the event
285   /// \param theEvent key release event
286   void keyReleased(QObject* theObject, QKeyEvent* theEvent);
287
288   /// The signal is emitted if the enter is clicked in the control of the widget
289   /// \param theObject a sender of the event
290   void enterClicked(QObject* theObject);
291
292   /// The signal about the widget is get focus
293   /// \param theWidget the model base widget
294   void focusInWidget(ModuleBase_ModelWidget* theWidget);
295
296   /// The signal about the widget is lost focus
297   /// \param theWidget the model base widget
298   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
299
300   /// The signal about value state modification
301   void valueStateChanged(int theState);
302
303   /// The signal is emitted after flush of updates singal for the widget
304   void objectUpdated();
305
306 protected:
307   /// Sets default value of widget. Normally, widget should fetch this value
308   /// from the xml. However, some widgets derived widgets could define it
309   void setDefaultValue(const std::string& theValue);
310   /// \brief Set the attribute name
311   /// \param theAttribute the string value with attribute name
312   void setAttributeID(const std::string& theAttribute)
313   {
314     myAttributeID = theAttribute;
315   }
316
317   /// Sets the current value state. If the value is changed, the signal is emitted
318   /// If the current value state is Blocked, this method do nothing
319   /// \param theState a new state
320   /// \return the previous value state
321   ValueState setValueState(const ValueState& theState);
322
323   /// Blocks the value state change.
324   /// \param theBlocked a block state
325   /// \return the previous value
326   bool blockValueState(const bool theBlocked);
327
328   /// Compute the feature default value and fill the controls with it
329   /// or store the control value to the feature
330   virtual void initializeValueByActivate();
331
332   /// Saves the internal parameters to the given feature
333   /// \return True in success
334   virtual bool storeValueCustom() = 0;
335
336   /// Restore value from attribute data to the widget's control
337   virtual bool restoreValueCustom() = 0;
338
339   /// Fills the widget with default values
340   /// \return true if the widget current value is reset
341   virtual bool resetCustom() { return false; };
342
343   /// The method called when widget is activated
344   virtual void activateCustom() {};
345
346 protected slots:
347   /// Processing of values changed in model widget by store the current value to the feature
348   void onWidgetValuesChanged();
349
350   /// Changes widget state.
351   void onWidgetValuesModified();
352
353  protected:
354     /// own validator, by default it is zero
355    ModuleBase_WidgetValidator* myWidgetValidator;
356
357   /// The attribute name of the model feature
358   std::string myAttributeID;
359
360   /// A feature which is processing by active operation
361   FeaturePtr myFeature;
362
363   /// A feature ID
364   std::string myFeatureId;
365
366   /// Flag which shows that current operation is in editing mode
367   bool myIsEditing;
368
369   /// Flag which shows whether current widget is obligatory
370   /// The non-obligatory widgets should not accept the focus in the property panel
371   bool myIsObligatory;
372
373   /// Flag about value of the control is enabled (can be modified)
374   EnableState myIsValueEnabled;
375
376   /// The widget value state
377   ValueState myState;
378
379 private:
380   /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
381   bool myIsComputedDefault;
382
383   /// the default value, which is defined in the XML for this attribute
384   std::string myDefaultValue;
385
386   /// an XML internal state
387   bool myIsInternal;
388
389   // an XML state, the value is not stored into model if the widget is in edit mode
390   std::string myIsModifiedInEdit;
391
392   /// the reset state. If it is false, the reset method of the widget is not performed
393   bool myUseReset;
394   /// blocked flag of modification of the value state
395   bool myIsValueStateBlocked;
396   /// do not flush updated signal
397   bool myFlushUpdateBlocked;
398 };
399
400 #endif