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