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