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 #include <ModuleBase_OperationFeature.h>
  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   /// Returns an attribute error according to the value state
  85   /// It exists in all cases excepring the "Store" case
  86   QString getValueStateError() const;
  87
  88   /// Defines if it is supposed that the widget should interact with the viewer.
  89   virtual bool isViewerSelector() { return false; }
  90
  91   /// Defines if it is supported to set the value in this widget
  92   /// By default it returns true
  93   virtual bool canSetValue() const { return true; };
  94
  95   //! Returns the widget error, get it from the attribute validator and state of the widget
  96   //! If the feature is correct, it returns an empty value
  97   //! \return string value
  98   QString getError() const;
  99
 100   /// Set the given wrapped value to the current widget
 101   /// This value should be processed in the widget according to the needs
 102   /// \param theValues the wrapped selection values
 103   /// \param theToValidate the boolean value whether the value should be checked by filters
 104   virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
 105                             const bool theToValidate)
 106   {
 107     return false;
 108   }
 109
 110   /// Restore value from attribute data to the widget's control. Emits signals before and after store
 111   /// \return True in success
 112   bool restoreValue();
 113
 114   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
 115   /// If the widget has the NonFocus focus policy, it is skipped.
 116   /// \return the state whether the widget can accept the focus
 117   virtual bool focusTo();
 118
 119   /// Select the internal content if it can be selected. It is empty in the default realization
 120   virtual void selectContent() {}
 121
 122   /// The method called when widget is activated
 123   void activate();
 124
 125   /// The method called when widget is deactivated
 126   virtual void deactivate();
 127
 128   /// Returns list of widget controls
 129   /// \return a control list
 130   virtual QList<QWidget*> getControls() const = 0;
 131
 132   /// Returns the first or the last control that can accept the focus
 133   /// \param isFirst if true, the first controls is returned or the last one
 134   /// \return a control from a list of controls
 135   QWidget* getControlAcceptingFocus(const bool isFirst);
 136
 137   /// FocusIn events processing
 138   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
 139
 140   /// \brief Enables processing of focus event on all controls by the widget
 141   /// if this widget is not obligatory and set no-focus policy otherwise
 142   virtual void enableFocusProcessing();
 143
 144   //! Switch On/Off highlighting of the widget
 145   virtual void setHighlighted(bool isHighlighted);
 146
 147   /// Returns the attribute name
 148   /// \returns the string value
 149   std::string attributeID() const
 150   {
 151     return myAttributeID;
 152   }
 153
 154   /// Returns the parent of the attribute
 155   /// \returns the string value
 156   std::string parentID() const
 157   {
 158     return myParentId;
 159   }
 160
 161   /// \return Current feature
 162   FeaturePtr feature() const
 163   {
 164     return myFeature;
 165   }
 166
 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);
 171
 172   /// Editing mode depends on mode of current operation. This value is defined by it.
 173   void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
 174
 175   /// \return Current Editing mode
 176   bool isEditingMode() const { return myIsEditing; }
 177
 178   /// Returns true if the event is processed.
 179   virtual bool processEnter();
 180
 181   /// Sends Update and Redisplay for the given object
 182   /// \param theObj is updating object
 183   static void updateObject(ObjectPtr theObj);
 184
 185   /// Sends Move event for the given object
 186   /// \param theObj is object for moving
 187   static void moveObject(ObjectPtr theObj);
 188
 189 signals:
 190   /// The signal about widget values are to be changed
 191   void beforeValuesChanged();
 192   /// The signal about widget values changed
 193   void valuesChanged();
 194   /// The signal about widget values modified
 195   void valuesModified();
 196   /// The signal about widget values are to be changed
 197   void afterValuesChanged();
 198
 199   /// The signal about widget values are to be restored
 200   void beforeValuesRestored();
 201   /// The signal about widget values are to be restored
 202   void afterValuesRestored();
 203
 204   /// The signal about key release on the control, that corresponds to the attribute
 205   /// \param theEvent key release event
 206   void keyReleased(QKeyEvent* theEvent);
 207
 208   /// The signal is emitted if the enter is clicked in the control of the widget
 209   void enterClicked();
 210
 211   /// The signal about the widget is get focus
 212   /// \param theWidget the model base widget
 213   void focusInWidget(ModuleBase_ModelWidget* theWidget);
 214
 215   /// The signal about the widget is lost focus
 216   /// \param theWidget the model base widget
 217   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
 218
 219   /// The signal about value state modification
 220   void valueStateChanged(int theState);
 221
 222 protected:
 223   /// Sets default value of widget. Normally, widget should fetch this value
 224   /// from the xml. However, some widgets derived widgets could define it
 225   void setDefaultValue(const std::string& theValue);
 226   /// \brief Set the attribute name
 227   /// \param theAttribute the string value with attribute name
 228   void setAttributeID(const std::string& theAttribute)
 229   {
 230     myAttributeID = theAttribute;
 231   }
 232
 233   /// Sets the current value state. If the value is changed, the signal is emitted
 234   /// If the current value state is Blocked, this method do nothing
 235   /// \param theState a new state
 236   /// \return the previous value state
 237   ValueState setValueState(const ValueState& theState);
 238
 239   /// Blocks the value state change.
 240   /// \param theBlocked a block state
 241   /// \return the previous value
 242   bool blockValueState(const bool theBlocked);
 243
 244   /// Compute the feature default value and fill the controls with it
 245   /// or store the control value to the feature
 246   virtual void initializeValueByActivate();
 247
 248   /// Saves the internal parameters to the given feature. Emits signals before and after store
 249   /// \return True in success
 250   bool storeValue();
 251
 252   /// Saves the internal parameters to the given feature
 253   /// \return True in success
 254   virtual bool storeValueCustom() const = 0;
 255
 256   /// Restore value from attribute data to the widget's control
 257   virtual bool restoreValueCustom() = 0;
 258
 259   /// Fills the widget with default values
 260   /// \return true if the widget current value is reset
 261   virtual bool resetCustom() { return false; };
 262
 263   /// The method called when widget is activated
 264   virtual void activateCustom() {};
 265
 266   /// Sends a message about block/unblock viewer updating
 267   /// \param theValue a boolean value
 268   static void blockUpdateViewer(const bool theValue);
 269
 270 protected slots:
 271   /// Processing of values changed in model widget by store the current value to the feature
 272   void onWidgetValuesChanged();
 273
 274   /// Changes widget state.
 275   void onWidgetValuesModified();
 276
 277  protected:
 278
 279   /// The attribute name of the model feature
 280   std::string myAttributeID;
 281
 282   /// Name of parent
 283   std::string myParentId;
 284
 285   /// A feature which is processing by active operation
 286   FeaturePtr myFeature;
 287
 288   /// Flag which shows that current operation is in editing mode
 289   bool myIsEditing;
 290
 291   /// Flag which shows whether current widget is obligatory
 292   /// The non-obligatory widgets should not accept the focus in the property panel
 293   bool myIsObligatory;
 294
 295   /// The widget value state
 296   ValueState myState;
 297
 298 private:
 299   /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
 300   bool myIsComputedDefault;
 301
 302   /// the default value, which is defined in the XML for this attribute
 303   std::string myDefaultValue;
 304
 305   /// the reset state. If it is false, the reset method of the widget is not performed
 306   bool myUseReset;
 307   /// blocked flag of modification of the value state
 308   bool myIsValueStateBlocked;
 309
 310   friend class ModuleBase_OperationFeature; // to call storeValue() by commit if value state is ModifiedInPP
 311 };
 312
 313 #endif