1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef MODULEBASE_WIDGETMULTISELECTOR_H_
22 #define MODULEBASE_WIDGETMULTISELECTOR_H_
24 #include <ModuleBase.h>
25 #include <ModuleBase_WidgetSelector.h>
27 #include <GeomAPI_Shape.h>
28 #include <ModelAPI_Result.h>
30 #include <NCollection_List.hxx>
31 #include <TopoDS_Shape.hxx>
35 #include <QStringList>
42 class ModuleBase_IWorkshop;
48 * Implementation of widget for shapes selection. This widget provides selection of several shapes.
49 * It can be defined in XML file as following:
51 * <multi_selector id="group_list"
52 * tooltip="Select a set of objects"
53 * type_choice="Vertices Edges Faces Solids" />
55 * It uses following parameters:
56 * - id - is a name of corresponded attribute
57 * - tooltip - a tooltip for the widget
58 * - type_choice - list of expected shape types.
60 class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetSelector
65 /// \param theParent the parent object
66 /// \param theWorkshop instance of workshop interface
67 /// \param theData the widget configuration. The attribute of the model widget is obtained from
68 ModuleBase_WidgetMultiSelector(QWidget* theParent,
69 ModuleBase_IWorkshop* theWorkshop,
70 const Config_WidgetAPI* theData);
71 virtual ~ModuleBase_WidgetMultiSelector();
73 /// Returns list of widget controls
74 /// \return a control list
75 virtual QList<QWidget*> getControls() const;
77 /// The methiod called when widget is deactivated
78 virtual void deactivate();
80 /// Set the given wrapped value to the current widget
81 /// This value should be processed in the widget according to the needs
82 /// \param theValues the wrapped selection values
83 /// \param theToValidate a validation of the values flag
84 virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
85 const bool theToValidate);
87 /// Returns values which should be highlighted when the whidget is active
88 /// \param theValues a list of presentations
89 virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
91 /// Returns true if the action can be processed. The default implementation is empty, returns false.
92 /// \param theActionType an action type
93 /// \param isActionEnabled if true, the enable state of the action
94 virtual bool canProcessAction(ModuleBase_ActionType theActionType, bool& isActionEnabled);
96 /// Returns true if the event is processed. The default implementation is empty, returns false.
97 virtual bool processAction(ModuleBase_ActionType theActionType);
99 /// Activate or deactivate selection and selection filters
100 /// \return true if the selection filter of the widget is activated in viewer context
101 virtual bool activateSelectionAndFilters(bool toActivate);
103 /// Checks the widget validity. By default, it returns true.
104 /// \param thePrs a selected presentation in the view
105 /// \return a boolean value
106 virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
109 /// Slot is called on selection type changed
110 void onSelectionTypeChanged();
112 /// Slot which is called on selection event. Redefined to process XML state about
113 /// clear selection in neutral point
114 virtual void onSelectionChanged();
117 /// Slot for copy command in a list pop-up menu
120 /// Slot for delete command in a list pop-up menu
123 /// Slot is called on selection of list of selected items
124 void onListSelection();
127 /// Returns true if the event is processed. The default implementation is empty, returns false.
128 virtual bool processDelete();
130 /// The methiod called when widget is activated
131 virtual void activateCustom();
133 /// Saves the internal parameters to the given feature
134 /// \return True in success
135 virtual bool storeValueCustom();
137 /// restire type of selection by feature attribute
138 virtual bool restoreValueCustom();
140 /// Creates an element of the attribute current selection if history is empty
141 virtual void appendFirstSelectionInHistory();
143 /// Create an element in the history that stores the current selection,
144 /// position in the history is incremented
145 void appendSelectionInHistory();
147 /// Clear list of stored selected items, reset current position into '-1'
148 void clearSelectedHistory();
150 /// Set the focus on the last item in the list
151 virtual void updateFocus();
153 /// Computes and updates name of selected object in the widget
154 virtual void updateSelectionName();
156 /// Emits model changed info, updates the current control by selection change
157 /// \param theDone a state whether the selection is set
158 virtual void updateOnSelectionChanged(const bool theDone);
160 /// Retunrs a list of possible shape types
161 /// \return a list of shapes
162 virtual QIntList shapeTypes() const;
164 /// Set current shape type for selection
165 void setCurrentShapeType(const int theShapeType);
167 /// Return the attribute values wrapped in a list of viewer presentations
168 /// \return a list of viewer presentations, which contains an attribute result and
169 /// a shape. If the attribute do not uses the shape, it is empty
170 virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getAttributeSelection() const;
172 /// Fills the list control by the attribute values
173 void updateSelectionList();
175 /// Converts the XML defined type choice to the validator type
176 /// For example, the "Edges" is converted to "edge"
177 std::string validatorType(const QString& theType) const;
179 /// Clear selection in the viewer. The content of the widget is cleared also
180 void clearSelection();
183 /// Returns attribute indices selected in the widget selection list
184 /// \param theIndices a list of indices
185 void getSelectedAttributeIndices(std::set<int>& theIndices);
187 /// Gets the feature attribute and fill a list of viewer presentation for the attribute
188 /// indices. If the the container of indices is empty, it returns all objects.
189 /// \param theAttributeIds indices in attribute list to be returned
190 /// \param theValues the result presentations, filled with object and shape of an attribute item
191 void convertIndicesToViewerSelection(std::set<int> theAttributeIds,
192 QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) const;
194 /// Iterates throgh the model attribute list and remove elements which do not present in the list
195 /// \param theValues the wrapped selection values
196 /// \return true if at least one object is removed
197 virtual bool removeUnusedAttributeObjects(
198 QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
200 /// Converts viewer presentation selection list to objects and shapes map
201 /// \param theValues the wrapped selection values
202 /// \return selection list
203 std::map<ObjectPtr, std::set<GeomShapePtr> > convertSelection
204 (QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
206 /// Returns true if the object and shape present in the container
207 /// \param theObject a model object, a set of shapes is searched by it
208 /// \param theShape a shape to be in the set of the object shapes
209 /// \param theGeomSelection a map built on selection
210 /// \param theWorkshop a current workshop
211 /// \return boolean result
212 static bool findInSelection(const ObjectPtr& theObject,
213 GeomShapePtr theShape,
214 const std::map<ObjectPtr, std::set<GeomShapePtr> >& theGeomSelection,
215 ModuleBase_IWorkshop* theWorkshop);
219 QListWidget* myListControl;
221 /// Combobox of types
222 QComboBox* myTypeCombo;
224 /// Provides correspondance between Result object and its shape
225 typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
227 /// A copy action for pop-up menu in a list control
228 QAction* myCopyAction;
230 /// A delete action for pop-up menu in a list control
231 QAction* myDeleteAction;
233 /// A flag to store use_choice parameter state
236 /// A flag to clear selection by click in empty place in the viewer
237 bool myIsNeutralPointClear;
239 /// A flag to block set selection perform if the method is in process
240 bool myIsSetSelectionBlocked;
242 /// A container of selected objects
243 QList<QList<std::shared_ptr<ModuleBase_ViewerPrs> > > mySelectedHistoryValues;
244 /// Position in a container of selected values
245 int myCurrentHistoryIndex;
248 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */