X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_WidgetMultiSelector.h;h=660fe06983aaa8cbb572d5b53c065e63003ee896;hb=247fc0bd6c6e04ce1f7a6e67f8d3c80ce17acab0;hp=c38f72d072e1075be0c5c635abf627d9696d0570;hpb=3874b57fe5aba25ff5aee2a07654fc23c1ee8eb0;p=modules%2Fshaper.git

diff --git a/src/ModuleBase/ModuleBase_WidgetMultiSelector.h b/src/ModuleBase/ModuleBase_WidgetMultiSelector.h
index c38f72d07..660fe0698 100644
--- a/src/ModuleBase/ModuleBase_WidgetMultiSelector.h
+++ b/src/ModuleBase/ModuleBase_WidgetMultiSelector.h
@@ -12,9 +12,11 @@
 
 #include <ModuleBase.h>
 #include <ModuleBase_ModelWidget.h>
+#include <ModuleBase_FilterNoDegeneratedEdge.h>
 
 #include <GeomAPI_Shape.h>
 #include <ModelAPI_Result.h>
+#include <ModelAPI_AttributeSelectionList.h>
 
 #include <NCollection_List.hxx>
 #include <TopoDS_Shape.hxx>
@@ -28,60 +30,107 @@ class QWidget;
 class QListWidget;
 class QComboBox;
 class ModuleBase_IWorkshop;
-
+class QAction;
+
+
+/**
+* \ingroup GUI
+* Implementation of widget for shapes selection. This widget provides selection of several shapes.
+* It can be defined in XML file as following:
+* \code
+* <multi_selector id="group_list" 
+*    tooltip="Select a set of objects" 
+*    type_choice="Vertices Edges Faces Solids" /> 
+* \endcode
+* It uses folloing 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_ModelWidget
 {
   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
   ModuleBase_WidgetMultiSelector(QWidget* theParent,
                                  ModuleBase_IWorkshop* theWorkshop,
                                  const Config_WidgetAPI* theData,
                                  const std::string& theParentId);
   virtual ~ModuleBase_WidgetMultiSelector();
 
-  /// Saves the internal parameters to the given feature
-  /// \param theObject a model feature to be changed
-  virtual bool storeValue() const;
-
   virtual bool restoreValue();
 
-  /// Returns the internal parent wiget control, that can be shown anywhere
-  /// \returns the widget
-  QWidget* getControl() const;
-
   /// Returns list of widget controls
   /// \return a control list
   virtual QList<QWidget*> getControls() const;
 
-  virtual bool eventFilter(QObject* theObj, QEvent* theEvent);
+  virtual bool eventFilter(QObject* , QEvent* );
 
  public slots:
+  /// Activate or deactivate selection
   void activateSelection(bool toActivate);
+
+  /// Slot is called on selection type changed
   void onSelectionTypeChanged();
+
+  /// Slot is called on selection changed
   void onSelectionChanged();
 
+protected slots:
+  /// Slot for copy command in a list pop-up menu
+  void onCopyItem();
+
+  /// Slot is called on selection of list of selected items
+  void onListSelection();
+
  protected:
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom() const;
+
+  /// Provide filtering of selected shapes
+   /// \param theShapesToFilter source list of shapes
+   /// \param theResult result list of shapes
   void filterShapes(const NCollection_List<TopoDS_Shape>& theShapesToFilter,
                     NCollection_List<TopoDS_Shape>& theResult);
+
+  /// Set current shape type for selection
   void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
+
+  /// Start shape selection
   void activateShapeSelection();
 
  private:
-   void updateSelectionList();
+   /// Update selection list
+   void updateSelectionList(AttributeSelectionListPtr);
 
+   /// List control
   QListWidget* myListControl;
+
+  /// Combobox of types
   QComboBox* myTypeCombo;
-  QWidget* myMainWidget;
 
   //TODO: Move into the base of selectors
   ModuleBase_IWorkshop* myWorkshop;
 
   /// If true then local selector has to be activated in context
-  bool myUseSubShapes;
   bool myIsActive;
 
+  /// Provides correspondance between Result object and its shape
   typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
+
+  /// Variable of GeomSelection type
   QList<GeomSelection> mySelection;
+
+  /// An action for pop-up menu in a list control
+  QAction* myCopyAction;
+
+  /// A filter for the Edges type, which avoid the generated edges selection
+  Handle(ModuleBase_FilterNoDegeneratedEdge) myEdgesTypeFilter;
 };
 
 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */