src/ModuleBase/ModuleBase_ModelWidget.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModuleBase_ModelWidget.h
   4 // Created:     25 Apr 2014
   5 // Author:      Natalia ERMOLAEVA
   6
   7 #ifndef MODULEBASE_MODELWIDGET_H
   8 #define MODULEBASE_MODELWIDGET_H
   9
  10 #include <ModuleBase.h>
  11 #include <ModuleBase_ViewerPrs.h>
  12
  13 #include <ModelAPI_Feature.h>
  14
  15 #include <QWidget>
  16
  17 #include <memory>
  18
  19 class Config_WidgetAPI;
  20 class ModuleBase_IWorkshop;
  21 class QKeyEvent;
  22
  23 /**\class ModuleBase_ModelWidget
  24  * \ingroup GUI
  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.
  27  *
  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.
  30  *
  31  */
  32 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget
  33 {
  34 Q_OBJECT
  35  public:
  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
  41
  42    /// Constructor
  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);
  48   /// Destructor
  49   virtual ~ModuleBase_ModelWidget()
  50   {
  51   }
  52
  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
  56   bool reset();
  57
  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;
  62
  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; }
  66
  67   /// Returns true, if default value of the widget is defined in the XML and it is not the
  68   /// computed value
  69   /// \return the boolean result
  70   std::string getDefaultValue() const { return myDefaultValue; }
  71
  72   /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value
  73   /// \return the boolean result
  74   bool isObligatory() const { return myIsObligatory; }
  75
  76   /// Returns this parameter value in the xml file
  77   /// \return the boolean result
  78   bool isUseReset() const { return myUseReset; }
  79
  80   /// Returns this widget value state
  81   /// \return the enumeration result
  82   ValueState getValueState() const { return myState; }
  83
  84   /// Defines if it is supposed that the widget should interact with the viewer.
  85   virtual bool isViewerSelector() { return false; }
  86
  87   /// Defines if it is supported to set the value in this widget
  88   /// By default it returns true
  89   virtual bool canSetValue() const { return true; };
  90
  91   /// Set the given wrapped value to the current widget
  92   /// This value should be processed in the widget according to the needs
  93   /// \param theValues the wrapped selection values
  94   /// \param theToValidate the boolean value whether the value should be checked by filters
  95   virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
  96                             const bool theToValidate)
  97   {
  98     return false;
  99   }
 100
 101   /// Restore value from attribute data to the widget's control. Emits signals before and after store
 102   /// \return True in success
 103   bool restoreValue();
 104
 105   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
 106   /// If the widget has the NonFocus focus policy, it is skipped.
 107   /// \return the state whether the widget can accept the focus
 108   virtual bool focusTo();
 109
 110   /// Select the internal content if it can be selected. It is empty in the default realization
 111   virtual void selectContent() {}
 112
 113   /// The method called when widget is activated
 114   void activate();
 115
 116   /// The method called when widget is deactivated
 117   virtual void deactivate();
 118
 119   /// Returns list of widget controls
 120   /// \return a control list
 121   virtual QList<QWidget*> getControls() const = 0;
 122
 123   /// Returns the first or the last control that can accept the focus
 124   /// \param isFirst if true, the first controls is returned or the last one
 125   /// \return a control from a list of controls
 126   QWidget* getControlAcceptingFocus(const bool isFirst);
 127
 128   /// FocusIn events processing
 129   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
 130
 131   /// \brief Enables processing of focus event on all controls by the widget
 132   /// if this widget is not obligatory and set no-focus policy otherwise
 133   virtual void enableFocusProcessing();
 134
 135   //! Switch On/Off highlighting of the widget
 136   virtual void setHighlighted(bool isHighlighted);
 137
 138   /// Returns the attribute name
 139   /// \returns the string value
 140   std::string attributeID() const
 141   {
 142     return myAttributeID;
 143   }
 144
 145   /// Returns the parent of the attribute
 146   /// \returns the string value
 147   std::string parentID() const
 148   {
 149     return myParentId;
 150   }
 151
 152   /// \return Current feature
 153   FeaturePtr feature() const
 154   {
 155     return myFeature;
 156   }
 157
 158   /// Set feature which is processing by active operation
 159   /// \param theFeature a feature object
 160   /// \param theToStoreValue a value about necessity to store the widget value to the feature
 161   void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
 162
 163   /// Editing mode depends on mode of current operation. This value is defined by it.
 164   void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
 165
 166   /// \return Current Editing mode
 167   bool isEditingMode() const { return myIsEditing; }
 168
 169   /// Returns true if the event is processed.
 170   virtual bool processEnter();
 171
 172   /// Sends Update and Redisplay for the given object
 173   /// \param theObj is updating object
 174   static void updateObject(ObjectPtr theObj);
 175
 176   /// Sends Move event for the given object
 177   /// \param theObj is object for moving
 178   static void moveObject(ObjectPtr theObj);
 179
 180 signals:
 181   /// The signal about widget values are to be changed
 182   void beforeValuesChanged();
 183   /// The signal about widget values changed
 184   void valuesChanged();
 185   /// The signal about widget values modified
 186   void valuesModified();
 187   /// The signal about widget values are to be changed
 188   void afterValuesChanged();
 189
 190   /// The signal about widget values are to be restored
 191   void beforeValuesRestored();
 192   /// The signal about widget values are to be restored
 193   void afterValuesRestored();
 194
 195   /// The signal about key release on the control, that corresponds to the attribute
 196   /// \param theEvent key release event
 197   void keyReleased(QKeyEvent* theEvent);
 198
 199   /// The signal about the widget is get focus
 200   /// \param theWidget the model base widget
 201   void focusInWidget(ModuleBase_ModelWidget* theWidget);
 202
 203   /// The signal about the widget is lost focus
 204   /// \param theWidget the model base widget
 205   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
 206
 207   /// The signal about value state modification
 208   void valueStateChanged(int theState);
 209
 210 protected:
 211   /// Sets default value of widget. Normally, widget should fetch this value
 212   /// from the xml. However, some widgets derived widgets could define it
 213   void setDefaultValue(const std::string& theValue);
 214   /// \brief Set the attribute name
 215   /// \param theAttribute the string value with attribute name
 216   void setAttributeID(const std::string& theAttribute)
 217   {
 218     myAttributeID = theAttribute;
 219   }
 220
 221   /// Sets the current value state. If the value is changed, the signal is emitted
 222   /// If the current value state is Blocked, this method do nothing
 223   /// \param theState a new state
 224   /// \return the previous value state
 225   ValueState setValueState(const ValueState& theState);
 226
 227   /// Blocks the value state change.
 228   /// \param theBlocked a block state
 229   /// \return the previous value
 230   bool blockValueState(const bool theBlocked);
 231
 232   /// Compute the feature default value and fill the controls with it
 233   /// or store the control value to the feature
 234   virtual void initializeValueByActivate();
 235
 236   /// Saves the internal parameters to the given feature. Emits signals before and after store
 237   /// \return True in success
 238   bool storeValue();
 239
 240   /// Saves the internal parameters to the given feature
 241   /// \return True in success
 242   virtual bool storeValueCustom() const = 0;
 243
 244   /// Restore value from attribute data to the widget's control
 245   virtual bool restoreValueCustom() = 0;
 246
 247   /// Fills the widget with default values
 248   /// \return true if the widget current value is reset
 249   virtual bool resetCustom() { return false; };
 250
 251   /// The method called when widget is activated
 252   virtual void activateCustom() {};
 253
 254   /// Sends a message about block/unblock viewer updating
 255   /// \param theValue a boolean value
 256   static void blockUpdateViewer(const bool theValue);
 257
 258 protected slots:
 259   /// Processing of values changed in model widget by store the current value to the feature
 260   void onWidgetValuesChanged();
 261
 262   /// Changes widget state.
 263   void onWidgetValuesModified();
 264
 265  protected:
 266
 267   /// The attribute name of the model feature
 268   std::string myAttributeID;
 269
 270   /// Name of parent
 271   std::string myParentId;
 272
 273   /// A feature which is processing by active operation
 274   FeaturePtr myFeature;
 275
 276   /// Flag which shows that current operation is in editing mode
 277   bool myIsEditing;
 278
 279   /// Flag which shows whether current widget is obligatory
 280   /// The non-obligatory widgets should not accept the focus in the property panel
 281   bool myIsObligatory;
 282
 283   /// The widget value state
 284   ValueState myState;
 285
 286 private:
 287   /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
 288   bool myIsComputedDefault;
 289
 290   /// the default value, which is defined in the XML for this attribute
 291   std::string myDefaultValue;
 292
 293   /// the reset state. If it is false, the reset method of the widget is not performed
 294   bool myUseReset;
 295   /// blocked flag of modification of the value state
 296   bool myIsValueStateBlocked;
 297 };
 298
 299 #endif