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