Salome HOME
ModuleBase_ViewerPrs is wrapped into shared_ptr.
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetValidated.h
index d53bbb705beee95affa492329f44bbea9b49cb8c..8b2ae15ba440f206f71ba7b03f1d27d4bc2f4bff 100644 (file)
@@ -14,6 +14,7 @@
 #include <GeomAPI_Shape.h>
 #include <GeomAPI_AISObject.h>
 #include <ModelAPI_Object.h>
+#include <ModelAPI_Attribute.h>
 
 #include <SelectMgr_ListOfFilter.hxx>
 
@@ -22,6 +23,7 @@
 class QWidget;
 class ModuleBase_IWorkshop;
 class ModuleBase_ISelection;
+class ModuleBase_WidgetSelectorStore;
 class ModelAPI_Validator;
 class Config_WidgetAPI;
 class Handle_SelectMgr_EntityOwner;
@@ -36,100 +38,132 @@ class MODULEBASE_EXPORT ModuleBase_WidgetValidated : public ModuleBase_ModelWidg
  public:
   /// Constructor
   /// \param theParent the parent object
+  /// \param theWorkshop a reference to workshop
   /// \param theData the widget configuation. The attribute of the model widget is obtained from
-  /// \param theParentId is Id of a parent of the current attribute
   ModuleBase_WidgetValidated(QWidget* theParent,
                              ModuleBase_IWorkshop* theWorkshop,
-                             const Config_WidgetAPI* theData,
-                             const std::string& theParentId);
+                             const Config_WidgetAPI* theData);
   virtual ~ModuleBase_WidgetValidated();
 
-  /// Checks whether all active viewer filters validate the presentation
-  /// \param theWorkshop an active workshop
+  /// Checks all widget validator if the owner is valid. Firstly it checks custom widget validating,
+  /// next, the attribute's validating. It trying on the give selection to current attribute by
+  /// setting the value inside and calling validators. After this, the previous attribute value is
+  /// restored.The valid/invalid value is cashed.
   /// \param theValue a selected presentation in the view
   /// \return a boolean value
-  bool isValidInFilters(const ModuleBase_ViewerPrs& thePrs);
-
-  /// Checks all widget validator if the owner is valid
-  /// \param theValue a selected presentation in the view
-  /// \return a boolean value
-  bool isValidSelection(const ModuleBase_ViewerPrs& theValue);
-
-  /// Set the given wrapped value to the current widget
-  /// This value should be processed in the widget according to the needs
-  /// The method is called by the current operation to process the operation preselection.
-  /// It is redefined to check the value validity and if it is, fill the attribute with by value
-  /// \param theValues the wrapped selection values
-  virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
-                            const bool theToValidate);
+  virtual bool isValidSelection(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue);
 
   //! Returns data object by AIS
   ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
 
+  //! Clear all validated cash in the widget
+  void clearValidatedCash();
+
 protected:
+  /// Checks whether all active viewer filters validate the presentation
+  /// \param thePrs a selected presentation in the view
+  /// \return a boolean value
+  bool isValidInFilters(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
+
+  /// Checks all attribute validators returns valid. It tries on the given selection
+  /// to current attribute by setting the value inside and calling validators. After this,
+  /// the previous attribute value is restored.The valid/invalid value is cashed.
+  /// \param theValue a selected presentation in the view
+  /// \return a boolean value
+  bool isValidSelectionForAttribute(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue,
+                                    const AttributePtr& theAttribute);
+
+  /// Retunrs attribute, which should be validated. In default implementation,
+  /// this is an attribute of ID
+  /// \return an attribute
+  virtual AttributePtr attribute() const;
+
   /// Creates a backup of the current values of the attribute
   /// It should be realized in the specific widget because of different
   /// parameters of the current attribute
-  virtual void storeAttributeValue() = 0;
+  /// \param theAttribute an attribute to be stored
+  virtual void storeAttributeValue(const AttributePtr& theAttribute);
 
   /// Creates a backup of the current values of the attribute
   /// It should be realized in the specific widget because of different
   /// parameters of the current attribute
+  /// \param theAttribute an attribute to be restored
   /// \param theValid a boolean flag, if restore happens for valid parameters
-  virtual void restoreAttributeValue(const bool theValid) = 0;
+  virtual void restoreAttributeValue(const AttributePtr& theAttribute, const bool theValid);
 
   /// Checks the widget validity. By default, it returns true.
-  /// \param theValue a selected presentation in the view
+  /// \param thePrs a selected presentation in the view
   /// \return a boolean value
-  virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
+  virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 
   /// Fills the attribute with the value of the selected owner
-  /// \param theOwner a selected owner
-  virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs) = 0;
+  /// \param thePrs a selected owner
+  virtual bool setSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs) = 0;
+
+  /// Returns a list of selected presentations in the viewer and object browser
+  /// The presentations from the object browser are filtered by the AIS context filters
+  /// \return a list of presentations
+  QList<std::shared_ptr<ModuleBase_ViewerPrs>> getFilteredSelected();
 
