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 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   /// Defines if it is supposed that the widget should interact with the viewer.
  64   virtual bool isViewerSelector() { return false; }
  65
  66   /// Defines if it is supported to set the value in this widget
  67   /// By default it returns true
  68   virtual bool canSetValue() const { return true; };
  69
  70   /// Set the given wrapped value to the current widget
  71   /// This value should be processed in the widget according to the needs
  72   /// \param theValue the wrapped widget value
  73   virtual bool setSelection(ModuleBase_ViewerPrs theValue)
  74   {
  75     return false;
  76   }
  77
  78   /// Restore value from attribute data to the widget's control
  79   virtual bool restoreValue() = 0;
  80
  81   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
  82   /// If the widget has the NonFocus focus policy, it is skipped.
  83   /// \return the state whether the widget can accept the focus
  84   virtual bool focusTo();
  85
  86   /// The methiod called when widget is activated
  87   void activate();
  88
  89   /// The methiod called when widget is deactivated
  90   virtual void deactivate() {}
  91
  92   /// Returns list of widget controls
  93   /// \return a control list
  94   virtual QList<QWidget*> getControls() const = 0;
  95
  96   /// FocusIn events processing
  97   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
  98
  99   /// \brief Enables processing of focus event on all controls by the widget
 100   /// if this widget is not obligatory and set no-focus policy otherwise
 101   virtual void enableFocusProcessing();
 102
 103   //! Switch On/Off highlighting of the widget
 104   void setHighlighted(bool isHighlighted);
 105
 106   /// Returns the attribute name
 107   /// \returns the string value
 108   std::string attributeID() const
 109   {
 110     return myAttributeID;
 111   }
 112
 113   /// Returns the parent of the attribute
 114   /// \returns the string value
 115   std::string parentID() const
 116   {
 117     return myParentId;
 118   }
 119
 120   /// \return Current feature
 121   FeaturePtr feature() const
 122   {
 123     return myFeature;
 124   }
 125
 126   /// Set feature which is processing by active operation
 127   /// \param theToStoreValue a value about necessity to store the widget value to the feature
 128   void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
 129
 130   /// Editing mode depends on mode of current operation. This value is defined by it.
 131   void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
 132
 133   /// \return Current Editing mode
 134   bool isEditingMode() const { return myIsEditing; }
 135
 136 signals:
 137   /// The signal about widget values are to be changed
 138   void beforeValuesChanged();
 139   /// The signal about widget values changed
 140   void valuesChanged();
 141   /// The signal about widget values are to be changed
 142   void afterValuesChanged();
 143
 144   /// The signal about key release on the control, that corresponds to the attribute
 145   /// \param theEvent key release event
 146   void keyReleased(QKeyEvent* theEvent);
 147
 148   /// The signal about the widget is get focus
 149   /// \param theWidget the model base widget
 150   void focusInWidget(ModuleBase_ModelWidget* theWidget);
 151
 152   /// The signal about the widget is lost focus
 153   /// \param theWidget the model base widget
 154   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
 155
 156  protected:
 157   /// \brief Set the attribute name
 158   /// \param theAttribute the string value with attribute name
 159   void setAttributeID(const std::string& theAttribute)
 160   {
 161     myAttributeID = theAttribute;
 162   }
 163
 164   /// Saves the internal parameters to the given feature. Emits signals before and after store
 165   /// \return True in success
 166   bool storeValue();
 167
 168   /// Saves the internal parameters to the given feature
 169   /// \return True in success
 170   virtual bool storeValueCustom() const = 0;
 171
 172   /// The methiod called when widget is activated
 173   virtual void activateCustom() {};
 174
 175   /// Sends Update and Redisplay for the given object
 176   /// \param theObj is updating object
 177   void updateObject(ObjectPtr theObj) const;
 178
 179   /// Sends Move event for the given object
 180   /// \param theObj is object for moving
 181   void moveObject(ObjectPtr theObj) const;
 182
 183 protected slots:
 184   /// Processing of values changed in model widget by store the current value to the feature
 185   void onWidgetValuesChanged();
 186
 187  protected:
 188
 189   /// The attribute name of the model feature
 190   std::string myAttributeID;
 191
 192   /// Name of parent
 193   std::string myParentId;
 194
 195   /// A feature which is processing by active operation
 196   FeaturePtr myFeature;
 197
 198   /// Flag which shows that current operation is in editing mode
 199   bool myIsEditing;
 200
 201   /// Flag which shows whether current widget is obligatory
 202   /// The non-obligatory widgets should not accept the focus in the property panel
 203   bool myIsObligatory;
 204
 205 private:
 206   /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
 207   bool myIsComputedDefault;
 208
 209   /// the default value, which is defined in the XML for this attribute
 210   std::string myDefaultValue;
 211 };
 212
 213 #endif