src/ModuleBase/ModuleBase_WidgetSelector.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModuleBase_WidgetSelector.h
   4 // Created:     19 June 2015
   5 // Author:      Natalia ERMOLAEVA
   6
   7 #ifndef ModuleBase_WidgetSelector_H
   8 #define ModuleBase_WidgetSelector_H
   9
  10 #include "ModuleBase.h"
  11 #include "ModuleBase_WidgetValidated.h"
  12 #include <ModuleBase_ViewerPrs.h>
  13 #include "ModuleBase_Definitions.h"
  14
  15 #include <ModelAPI_Object.h>
  16 #include <ModelAPI_Attribute.h>
  17 #include <GeomAPI_Shape.h>
  18
  19 class Config_WidgetAPI;
  20 class QWidget;
  21 class ModuleBase_IWorkshop;
  22
  23 /**
  24 * \ingroup GUI
  25 * Implementation of widget for selection.
  26 * This abstract interface is designed to be used for shape/multi shape selector widgets.
  27 */
  28 class MODULEBASE_EXPORT ModuleBase_WidgetSelector : public ModuleBase_WidgetValidated
  29 {
  30 Q_OBJECT
  31  public:
  32
  33   /// Constructor
  34   /// \param theParent the parent object
  35   /// \param theWorkshop instance of workshop interface
  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_WidgetSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
  39                             const Config_WidgetAPI* theData, const std::string& theParentId);
  40
  41   virtual ~ModuleBase_WidgetSelector();
  42
  43   /// Defines if it is supposed that the widget should interact with the viewer.
  44   virtual bool isViewerSelector() { return true; }
  45
  46   /// Activate or deactivate selection and selection filters
  47   /// \return true if the selection filter of the widget is activated in viewer context
  48   virtual bool activateSelectionAndFilters(bool toActivate);
  49
  50   /// Checks the widget validity. By default, it returns true.
  51   /// \param thePrs a selected presentation in the view
  52   /// \return a boolean value
  53   virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  54
  55   /// Fills the attribute with the value of the selected owner
  56   /// \param thePrs a selected owner
  57   virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  58
  59   /// The methiod called when widget is deactivated
  60   virtual void deactivate();
  61
  62  private slots:
  63    /// Slot which is called on selection event
  64   void onSelectionChanged();
  65
  66  protected:
  67   /// Update focus after the attribute value change
  68   virtual void updateFocus() = 0;
  69
  70   /// Return the attribute values wrapped in a list of viewer presentations
  71   /// \return a list of viewer presentations, which contains an attribute result and
  72   /// a shape. If the attribute do not uses the shape, it is empty
  73   virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const = 0;
  74
  75   /// Retunrs a list of possible shape types
  76   /// \return a list of shapes
  77   virtual QIntList getShapeTypes() const = 0;
  78
  79   /// Computes and updates name of selected object in the widget
  80   virtual void updateSelectionName() = 0;
  81
  82   /// Store the values to the model attribute of the widget. It casts this attribute to
  83   /// the specific type and set the given values
  84   /// \param theSelectedObject an object
  85   /// \param theShape a selected shape, which is used in the selection attribute
  86   /// \return true if it is succeed
  87   virtual void setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape) = 0;
  88
  89   /// The methiod called when widget is activated
  90   virtual void activateCustom();
  91
  92   /// Returns true if selected shape corresponds to requested shape types.
  93   /// If the widget type of shapes contains the faces item, the result is converted
  94   /// to construction result and the method returns true if there is at least one face
  95   /// in the construction.
  96   /// \param theShape a shape
  97   /// \param theResult a selected result
  98   bool acceptSubShape(const GeomShapePtr& theShape, const ResultPtr& theResult) const;
  99
 100   /// Return an object and geom shape by the viewer presentation
 101   /// \param thePrs a selection
 102   /// \param theObject an output object
 103   /// \param theShape a shape of the selection
 104   virtual void getGeomSelection(const ModuleBase_ViewerPrs& thePrs,
 105                                 ObjectPtr& theObject,
 106                                 GeomShapePtr& theShape);
 107
 108   //----------- Class members -------------
 109   /// Returns a name in the next form: attribute_feature_name/attribute_id
 110   /// \param theAttribute a model attribute
 111   /// \return string value
 112   static std::string generateName(const AttributePtr& theAttribite,
 113                                   ModuleBase_IWorkshop* theWorkshop);
 114 };
 115
 116 #endif