+  /// It obtains selection filters from the workshop and activates them in the active viewer
+  /// \param toActivate a flag about activation or deactivation the filters
+  /// \return true if the selection filter of the widget is activated in viewer context
+  bool activateFilters(const bool toActivate);
+
+  /// Block the model flush of update and intialization of attribute
+  /// \param theAttribute an attribute of blocking
+  /// \param theToBlock flag whether the model is blocked or unblocked
+  /// \param isActive out value if model is blocked, in value if model is unblocked
+  /// to be used to restore flush state when unblocked
+  /// \param isAttributeSetInitializedBlocked out value if model is blocked
+  /// in value if model is unblocked to be used to restore previous state when unblocked
+  virtual void blockAttribute(const AttributePtr& theAttribute, const bool& theToBlock,
+                              bool& isFlushesActived, bool& isAttributeSetInitializedBlocked);
+
+private:
   /// Checks the current attibute in all attribute validators
-  // \return true if all validators return that the attribute is valid
-  bool isValidAttribute() const;
+  /// \param theAttribute an attribute to be validated
+  /// \return true if all validators return that the attribute is valid
+  bool isValidAttribute(const AttributePtr& theAttribute) const;
 
   /// Returns true if the workshop validator filter has been already activated
   /// \return boolean value
   bool isFilterActivated() const;
 
-  /// It obtains selection filters from the workshop and activates them in the active viewer
-  /// \param theWorkshop an active workshop
-  /// \param toActivate a flag about activation or deactivation the filters
-  void activateFilters(const bool toActivate);
-
+protected:
   /// Gets the validity state of the presentation in an internal map. Returns true if the valid state of value is stored
   /// \param theValue a viewer presentation
   /// \param theValid a valid state
-  bool getValidState(const ModuleBase_ViewerPrs& theValue, bool& theValid);
+  bool getValidState(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue, bool& theValid);
 
   /// Store the validity state of the presentation in an internal map
   /// \param theValue a viewer presentation
   /// \param theValid a valid state
-  void storeValidState(const ModuleBase_ViewerPrs& theValue, const bool theValid);
-
-  // Removes all presentations from internal maps.
-  void clearValidState();
-
-  /// Returns a list of selected presentations in the viewer and object browser
-  /// The presentations from the object browser are filtered by the AIS context filters
-  /// \return a list of presentations
-  QList<ModuleBase_ViewerPrs> getFilteredSelected();
+  void storeValidState(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue, const bool theValid);
 
+private:
   /// Applies AIS context filters to the parameter list. The not approved presentations are
   /// removed from the parameters.
   /// \param theValues a list of presentations.
-  void filterPresentations(QList<ModuleBase_ViewerPrs>& theValues);
+  void filterPresentations(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
+
+  /// Remove subshapes of compsolids if whole compsolid is present.
+  /// \param theValues a list of presentations.
+  void filterCompSolids(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
 
 protected:
-  ModuleBase_IWorkshop* myWorkshop;  /// Reference to workshop
+  /// Reference to workshop
+  ModuleBase_IWorkshop* myWorkshop;
+  /// The widget is in validation mode: store is performed, restore is not
+  bool myIsInValidate;
 
 private:
   ObjectPtr myPresentedObject; /// back up of the filtered object
-  QList<ModuleBase_ViewerPrs> myValidPrs;
-  QList<ModuleBase_ViewerPrs> myInvalidPrs;
+  QList<std::shared_ptr<ModuleBase_ViewerPrs>> myValidPrs; /// cash of valid selection presentations
+  QList<std::shared_ptr<ModuleBase_ViewerPrs>> myInvalidPrs; /// cash of invalid selection presentations
+
+  /// store to backup parameters of the model
+  ModuleBase_WidgetSelectorStore* myAttributeStore;
 };
 
 #endif /* MODULEBASE_WIDGETVALIDATED_H_ */