Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0

[modules/shaper.git] / src / ModuleBase / ModuleBase_ISelection.h

diff --git a/src/ModuleBase/ModuleBase_ISelection.h b/src/ModuleBase/ModuleBase_ISelection.h
index c1b06ca1b71fae47724684d7c339f41e2fdcd158..e3190488af69f6268a61a1998570abbd06a73edd 100644 (file)
--- a/src/ModuleBase/ModuleBase_ISelection.h
+++ b/src/ModuleBase/ModuleBase_ISelection.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModuleBase_ISelection.h
 // Created:     2 June 2014
 // Author:      Vitaly Smetannikov
@@ -16,6 +18,11 @@
 
 #include <QList>
 
+/**
+* \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:
@@ -31,22 +38,26 @@ class ModuleBase_ISelection
   virtual QList<ModuleBase_ViewerPrs> getHighlighted(int theShapeTypeToSkip = -1) const = 0;
 
   /**
-   * Returns list of features currently selected in 3d viewer
+   * Returns list of features currently selected in object browser
    */
-  virtual QList<ObjectPtr> selectedObjects() const = 0;
+  virtual QObjectPtrList selectedObjects() const = 0;
 
   /**
    * Returns list of currently selected results
    */
-  virtual QList<ObjectPtr> selectedPresentations() const = 0;
+  virtual QObjectPtrList selectedPresentations() const = 0;
 
   //! Returns list of currently selected QModelIndexes
   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 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;