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