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