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 b6983d25ac82419d52cc10c2b7bd239c5b8c1314..e3190488af69f6268a61a1998570abbd06a73edd 100644 (file)
--- a/src/ModuleBase/ModuleBase_ISelection.h
+++ b/src/ModuleBase/ModuleBase_ISelection.h
@@ -18,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:
@@ -46,9 +51,13 @@ 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 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;