1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModuleBase_WidgetValidated.h
4 // Created: 12 Mar 2015
5 // Author: Natalia ERMOLAEVA
8 #ifndef MODULEBASE_WIDGETVALIDATED_H_
9 #define MODULEBASE_WIDGETVALIDATED_H_
11 #include <ModuleBase.h>
12 #include <ModuleBase_ModelWidget.h>
14 #include <GeomAPI_Shape.h>
15 #include <ModelAPI_Object.h>
17 #include <SelectMgr_ListOfFilter.hxx>
22 class ModuleBase_IWorkshop;
23 class ModuleBase_ISelection;
24 class ModelAPI_Validator;
25 class Config_WidgetAPI;
26 class Handle_SelectMgr_EntityOwner;
30 * Implementation of widget with validators and filters processing.
32 class MODULEBASE_EXPORT ModuleBase_WidgetValidated : public ModuleBase_ModelWidget
37 /// \param theParent the parent object
38 /// \param theData the widget configuation. The attribute of the model widget is obtained from
39 /// \param theParentId is Id of a parent of the current attribute
40 ModuleBase_WidgetValidated(QWidget* theParent,
41 const Config_WidgetAPI* theData,
42 const std::string& theParentId);
43 virtual ~ModuleBase_WidgetValidated();
45 /// Checks all widget validator if the owner is valid
46 /// \param theValue a selected presentation in the view
47 /// \return a boolean value
48 bool isValidSelection(const ModuleBase_ViewerPrs& theValue);
50 /// Set the given wrapped value to the current widget
51 /// This value should be processed in the widget according to the needs
52 /// The method is called by the current operation to process the operation preselection.
53 /// It is redefined to check the value validity and if it is, fill the attribute with by value
54 /// \param theValues the wrapped selection values
55 virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues);
58 /// Creates a backup of the current values of the attribute
59 /// It should be realized in the specific widget because of different
60 /// parameters of the current attribute
61 virtual void storeAttributeValue() = 0;
63 /// Creates a backup of the current values of the attribute
64 /// It should be realized in the specific widget because of different
65 /// parameters of the current attribute
66 /// \param theValid a boolean flag, if restore happens for valid parameters
67 virtual void restoreAttributeValue(const bool theValid) = 0;
69 /// Checks the widget validity. By default, it returns true.
70 /// \param theValue a selected presentation in the view
71 /// \return a boolean value
72 virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
74 /// Fills the attribute with the value of the selected owner
75 /// \param theOwner a selected owner
76 virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs) = 0;
78 /// Checks the current attibute in all attribute validators
79 // \return true if all validators return that the attribute is valid
80 bool isValidAttribute() const;
82 /// It obtains selection filters from the workshop and activates them in the active viewer
83 /// \param theWorkshop an active workshop
84 /// \param toActivate a flag about activation or deactivation the filters
85 virtual void activateFilters(ModuleBase_IWorkshop* theWorkshop, const bool toActivate);
87 /// Gets the validity state of the presentation in an internal map. Returns true if the valid state of value is stored
88 /// \param theValue a viewer presentation
89 /// \param theValid a valid state
90 bool getValidState(const ModuleBase_ViewerPrs& theValue, bool& theValid);
92 /// Store the validity state of the presentation in an internal map
93 /// \param theValue a viewer presentation
94 /// \param theValid a valid state
95 void storeValidState(const ModuleBase_ViewerPrs& theValue, const bool theValid);
97 // Removes all presentations from internal maps.
98 void clearValidState();
101 QList<ModuleBase_ViewerPrs> myValidPrs;
102 QList<ModuleBase_ViewerPrs> myInvalidPrs;
103 bool isValidateBlocked;
106 #endif /* MODULEBASE_WIDGETVALIDATED_H_ */