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 ModelAPI_Feature;
  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   /// Destructor
  37   virtual ~ModuleBase_ModelWidget() {};
  38
  39   /// Returns the state whether the attribute of the feature is initialized
  40   /// \param theFeature a model feature to be checked
  41   /// \return the boolean result
  42   bool isInitialized(FeaturePtr theFeature) const;
  43
  44   /// Saves the internal parameters to the given feature
  45   /// \param theFeature a model feature to be changed
  46   virtual bool storeValue(FeaturePtr theFeature) const = 0;
  47
  48   virtual bool restoreValue(FeaturePtr theFeature) = 0;
  49
  50   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
  51   /// If the widget has the NonFocus focus policy, it is skipped.
  52   /// \return the state whether the widget can accept the focus
  53   virtual bool focusTo();
  54
  55   /// Returns list of widget controls
  56   /// \return a control list
  57   virtual QList<QWidget*> getControls() const = 0;
  58
  59   /// Returns whether the control has a default value
  60   /// \return a boolean value
  61   bool hasDefaultValue() const { return myHasDefaultValue; }
  62
  63   /// Returns the attribute name
  64   /// \returns the string value
  65   std::string attributeID() const;
  66
  67 signals:
  68   /// The signal about widget values changed
  69   void valuesChanged();
  70   /// The signal about key release on the control, that corresponds to the attribute
  71   /// \param theAttributeName a name of the attribute
  72   /// \param theEvent key release event
  73   void keyReleased(const std::string& theAttributeName, QKeyEvent* theEvent);
  74   /// The signal about the widget is lost focus
  75   /// \param theWidget the model base widget
  76   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
  77
  78 protected:
  79   /// Returns the attribute name
  80   /// \returns the string value
  81   void setAttributeID(const std::string& theAttribute) { myAttributeID = theAttribute; }
  82
  83   bool myHasDefaultValue; /// the boolean state whether the control has a default value
  84
  85 private:
  86   std::string myAttributeID; /// the attribute name of the model feature
  87 };
  88
  89 #endif