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