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(QWidget* theParent, const Config_WidgetAPI* theData,
  36                          const std::string& theParentId);
  37   /// Destructor
  38   virtual ~ModuleBase_ModelWidget()
  39   {
  40   }
  41
  42   /// Returns the state whether the attribute of the feature is initialized
  43   /// \param theObject a model feature to be checked
  44   /// \return the boolean result
  45   bool isInitialized(ObjectPtr theObject) const;
  46
  47   /// Returns true, if default value of the widget should be computed
  48   /// on operation's execute, like radius for circle's constraint (can not be zero)
  49   bool isComputedDefault() { return myIsComputedDefault; }
  50
  51   /// Returns false for non-obligatory widgets which are
  52   /// valid even if they are not initialized
  53   bool isObligatory() { return myIsObligatory; }
  54
  55   /// Defines if it is supposed that the widget should interact with the viewer.
  56   virtual bool isViewerSelector() { return false; }
  57
  58   /// Set the given wrapped value to the current widget
  59   /// This value should be processed in the widget according to the needs
  60   /// \param theValue the wrapped widget value
  61   virtual bool setValue(ModuleBase_WidgetValue* theValue)
  62   {
  63     return false;
  64   }
  65
  66   /// Saves the internal parameters to the given feature
  67   /// \param theObject a model feature to be changed
  68   virtual bool storeValue() const = 0;
  69
  70   virtual bool restoreValue() = 0;
  71
  72   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
  73   /// If the widget has the NonFocus focus policy, it is skipped.
  74   /// \return the state whether the widget can accept the focus
  75   virtual bool focusTo();
  76
  77   /// Returns the internal parent wiget control, that can be shown anywhere
  78   /// \returns the widget
  79   virtual QWidget* getControl() const = 0;
  80
  81   /// Returns list of widget controls
  82   /// \return a control list
  83   virtual QList<QWidget*> getControls() const = 0;
  84
  85
  86   /// FocusIn events processing
  87   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
  88
  89
  90   void enableFocusProcessing();
  91
  92   void setHighlighted(bool isHighlighted);
  93
  94   /// Returns the attribute name
  95   /// \returns the string value
  96   std::string attributeID() const
  97   {
  98     return myAttributeID;
  99   }
 100
 101   /// Returns the parent of the attribute
 102   /// \returns the string value
 103   std::string parentID() const
 104   {
 105     return myParentId;
 106   }
 107
 108   FeaturePtr feature() const
 109   {
 110     return myFeature;
 111   }
 112
 113   void setFeature(const FeaturePtr& theFeature)
 114   {
 115     myFeature = theFeature;
 116   }
 117
 118 signals:
 119   /// The signal about widget values changed
 120   void valuesChanged();
 121   /// The signal about key release on the control, that corresponds to the attribute
 122   /// \param theAttributeName a name of the attribute
 123   /// \param theEvent key release event
 124   void keyReleased(QKeyEvent* theEvent);
 125   /// The signal about the widget is get focus
 126   /// \param theWidget the model base widget
 127   void focusInWidget(ModuleBase_ModelWidget* theWidget);
 128   /// The signal about the widget is lost focus
 129   /// \param theWidget the model base widget
 130   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
 131
 132  protected:
 133   /// Returns the attribute name
 134   /// \returns the string value
 135   void setAttributeID(const std::string& theAttribute)
 136   {
 137     myAttributeID = theAttribute;
 138   }
 139
 140   void updateObject(ObjectPtr theObj) const;
 141
 142  protected:
 143   std::string myAttributeID; /// the attribute name of the model feature
 144   std::string myParentId;    /// name of parent
 145   FeaturePtr myFeature;
 146
 147   bool myIsComputedDefault; /// Value should be computed on execute,
 148   /// like radius for circle's constraint (can not be zero)
 149   bool myIsObligatory;      /// Non-obligatory widget is valid even if it is not initialized
 150 };
 151
 152 #endif