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