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