src/ModuleBase/ModuleBase_ModelWidget.h

   1 // File:        ModuleBase_ModelWidget.h
   2 // Created:     25 Apr 2014
   3 // Author:      Natalia ERMOLAEVA
   4
   5 #ifndef MODULEBASE_MODELWIDGET_H
   6 #define MODULEBASE_MODELWIDGET_H
   7
   8 #include <ModuleBase.h>
   9
  10 #include <ModelAPI_Feature.h>
  11
  12 #include <QObject>
  13
  14 #include <boost/shared_ptr.hpp>
  15
  16 class Config_WidgetAPI;
  17 class ModuleBase_WidgetValue;
  18 class QKeyEvent;
  19
  20 /**\class ModuleBase_ModelWidget
  21  * \brief An abstract custom widget class. This class realization is assumed to create some controls.
  22  * The controls values modification should send signal about values change.
  23  *
  24  * Common interface for widgets in the property panel.
  25  * Every widget are able to save/restore data from the model and/or to contain other widgets.
  26  *
  27  */
  28 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QObject
  29 {
  30 Q_OBJECT
  31  public:
  32   /// Constructor
  33   /// \theParent the parent object
  34   /// \theData the widget configuation. The attribute of the model widget is obtained from
  35   ModuleBase_ModelWidget(QObject* theParent, const Config_WidgetAPI* theData,
  36                          const std::string& theParentId);
  37   /// Destructor
  38   virtual ~ModuleBase_ModelWidget()
  39   {
  40   }
  41
  42   /// Set the given wrapped value to the current widget
  43   /// This value should be processed in the widget according to the needs
  44   /// \param theValue the wrapped widget value
  45   virtual bool setValue(ModuleBase_WidgetValue* theValue)
  46   {
  47     return false;
  48   }
  49
  50   /// Returns the state whether the attribute of the feature is initialized
  51   /// \param theObject a model feature to be checked
  52   /// \return the boolean result
  53   bool isInitialized(ObjectPtr theObject) const;
  54
  55   bool isComputedDefault()
  56   {
  57     return myIsComputedDefault;
  58   }
  59
  60   /// Saves the internal parameters to the given feature
  61   /// \param theObject a model feature to be changed
  62   virtual bool storeValue() const = 0;
  63
  64   virtual bool restoreValue() = 0;
  65
  66   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
  67   /// If the widget has the NonFocus focus policy, it is skipped.
  68   /// \return the state whether the widget can accept the focus
  69   virtual bool focusTo();
  70
  71   /// Returns list of widget controls
  72   /// \return a control list
  73   virtual QList<QWidget*> getControls() const = 0;
  74
  75   /// FocusIn events processing
  76   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
  77
  78   /// Returns the attribute name
  79   /// \returns the string value
  80   std::string attributeID() const
  81   {
  82     return myAttributeID;
  83   }
  84
  85   /// Returns the parent of the attribute
  86   /// \returns the string value
  87   std::string parentID() const
  88   {
  89     return myParentId;
  90   }
  91
  92   FeaturePtr feature() const
  93   {
  94     return myFeature;
  95   }
  96   void setFeature(const FeaturePtr& theFeature)
  97   {
  98     myFeature = theFeature;
  99   }
 100
 101   /// Defines if it is supposed that the widget should interact with the viewer.
 102   virtual bool isViewerSelector() { return false; }
 103
 104 signals:
 105   /// The signal about widget values changed
 106   void valuesChanged();
 107   /// The signal about key release on the control, that corresponds to the attribute
 108   /// \param theAttributeName a name of the attribute
 109   /// \param theEvent key release event
 110   void keyReleased(QKeyEvent* theEvent);
 111   /// The signal about the widget is get focus
 112   /// \param theWidget the model base widget
 113   void focusInWidget(ModuleBase_ModelWidget* theWidget);
 114   /// The signal about the widget is lost focus
 115   /// \param theWidget the model base widget
 116   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
 117
 118  protected:
 119   /// Returns the attribute name
 120   /// \returns the string value
 121   void setAttributeID(const std::string& theAttribute)
 122   {
 123     myAttributeID = theAttribute;
 124   }
 125
 126   void updateObject(ObjectPtr theObj) const;
 127
 128   /// Let the widget process FocusIn events
 129   void processFocus(QWidget* theWidget);
 130
 131   std::string myAttributeID;  /// the attribute name of the model feature
 132   std::string myParentId;    /// name of parent
 133   FeaturePtr myFeature;
 134
 135   bool myIsComputedDefault;
 136
 137  private:
 138    /// Contains a list of widgets that may accept focus
 139    QList<QWidget*> myFocusInWidgets;
 140 };
 141
 142 #endif