Code documentation update

[modules/shaper.git] / src / XGUI / XGUI_Selection.h

diff --git a/src/XGUI/XGUI_Selection.h b/src/XGUI/XGUI_Selection.h
index dd3b48586ca5b0b0d9291a7e26bb1c50bbf91e0e..5c3eb4a41309299f28ba1b538dc54e750b50385f 100644 (file)
--- a/src/XGUI/XGUI_Selection.h
+++ b/src/XGUI/XGUI_Selection.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        XGUI_Selection.h
 // Created:     8 July 2014
 // Author:      Vitaly SMETANNIKOV
@@ -16,35 +18,40 @@
 #include <NCollection_List.hxx>
 #include <TopoDS_Shape.hxx>
 
-#include <list>
+#include <SelectMgr_IndexedMapOfOwner.hxx>
 
 class XGUI_Workshop;
 
-class XGUI_EXPORT XGUI_Selection: public ModuleBase_ISelection
+/**
+* Implementation of \ref ModuleBase_ISelection interface.
+*/
+class XGUI_EXPORT XGUI_Selection : public ModuleBase_ISelection
 {
-public:
+ public:
+   /// Constructor
+   /// \param theWorkshop reference to workshop instance
   XGUI_Selection(XGUI_Workshop* theWorkshop);
 
   /// 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 std::list<ModuleBase_ViewerPrs> getSelected(int theShapeTypeToSkip = -1) const;
+  virtual QList<ModuleBase_ViewerPrs> getSelected(int theShapeTypeToSkip = -1) const;
 
   /// 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 std::list<ModuleBase_ViewerPrs> getHighlighted(int theShapeTypeToSkip = -1) const;
+  virtual QList<ModuleBase_ViewerPrs> getHighlighted(int theShapeTypeToSkip = -1) const;
 
   /**
-  * Returns list of currently selected objects
-  */
-  virtual QList<ObjectPtr> selectedObjects() const;
+   * Returns list of currently selected objects in object browser
+   */
+  virtual QObjectPtrList selectedObjects() const;
 
   /**
-  * Returns list of currently selected results
-  */
-  virtual QList<ObjectPtr> selectedPresentations() const;
-  
+   * Returns list of currently selected results
+   */
+  virtual QObjectPtrList selectedPresentations() const;
+
   //! Returns list of currently selected QModelIndexes
   virtual QModelIndexList selectedIndexes() const;
 
@@ -52,10 +59,22 @@ public:
   virtual void selectedAISObjects(AIS_ListOfInteractive& theList) const;
 
   //! Returns list of currently selected shapes
-  virtual void selectedShapes(NCollection_List<TopoDS_Shape>& theList) const;
+  virtual void selectedShapes(NCollection_List<TopoDS_Shape>& theShapes, 
+    std::list<ObjectPtr>& theOwners) const;
+
+  //! Returns list of currently selected owners
+  /// \return list of owners
+  void selectedOwners(SelectMgr_IndexedMapOfOwner& theSelectedOwners) const;
+
+  //! Returns a list of selection entity owners of the interactive object
+  /// It depends on the modes, in which the object is activated in the context
+  /// \param theObject an object
+  /// \param theOwners a map of entity owners
+  void entityOwners(const Handle_AIS_InteractiveObject& theObject,
+                    SelectMgr_IndexedMapOfOwner& theOwners) const;
 
-private:
+ private:
   XGUI_Workshop* myWorkshop;
 };
 
-#endif
\ No newline at end of file
+#endif