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