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