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