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