Salome HOME
Issue #559: Control doesn't have variable if its text is empty
[modules/shaper.git] / src / ModuleBase / ModuleBase_ISelection.h
index 037be3bd01f6a644508db9b88e2b05a74bc999f5..86cfd4f527c5ef6ed7b404ef947b30b0f737cb5e 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModuleBase_ISelection.h
 // Created:     2 June 2014
 // Author:      Vitaly Smetannikov
 
 #include <QList>
 
+class Handle_SelectMgr_EntityOwner;
+
+/**
+* \ingroup GUI
+* A class which provides access to selection.
+* A selection can be obtained as from a viewer as from Object browser in various forms
+*/
 class ModuleBase_ISelection
 {
  public:
 
   /// Returns a list of viewer selected presentations
-  /// \param theShapeTypeToSkip the shapes with this type will be skipped during the result list build
   /// \return list of presentations
-  virtual QList<ModuleBase_ViewerPrs> getSelected(int theShapeTypeToSkip = -1) const = 0;
+  virtual QList<ModuleBase_ViewerPrs> getSelected() const = 0;
 
   /// Returns a list of viewer highlited presentations
-  /// \param theShapeTypeToSkip the shapes with this type will be skipped during the result list build
   /// \return list of presentations
-  virtual QList<ModuleBase_ViewerPrs> getHighlighted(int theShapeTypeToSkip = -1) const = 0;
+  virtual QList<ModuleBase_ViewerPrs> getHighlighted() const = 0;
+
+  /// Fills the viewer presentation parameters by the parameters from the owner
+  /// \param thePrs a container for selection
+  /// \param theOwner a selection owner
+  virtual void fillPresentation(ModuleBase_ViewerPrs& thePrs,
+                                const Handle_SelectMgr_EntityOwner& theOwner) const = 0;
 
   /**
    * Returns list of features currently selected in object browser
@@ -44,12 +57,24 @@ class ModuleBase_ISelection
   virtual QModelIndexList selectedIndexes() const = 0;
 
   //! Returns list of currently selected AIS objects
+  //! \param theList returning list of selected AIS objects
   virtual void selectedAISObjects(AIS_ListOfInteractive& theList) const = 0;
 
-  //! Returns list of currently selected shapes
+  //! Returns list of currently selected QModelIndexes
+  virtual ObjectPtr getSelectableObject(const Handle_SelectMgr_EntityOwner& theOwner) const = 0;
+
+  //! Returns list of currently selected shapes and their owners (objects).
+  //! Both lists are synchronized
+  //! \param theList returning list of selected AIS objects
+  //! \param theOwners list of objects
   virtual void selectedShapes(NCollection_List<TopoDS_Shape>& theList, 
     std::list<ObjectPtr>& theOwners) const = 0;
 
+  //! Wraps the object list into the viewer prs list
+  //! \param theObjects a list of objects
+  //! \return a list of prs, where only object is not empty
+  static MODULEBASE_EXPORT QList<ModuleBase_ViewerPrs> getViewerPrs(
+                                                       const QObjectPtrList& theObjects);
 };
 
 #endif