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