src/ModuleBase/ModuleBase_WidgetValidated.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModuleBase_WidgetValidated.h
   4 // Created:     12 Mar 2015
   5 // Author:      Natalia ERMOLAEVA
   6
   7
   8 #ifndef MODULEBASE_WIDGETVALIDATED_H_
   9 #define MODULEBASE_WIDGETVALIDATED_H_
  10
  11 #include <ModuleBase.h>
  12 #include <ModuleBase_ModelWidget.h>
  13
  14 #include <GeomAPI_Shape.h>
  15 #include <ModelAPI_Object.h>
  16
  17 #include <SelectMgr_ListOfFilter.hxx>
  18
  19 class QWidget;
  20 class ModuleBase_IWorkshop;
  21 class ModuleBase_ISelection;
  22 class ModelAPI_Validator;
  23 class Config_WidgetAPI;
  24 class Handle_SelectMgr_EntityOwner;
  25
  26 /**
  27 * \ingroup GUI
  28 * Implementation of widget with validators and filters processing.
  29 */
  30 class MODULEBASE_EXPORT ModuleBase_WidgetValidated : public ModuleBase_ModelWidget
  31 {
  32   Q_OBJECT
  33  public:
  34   /// Constructor
  35   /// \param theParent the parent object
  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_WidgetValidated(QWidget* theParent,
  39                              const Config_WidgetAPI* theData,
  40                              const std::string& theParentId);
  41   virtual ~ModuleBase_WidgetValidated();
  42
  43   /// Checks all widget validator if the owner is valid
  44   /// \param theOwner a selected owner in the view
  45   /// \return a boolean value
  46   bool isValidSelection(const ModuleBase_ViewerPrs& theValue);
  47
  48   /// Set the given wrapped value to the current widget
  49   /// This value should be processed in the widget according to the needs
  50   /// The method is called by the current operation to process the operation preselection.
  51   /// It is redefined to check the value validity and if it is, fill the attribute with by value
  52   /// \param theValues the wrapped selection values
  53   /// \param thePosition an index in the list of values, the values should be get from the index
  54   virtual bool setSelection(const QList<ModuleBase_ViewerPrs>& theValues, int& thePosition);
  55
  56 protected:
  57   /// Creates a backup of the current values of the attribute
  58   /// It should be realized in the specific widget because of different
  59   /// parameters of the current attribute
  60   virtual void storeAttributeValue() = 0;
  61
  62   /// Creates a backup of the current values of the attribute
  63   /// It should be realized in the specific widget because of different
  64   /// parameters of the current attribute
  65   /// \param theValid a boolean flag, if restore happens for valid parameters
  66   virtual void restoreAttributeValue(const bool theValid) = 0;
  67
  68   /// Fills the attribute with the value of the selected owner
  69   /// \param theOwner a selected owner
  70   virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs) = 0;
  71
  72   virtual void removePresentations() {};
  73
  74   /// Checks the current attibute in all attribute validators
  75   // \return true if all validators return that the attribute is valid
  76   bool isValidAttribute() const;
  77
  78   /// It obtains selection filters from the workshop and activates them in the active viewer
  79   /// \param theWorkshop an active workshop
  80   /// \param toActivate a flag about activation or deactivation the filters
  81   virtual void activateFilters(ModuleBase_IWorkshop* theWorkshop, const bool toActivate) const;
  82
  83   /// Puts additional validators to the given list
  84   /// \param theValidators a list of validators
  85   /// \param theArguments a list of validators arguments
  86   virtual void customValidators(std::list<ModelAPI_Validator*>& theValidators,
  87                                 std::list<std::list<std::string> >& theArguments) const;
  88
  89   /// Returns a list of selected presentations. Firstly it is obtained from the viewer,
  90   /// if there are not selected objects in the viewer, it get the selection from the object browser.
  91   /// If the browser has selected objects, the viewer prs objects are created with only object
  92   /// field of the presentation initialized. The widget should accept the selection in the object
  93   /// browser at the same way as in the viewer.
  94   /// \param theSelection a selection, where the selected objects and presentations are found
  95   /// \return a list of presentations
  96   QList<ModuleBase_ViewerPrs> getSelectedEntitiesOrObjects(ModuleBase_ISelection* theSelection) const;
  97
  98 };
  99
 100 #endif /* MODULEBASE_WIDGETVALIDATED_H_ */