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