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 configuation. 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
  94   virtual bool restoreValue() = 0;
  95
  96   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
  97   /// If the widget has the NonFocus focus policy, it is skipped.
  98   /// \return the state whether the widget can accept the focus
  99   virtual bool focusTo();
 100
 101   /// The methiod called when widget is activated
 102   void activate();
 103
 104   /// The methiod called when widget is deactivated
 105   virtual void deactivate() {}
 106
 107   /// Returns list of widget controls
 108   /// \return a control list
 109   virtual QList<QWidget*> getControls() const = 0;
 110
 111   /// FocusIn events processing
 112   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
 113
 114   /// \brief Enables processing of focus event on all controls by the widget
 115   /// if this widget is not obligatory and set no-focus policy otherwise
 116   virtual void enableFocusProcessing();
 117
 118   //! Switch On/Off highlighting of the widget
 119   virtual void setHighlighted(bool isHighlighted);
 120
 121   /// Returns the attribute name
 122   /// \returns the string value
 123   std::string attributeID() const
 124   {
 125     return myAttributeID;
 126   }
 127
 128   /// Returns the parent of the attribute
 129   /// \returns the string value
 130   std::string parentID() const
 131   {
 132     return myParentId;
 133   }
 134
 135   /// \return Current feature
 136   FeaturePtr feature() const
 137   {
 138     return myFeature;
 139   }
 140
 141   /// Set feature which is processing by active operation
 142   /// \param theToStoreValue a value about necessity to store the widget value to the feature
 143   void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
 144
 145   /// Editing mode depends on mode of current operation. This value is defined by it.
 146   void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
 147
 148   /// \return Current Editing mode
 149   bool isEditingMode() const { return myIsEditing; }
 150
 151   /// Sends Update and Redisplay for the given object
 152   /// \param theObj is updating object
 153   static void updateObject(ObjectPtr theObj);
 154
 155   /// Sends Move event for the given object
 156   /// \param theObj is object for moving
 157   static void moveObject(ObjectPtr theObj);
 158
 159 signals:
 160   /// The signal about widget values are to be changed
 161   void beforeValuesChanged();
 162   /// The signal about widget values changed
 163   void valuesChanged();
 164   /// The signal about widget values are to be changed
 165   void afterValuesChanged();
 166
 167   /// The signal about key release on the control, that corresponds to the attribute
 168   /// \param theEvent key release event
 169   void keyReleased(QKeyEvent* theEvent);
 170
 171   /// The signal about the widget is get focus
 172   /// \param theWidget the model base widget
 173   void focusInWidget(ModuleBase_ModelWidget* theWidget);
 174
 175   /// The signal about the widget is lost focus
 176   /// \param theWidget the model base widget
 177   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
 178
 179  protected:
 180   /// Sets default value of widget. Nornaly, widget should fetch this value
 181   /// from the xml. However, some widgets derived widgets could define it
 182   void setDefaultValue(const std::string& theValue);
 183   /// \brief Set the attribute name
 184   /// \param theAttribute the string value with attribute name
 185   void setAttributeID(const std::string& theAttribute)
 186   {
 187     myAttributeID = theAttribute;
 188   }
 189
 190   /// Saves the internal parameters to the given feature. Emits signals before and after store
 191   /// \return True in success
 192   bool storeValue();
 193
 194   /// Saves the internal parameters to the given feature
 195   /// \return True in success
 196   virtual bool storeValueCustom() const = 0;
 197
 198   /// The methiod called when widget is activated
 199   virtual void activateCustom() {};
 200
 201 protected slots:
 202   /// Processing of values changed in model widget by store the current value to the feature
 203   void onWidgetValuesChanged();
 204
 205  protected:
 206
 207   /// The attribute name of the model feature
 208   std::string myAttributeID;
 209
 210   /// Name of parent
 211   std::string myParentId;
 212
 213   /// A feature which is processing by active operation
 214   FeaturePtr myFeature;
 215
 216   /// Flag which shows that current operation is in editing mode
 217   bool myIsEditing;
 218
 219   /// Flag which shows whether current widget is obligatory
 220   /// The non-obligatory widgets should not accept the focus in the property panel
 221   bool myIsObligatory;
 222
 223 private:
 224   /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
 225   bool myIsComputedDefault;
 226
 227   /// the default value, which is defined in the XML for this attribute
 228   std::string myDefaultValue;
 229
 230   /// the reset state. If it is false, the reset method of the widget is not performed
 231   bool myUseReset;
 232 };
 233
 234 #endif