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