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