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>
20 class ModuleBase_IWorkshop;
21 class ModuleBase_ISelection;
22 class Config_WidgetAPI;
23 class Handle_SelectMgr_EntityOwner;
27 * Implementation of widget with validators and filters processing.
29 class MODULEBASE_EXPORT ModuleBase_WidgetValidated : public ModuleBase_ModelWidget
34 /// \param theParent the parent object
35 /// \param theData the widget configuation. The attribute of the model widget is obtained from
36 /// \param theParentId is Id of a parent of the current attribute
37 ModuleBase_WidgetValidated(QWidget* theParent,
38 const Config_WidgetAPI* theData,
39 const std::string& theParentId);
40 virtual ~ModuleBase_WidgetValidated();
42 /// Checks all widget validator if the owner is valid
43 /// \param theOwner a selected owner in the view
44 /// \return a boolean value
45 bool isValidSelection(const ModuleBase_ViewerPrs& theValue);
47 /// Set the given wrapped value to the current widget
48 /// This value should be processed in the widget according to the needs
49 /// The method is called by the current operation to process the operation preselection.
50 /// It is redefined to check the value validity and if it is, fill the attribute with by value
51 /// \param theValues the wrapped selection values
52 /// \param thePosition an index in the list of values, the values should be get from the index
53 virtual bool setSelection(const QList<ModuleBase_ViewerPrs>& theValues, int& thePosition);
56 /// Creates a backup of the current values of the attribute
57 /// It should be realized in the specific widget because of different
58 /// parameters of the current attribute
59 virtual void storeAttributeValue() = 0;
61 /// Creates a backup of the current values of the attribute
62 /// It should be realized in the specific widget because of different
63 /// parameters of the current attribute
64 /// \param theValid a boolean flag, if restore happens for valid parameters
65 virtual void restoreAttributeValue(const bool theValid) = 0;
67 /// Fills the attribute with the value of the selected owner
68 /// \param theOwner a selected owner
69 virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs) = 0;
71 virtual void removePresentations() {};
73 /// Checks the current attibute in all attribute validators
74 // \return true if all validators return that the attribute is valid
75 bool isValidAttribute() const;
77 /// It obtains selection filters from the workshop and activates them in the active viewer
78 /// \param theWorkshop an active workshop
79 /// \param toActivate a flag about activation or deactivation the filters
80 virtual void activateFilters(ModuleBase_IWorkshop* theWorkshop, const bool toActivate) const;
82 /// Returns a list of selected presentations. Firstly it is obtained from the viewer,
83 /// if there are not selected objects in the viewer, it get the selection from the object browser.
84 /// If the browser has selected objects, the viewer prs objects are created with only object
85 /// field of the presentation initialized. The widget should accept the selection in the object
86 /// browser at the same way as in the viewer.
87 /// \param theSelection a selection, where the selected objects and presentations are found
88 /// \return a list of presentations
89 QList<ModuleBase_ViewerPrs> getSelectedEntitiesOrObjects(ModuleBase_ISelection* theSelection) const;
93 #endif /* MODULEBASE_WIDGETVALIDATED_H_ */