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;
37 * Implementation of widget for shapes selection. This widget provides selection of several shapes.
38 * It can be defined in XML file as following:
40 * <multi_selector id="group_list"
41 * tooltip="Select a set of objects"
42 * type_choice="Vertices Edges Faces Solids" />
44 * It uses following parameters:
45 * - id - is a name of corresponded attribute
46 * - tooltip - a tooltip for the widget
47 * - type_choice - list of expected shape types.
49 class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetSelector
54 /// \param theParent the parent object
55 /// \param theWorkshop instance of workshop interface
56 /// \param theData the widget configuration. The attribute of the model widget is obtained from
57 /// \param theParentId is Id of a parent of the current attribute
58 ModuleBase_WidgetMultiSelector(QWidget* theParent,
59 ModuleBase_IWorkshop* theWorkshop,
60 const Config_WidgetAPI* theData,
61 const std::string& theParentId);
62 virtual ~ModuleBase_WidgetMultiSelector();
64 /// Returns list of widget controls
65 /// \return a control list
66 virtual QList<QWidget*> getControls() const;
68 /// The methiod called when widget is deactivated
69 virtual void deactivate();
71 /// Set the given wrapped value to the current widget
72 /// This value should be processed in the widget according to the needs
73 /// \param theValues the wrapped selection values
74 /// \param theToValidate a validation of the values flag
75 virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
76 const bool theToValidate);
78 /// Returns values which should be highlighted when the whidget is active
79 /// \param theValues a list of presentations
80 virtual void getHighlighted(QList<ModuleBase_ViewerPrs>& theValues);
82 /// Checks the widget validity. By default, it returns true.
83 /// \param thePrs a selected presentation in the view
84 /// \return a boolean value
85 virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
87 /// Returns true if the event is processed. The default implementation is empty, returns false.
88 virtual bool processDelete();
91 /// Slot is called on selection type changed
92 void onSelectionTypeChanged();
95 /// Slot for copy command in a list pop-up menu
98 /// Slot for delete command in a list pop-up menu
101 /// Slot is called on selection of list of selected items
102 void onListSelection();
105 /// The methiod called when widget is activated
106 virtual void activateCustom();
108 /// Saves the internal parameters to the given feature
109 /// \return True in success
110 virtual bool storeValueCustom() const;
112 virtual bool restoreValueCustom();
114 /// Creates a backup of the current values of the attribute
115 /// It should be realized in the specific widget because of different
116 /// parameters of the current attribute
117 virtual void storeAttributeValue();
119 /// Fills the attribute with the value of the selected owner
120 /// \param thePrs a selected owner
121 virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
124 virtual void clearAttribute();
126 /// Set the focus on the last item in the list
127 virtual void updateFocus();
129 /// Computes and updates name of selected object in the widget
130 virtual void updateSelectionName();
132 /// Retunrs a list of possible shape types
133 /// \return a list of shapes
134 virtual QIntList getShapeTypes() const;
136 /// Append the values to the model attribute of the widget. It casts this attribute to
137 /// the specific type and set the given values
138 /// \param theSelectedObject an object
139 /// \param theShape a selected shape, which is used in the selection attribute
140 /// \return true if it is succeed
141 void setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape);
143 /// Creates a backup of the current values of the attribute
144 /// It should be realized in the specific widget because of different
145 /// parameters of the current attribute
146 /// \param theValid a boolean flag, if restore happens for valid parameters
147 virtual void restoreAttributeValue(const bool theValid);
149 /// Set current shape type for selection
150 void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
152 /// Return the attribute values wrapped in a list of viewer presentations
153 /// \return a list of viewer presentations, which contains an attribute result and
154 /// a shape. If the attribute do not uses the shape, it is empty
155 virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
157 /// Fills the list control by the attribute values
158 void updateSelectionList();
160 /// Converts the XML defined type choice to the validator type
161 /// For example, the "Edges" is converted to "edge"
162 std::string validatorType(const QString& theType) const;
165 /// Returns attribute indices selected in the widget selection list
166 /// \param theIndices a list of indices
167 void getSelectedAttributeIndices(std::set<int>& theIndices);
169 /// Gets the feature attribute and fill a list of viewer presentation for the attribute
170 /// indices. If the the container of indices is empty, it returns all objects.
171 /// \param theAttributeIds indices in attribute list to be returned
172 /// \param theValues the result presentations, filled with object and shape of an attribute item
173 void convertIndicesToViewerSelection(std::set<int> theAttributeIds,
174 QList<ModuleBase_ViewerPrs>& theValues) const;
177 QListWidget* myListControl;
179 /// Combobox of types
180 QComboBox* myTypeCombo;
182 /// Provides correspondance between Result object and its shape
183 typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
185 /// An action for pop-up menu in a list control
186 QAction* myCopyAction;
187 QAction* myDeleteAction;
189 /// backup parameters of the model attribute. The class processes three types of attribute:
190 /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
191 /// values are reserved in the backup
192 /// Variable of selection type
193 std::string mySelectionType;
195 /// Variable of GeomSelection
196 int mySelectionCount; // number of elements in the attribute selection list when store
198 /// A flag to store use_choice parameter state
202 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */