1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
4 * ModuleBase_WidgetMultiSelector.h
6 * Created on: Oct 8, 2014
10 #ifndef MODULEBASE_WIDGETMULTISELECTOR_H_
11 #define MODULEBASE_WIDGETMULTISELECTOR_H_
13 #include <ModuleBase.h>
14 #include <ModuleBase_WidgetSelector.h>
16 #include <GeomAPI_Shape.h>
17 #include <ModelAPI_Result.h>
19 #include <NCollection_List.hxx>
20 #include <TopoDS_Shape.hxx>
24 #include <QStringList>
31 class ModuleBase_IWorkshop;
32 class GeomValidators_ShapeType;
38 * Implementation of widget for shapes selection. This widget provides selection of several shapes.
39 * It can be defined in XML file as following:
41 * <multi_selector id="group_list"
42 * tooltip="Select a set of objects"
43 * type_choice="Vertices Edges Faces Solids" />
45 * It uses following parameters:
46 * - id - is a name of corresponded attribute
47 * - tooltip - a tooltip for the widget
48 * - type_choice - list of expected shape types.
50 class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetSelector
55 /// \param theParent the parent object
56 /// \param theWorkshop instance of workshop interface
57 /// \param theData the widget configuration. The attribute of the model widget is obtained from
58 /// \param theParentId is Id of a parent of the current attribute
59 ModuleBase_WidgetMultiSelector(QWidget* theParent,
60 ModuleBase_IWorkshop* theWorkshop,
61 const Config_WidgetAPI* theData,
62 const std::string& theParentId);
63 virtual ~ModuleBase_WidgetMultiSelector();
65 /// Returns list of widget controls
66 /// \return a control list
67 virtual QList<QWidget*> getControls() const;
69 /// Set the given wrapped value to the current widget
70 /// This value should be processed in the widget according to the needs
71 /// \param theValues the wrapped selection values
72 virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
73 const bool theToValidate);
75 /// Checks the widget validity. By default, it returns true.
76 /// \param theValue a selected presentation in the view
77 /// \return a boolean value
78 virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
81 /// Slot is called on selection type changed
82 void onSelectionTypeChanged();
85 /// Slot for copy command in a list pop-up menu
88 /// Slot is called on selection of list of selected items
89 void onListSelection();
92 /// Saves the internal parameters to the given feature
93 /// \return True in success
94 virtual bool storeValueCustom() const;
96 virtual bool restoreValueCustom();
98 /// Creates a backup of the current values of the attribute
99 /// It should be realized in the specific widget because of different
100 /// parameters of the current attribute
101 virtual void storeAttributeValue();
104 virtual void clearAttribute();
106 // Set the focus on the last item in the list
107 virtual void updateFocus();
109 /// Computes and updates name of selected object in the widget
110 virtual void updateSelectionName();
112 /// Retunrs a list of possible shape types
113 /// \return a list of shapes
114 virtual QIntList getShapeTypes() const;
116 /// Append the values to the model attribute of the widget. It casts this attribute to
117 /// the specific type and set the given values
118 /// \param theSelectedObject an object
119 /// \param theShape a selected shape, which is used in the selection attribute
120 /// \return true if it is succeed
121 void setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape);
123 /// Creates a backup of the current values of the attribute
124 /// It should be realized in the specific widget because of different
125 /// parameters of the current attribute
126 /// \param theValid a boolean flag, if restore happens for valid parameters
127 virtual void restoreAttributeValue(const bool theValid);
129 /// Set current shape type for selection
130 void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
132 /// Return the attribute values wrapped in a list of viewer presentations
133 /// \return a list of viewer presentations, which contains an attribute result and
134 /// a shape. If the attribute do not uses the shape, it is empty
135 virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
137 /// Fills the list control by the attribute values
138 void updateSelectionList();
140 /// Converts the XML defined type choice to the validator type
141 /// For example, the "Edges" is converted to "edge"
142 std::string validatorType(const QString& theType) const;
146 QListWidget* myListControl;
148 /// Combobox of types
149 QComboBox* myTypeCombo;
151 /// Provides correspondance between Result object and its shape
152 typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
154 /// An action for pop-up menu in a list control
155 QAction* myCopyAction;
157 /// backup parameters of the model attribute. The class processes three types of attribute:
158 /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
159 /// values are reserved in the backup
160 /// Variable of selection type
161 std::string mySelectionType;
163 /// Variable of GeomSelection
164 int mySelectionCount; // number of elements in the attribute selection list when store
169 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */