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