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