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