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_OperationFeature.h>
  12 #include <ModelAPI_Feature.h>
  13
  14 #include <QWidget>
  15
  16 #include <memory>
  17
  18 class Config_WidgetAPI;
  19 class ModuleBase_IWorkshop;
  20 class ModuleBase_ViewerPrs;
  21 class ModuleBase_WidgetValidator;
  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 theData a low-level API for reading xml definitions of widgets
  47   ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData);
  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 canAcceptFocus() 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   //! \param theValueStateChecked the boolean flag if the state of the widget should be checked
 102   //! \return string value
 103   QString getError(const bool theValueStateChecked = true) const;
 104
 105   /// Set the given wrapped value to the current widget
 106   /// This value should be processed in the widget according to the needs
 107   /// \param theValues the wrapped selection values
 108   /// \param theToValidate the boolean value whether the value should be checked by filters
 109   virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
 110                             const bool theToValidate)
 111   {
 112     return false;
 113   }
 114
 115   /// Returns values which should be highlighted when the whidget is active
 116   /// \param theValues a list of presentations
 117   virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) {};
 118
 119   /// Checks if the selection presentation is valid in widget
 120   /// \param theValue a selected presentation in the view
 121   /// \return a boolean value
 122   virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue) { return true; }
 123
 124   /// Returns widget validator, by default it is NULL. To be created in a child if necessary
 125   ModuleBase_WidgetValidator* widgetValidator() { return myWidgetValidator; }
 126
 127   /// Restore value from attribute data to the widget's control. Emits signals before and after store
 128   /// \return True in success
 129   bool restoreValue();
 130
 131   /// Saves the internal parameters to the given feature. Emits signals before and after store
 132   /// \return True in success
 133   bool storeValue();
 134
 135   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
 136   /// If the widget has the NonFocus focus policy, it is skipped.
 137   /// \return the state whether the widget can accept the focus
 138   virtual bool focusTo();
 139
 140   /// Select the internal content if it can be selected. It is empty in the default realization
 141   virtual void selectContent() {}
 142
 143   /// The method called when widget is activated
 144   void activate();
 145
 146   /// The method called when widget is deactivated
 147   virtual void deactivate();
 148
 149   /// Returns list of widget controls
 150   /// \return a control list
 151   virtual QList<QWidget*> getControls() const = 0;
 152
 153   /// Returns the first or the last control that can accept the focus
 154   /// \param isFirst if true, the first controls is returned or the last one
 155   /// \return a control from a list of controls
 156   QWidget* getControlAcceptingFocus(const bool isFirst);
 157
 158   /// FocusIn events processing
 159   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
 160
 161   /// \brief Enables processing of focus event on all controls by the widget
 162   /// if this widget is not obligatory and set no-focus policy otherwise
 163   virtual void enableFocusProcessing();
 164
 165   //! Switch On/Off highlighting of the widget
 166   virtual void setHighlighted(bool isHighlighted);
 167
 168   /// Returns the attribute name
 169   /// \returns the string value
 170   std::string attributeID() const
 171   {
 172     return myAttributeID;
 173   }
 174
 175   /// \return Current feature
 176   FeaturePtr feature() const
 177   {
 178     return myFeature;
 179   }
 180
 181   /// Set feature which is processing by active operation
 182   /// \param theFeature a feature object
 183   /// \param theToStoreValue a value about necessity to store the widget value to the feature
 184   /// \param isUpdateFlushed a flag if update should be flushed on store value
 185   void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false,
 186                   const bool isUpdateFlushed = true);
 187
 188   /// Editing mode depends on mode of current operation. This value is defined by it.
 189   virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
 190
 191   /// \return Current Editing mode
 192   bool isEditingMode() const { return myIsEditing; }
 193
 194   /// Returns true if the event is processed. The default implementation is empty, returns false.
 195   virtual bool processEnter();
 196
 197   /// Returns true if the event is processed. The default implementation is empty, returns false.
 198   virtual bool processDelete();
 199
 200   /// Sends Update and Redisplay for the given object
 201   /// \param theObj is updating object
 202   void updateObject(ObjectPtr theObj);
 203
 204   /// Sends Move event for the given object
 205   /// \param theObj is object for moving
 206   static void moveObject(ObjectPtr theObj);
 207
 208 signals:
 209   /// The signal about widget values are to be changed
 210   void beforeValuesChanged();
 211   /// The signal about widget values changed
 212   void valuesChanged();
 213   /// The signal about widget values modified
 214   void valuesModified();
 215   /// The signal about widget values are to be changed
 216   void afterValuesChanged();
 217
 218   /// The signal about widget values are to be restored
 219   void beforeValuesRestored();
 220   /// The signal about widget values are to be restored
 221   void afterValuesRestored();
 222
 223   /// The signal about key release on the control, that corresponds to the attribute
 224   /// \param theObject a sender of the event
 225   /// \param theEvent key release event
 226   void keyReleased(QObject* theObject, QKeyEvent* theEvent);
 227
 228   /// The signal is emitted if the enter is clicked in the control of the widget
 229   /// \param theObject a sender of the event
 230   void enterClicked(QObject* theObject);
 231
 232   /// The signal about the widget is get focus
 233   /// \param theWidget the model base widget
 234   void focusInWidget(ModuleBase_ModelWidget* theWidget);
 235
 236   /// The signal about the widget is lost focus
 237   /// \param theWidget the model base widget
 238   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
 239
 240   /// The signal about value state modification
 241   void valueStateChanged(int theState);
 242
 243   /// The signal is emitted after flush of updates singal for the widget
 244   void objectUpdated();
 245
 246 protected:
 247   /// Sets default value of widget. Normally, widget should fetch this value
 248   /// from the xml. However, some widgets derived widgets could define it
 249   void setDefaultValue(const std::string& theValue);
 250   /// \brief Set the attribute name
 251   /// \param theAttribute the string value with attribute name
 252   void setAttributeID(const std::string& theAttribute)
 253   {
 254     myAttributeID = theAttribute;
 255   }
 256
 257   /// Sets the current value state. If the value is changed, the signal is emitted
 258   /// If the current value state is Blocked, this method do nothing
 259   /// \param theState a new state
 260   /// \return the previous value state
 261   ValueState setValueState(const ValueState& theState);
 262
 263   /// Blocks the value state change.
 264   /// \param theBlocked a block state
 265   /// \return the previous value
 266   bool blockValueState(const bool theBlocked);
 267
 268   /// Compute the feature default value and fill the controls with it
 269   /// or store the control value to the feature
 270   virtual void initializeValueByActivate();
 271
 272   /// Saves the internal parameters to the given feature
 273   /// \return True in success
 274   virtual bool storeValueCustom() = 0;
 275
 276   /// Restore value from attribute data to the widget's control
 277   virtual bool restoreValueCustom() = 0;
 278
 279   /// Fills the widget with default values
 280   /// \return true if the widget current value is reset
 281   virtual bool resetCustom() { return false; };
 282
 283   /// The method called when widget is activated
 284   virtual void activateCustom() {};
 285
 286 protected slots:
 287   /// Processing of values changed in model widget by store the current value to the feature
 288   void onWidgetValuesChanged();
 289
 290   /// Changes widget state.
 291   void onWidgetValuesModified();
 292
 293  protected:
 294    ModuleBase_WidgetValidator* myWidgetValidator; /// own validator, by default it is zero
 295
 296   /// The attribute name of the model feature
 297   std::string myAttributeID;
 298
 299   /// A feature which is processing by active operation
 300   FeaturePtr myFeature;
 301
 302   /// Flag which shows that current operation is in editing mode
 303   bool myIsEditing;
 304
 305   /// Flag which shows whether current widget is obligatory
 306   /// The non-obligatory widgets should not accept the focus in the property panel
 307   bool myIsObligatory;
 308
 309   /// The widget value state
 310   ValueState myState;
 311
 312 private:
 313   /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
 314   bool myIsComputedDefault;
 315
 316   /// the default value, which is defined in the XML for this attribute
 317   std::string myDefaultValue;
 318
 319   /// an XML internal state
 320   bool myIsInternal;
 321
 322   /// the reset state. If it is false, the reset method of the widget is not performed
 323   bool myUseReset;
 324   /// blocked flag of modification of the value state
 325   bool myIsValueStateBlocked;
 326   /// do not flush updated signal
 327   bool myFlushUpdateBlocked;
 328 };
 329
 330 #endif