Salome HOME
Selection correction for "objects" type defined in XML. It is not possible to use...
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetMultiSelector.h
old mode 100644 (file)
new mode 100755 (executable)
index a9f7c46..5a9382a
 #define MODULEBASE_WIDGETMULTISELECTOR_H_
 
 #include <ModuleBase.h>
-#include <ModuleBase_WidgetValidated.h>
+#include <ModuleBase_WidgetSelector.h>
 
 #include <GeomAPI_Shape.h>
 #include <ModelAPI_Result.h>
-#include <ModelAPI_AttributeSelectionList.h>
 
 #include <NCollection_List.hxx>
 #include <TopoDS_Shape.hxx>
@@ -30,7 +29,6 @@ class QWidget;
 class QListWidget;
 class QComboBox;
 class ModuleBase_IWorkshop;
-class GeomValidators_ShapeType;
 class QAction;
 
 
@@ -43,31 +41,24 @@ class QAction;
 *    tooltip="Select a set of objects" 
 *    type_choice="Vertices Edges Faces Solids" /> 
 * \endcode
-* It uses folloing parameters:
+* It uses following parameters:
 * - id - is a name of corresponded attribute
 * - tooltip - a tooltip for the widget
 * - type_choice - list of expected shape types.
 */
-class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetValidated
+class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetSelector
 {
   Q_OBJECT
  public:
   /// Constructor
   /// \param theParent the parent object
   /// \param theWorkshop instance of workshop interface
-  /// \param theData the widget configuation. The attribute of the model widget is obtained from
-  /// \param theParentId is Id of a parent of the current attribute
+  /// \param theData the widget configuration. The attribute of the model widget is obtained from
   ModuleBase_WidgetMultiSelector(QWidget* theParent,
                                  ModuleBase_IWorkshop* theWorkshop,
-                                 const Config_WidgetAPI* theData,
-                                 const std::string& theParentId);
+                                 const Config_WidgetAPI* theData);
   virtual ~ModuleBase_WidgetMultiSelector();
 
-  //TODO: nds stabilization hotfix
-  virtual void disconnectSignals();
-
-  virtual bool restoreValue();
-
   /// Returns list of widget controls
   /// \return a control list
   virtual QList<QWidget*> getControls() const;
@@ -78,102 +69,128 @@ class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_Widge
   /// Set the given wrapped value to the current widget
   /// This value should be processed in the widget according to the needs
   /// \param theValues the wrapped selection values
-  virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues);
+  /// \param theToValidate a validation of the values flag
+  virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
+                            const bool theToValidate);
+
+  /// Returns values which should be highlighted when the whidget is active
+  /// \param theValues a list of presentations
+  virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
 
   /// Checks the widget validity. By default, it returns true.
-  /// \param theValue a selected presentation in the view
+  /// \param thePrs a selected presentation in the view
   /// \return a boolean value
-  virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
+  virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 
-  /// Fills the attribute with the value of the selected owner
-  /// \param theOwner a selected owner
-  virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
+  /// Returns true if the event is processed. The default implementation is empty, returns false.
+  virtual bool processDelete();
 
- public slots:
+public slots:
   /// Slot is called on selection type changed
   void onSelectionTypeChanged();
 
-  /// Slot is called on selection changed
+  /// Slot which is called on selection event. Redefined to process XML state about
+  /// clear selection in neutral point
   virtual void onSelectionChanged();
 
 protected slots:
   /// Slot for copy command in a list pop-up menu
   void onCopyItem();
 
+  /// Slot for delete command in a list pop-up menu
+  void onDeleteItem();
+
   /// Slot is called on selection of list of selected items
   void onListSelection();
 
- protected:
+protected:
   /// The methiod called when widget is activated
   virtual void activateCustom();
 
   /// Saves the internal parameters to the given feature
   /// \return True in success
-  virtual bool storeValueCustom() const;
+  virtual bool storeValueCustom();
 
-  /// Creates a backup of the current values of the attribute
-  /// It should be realized in the specific widget because of different
-  /// parameters of the current attribute
-  virtual void storeAttributeValue();
+  virtual bool restoreValueCustom();
 
