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