-  /// Creates a backup of the current values of the attribute
-  /// It should be realized in the specific widget because of different
-  /// parameters of the current attribute
-  /// \param theValid a boolean flag, if restore happens for valid parameters
-  virtual void restoreAttributeValue(const bool theValid);
+  /// Set the focus on the last item in  the list
+  virtual void updateFocus();
 
-  /// Returns true if selected shape corresponds to requested shape types
-  /// \param theShape a shape
-  bool acceptSubShape(const TopoDS_Shape& theShape) const;
+  /// Computes and updates name of selected object in the widget
+  virtual void updateSelectionName();
 
-  /// Set current shape type for selection
-  void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
+  /// Retunrs a list of possible shape types
+  /// \return a list of shapes
+  virtual QIntList shapeTypes() const;
 
-  /// Start shape selection
-  /// \param isActivated a state whether the shape is activated or deactivated in selection
-  void activateShapeSelection(const bool isActivated);
+  /// Set current shape type for selection
+  void setCurrentShapeType(const int theShapeType);
 
   /// Return the attribute values wrapped in a list of viewer presentations
   /// \return a list of viewer presentations, which contains an attribute result and
   /// a shape. If the attribute do not uses the shape, it is empty
-  QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
+  virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getAttributeSelection() const;
 
- protected:
-  /// Update selection list
-  void updateSelectionList(AttributeSelectionListPtr);
+  /// Fills the list control by the attribute values
+  void updateSelectionList();
 
   /// Converts the XML defined type choice to the validator type
   /// For example, the "Edges" is converted to "edge"
   std::string validatorType(const QString& theType) const;
 
-   /// List control
+protected:
+  /// Returns attribute indices selected in the widget selection list 
+  /// \param theIndices a list of indices
+  void getSelectedAttributeIndices(std::set<int>& theIndices);
+
+  /// Gets the feature attribute and fill a list of viewer presentation for the attribute
+  /// indices. If the the container of indices is empty, it returns all objects.
+  /// \param theAttributeIds indices in attribute list to be returned
+  /// \param theValues the result presentations, filled with object and shape of an attribute item
+  void convertIndicesToViewerSelection(std::set<int> theAttributeIds,
+                                       QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) const;
+
+  /// Iterates throgh the model attribute list and remove elements which do not present in the list
+  /// \param theValues the wrapped selection values
+  /// \return true if at least one object is removed
+  virtual bool removeUnusedAttributeObjects(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
+
+  /// Converts viewer presentation selection list to objects and shapes map
+  /// \param theValues the wrapped selection values
+  /// \return selection list
+  std::map<ObjectPtr, std::set<GeomShapePtr> > convertSelection
+                                          (QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
+
+  /// Returns true if the object and shape present in the container
+  /// \param theObject a model object, a set of shapes is searched by it
+  /// \param theShape a shape to be in the set of the object shapes
+  /// \param theGeomSelection a map built on selection
+  /// \return boolean result
+  static bool findInSelection(const ObjectPtr& theObject,
+                            const GeomShapePtr& theShape,
+                            const std::map<ObjectPtr, std::set<GeomShapePtr> >& theGeomSelection);
+
+protected:
+  /// List control
   QListWidget* myListControl;
 
   /// Combobox of types
   QComboBox* myTypeCombo;
 
-  //TODO: Move into the base of selectors
-  ModuleBase_IWorkshop* myWorkshop;
-
   /// Provides correspondance between Result object and its shape
   typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
 
-  /// An action for pop-up menu in a list control
+  /// A copy action for pop-up menu in a list control
   QAction* myCopyAction;
 
-  /// backup parameters of the model attribute. The class processes three types of attribute:
-  /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
-  /// values are reserved in the backup
-  /// Variable of selection type
-  std::string mySelectionType;
-
-  /// Variable of GeomSelection
-  QList<GeomSelection> mySelection;
+  /// A delete action for pop-up menu in a list control
+  QAction* myDeleteAction;
 
-  /// An instance of the "type_choice" validator. It is returns on validating in customValidator()
-  GeomValidators_ShapeType* myShapeValidator;
+  /// A flag to store use_choice parameter state
+  bool myIsUseChoice;
 
-  //bool myIsUseChoice;
+  /// A flag to clear selection by click in empty place in the viewer
+  bool myIsNeutralPointClear;
 };
 
 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */