Salome HOME
Update copyrights
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetSelector.h
old mode 100755 (executable)
new mode 100644 (file)
index 152b76f..904647f
@@ -1,15 +1,27 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        ModuleBase_WidgetSelector.h
-// Created:     19 June 2015
-// Author:      Natalia ERMOLAEVA
+// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef ModuleBase_WidgetSelector_H
 #define ModuleBase_WidgetSelector_H
 
 #include "ModuleBase.h"
 #include "ModuleBase_WidgetValidated.h"
-#include <ModuleBase_ViewerPrs.h>
 #include "ModuleBase_Definitions.h"
 
 #include <ModelAPI_Object.h>
@@ -19,6 +31,8 @@
 class Config_WidgetAPI;
 class QWidget;
 class ModuleBase_IWorkshop;
+class ModuleBase_ViewerPrs;
+class ModelAPI_Result;
 
 /**
 * \ingroup GUI
@@ -39,12 +53,16 @@ Q_OBJECT
 
   virtual ~ModuleBase_WidgetSelector();
 
+  /// Fills given container with selection modes if the widget has it
+  /// \param [out] theModuleSelectionModes module additional modes, -1 means all default modes
+  /// \param [out] theModes a container of modes
+  virtual void selectionModes(int& theModuleSelectionModes, QIntList& theModes);
+
   /// Defines if it is supposed that the widget should interact with the viewer.
   virtual bool isViewerSelector() { return true; }
 
   /// Activate or deactivate selection and selection filters
-  /// \return true if the selection filter of the widget is activated in viewer context
-  virtual bool activateSelectionAndFilters(bool toActivate);
+  virtual void updateSelectionModesAndFilters(bool toActivate);
 
   /// Checks the widget validity. By default, it returns true.
   /// \param thePrs a selected presentation in the view
@@ -58,11 +76,15 @@ Q_OBJECT
   /// The methiod called when widget is deactivated
   virtual void deactivate();
 
-protected slots:
-  /// Slot which is called on selection event
-  virtual void onSelectionChanged();
+  /// Return the attribute values wrapped in a list of viewer presentations
+  /// \return a list of viewer presentations, which contains an attribute result and
+  /// a shape. If the attribute do not uses the shape, it is empty
+  virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getAttributeSelection() const;
 
 protected:
+  /// Returns true if envent is processed. The default implementation is empty, returns false.
+  virtual bool processSelection();
+
   /// Emits model changed info, updates the current control by selection change
   /// \param theDone a state whether the selection is set
   virtual void updateOnSelectionChanged(const bool theDone);
@@ -71,15 +93,13 @@ protected:
   // NDS: has body is temporary
    virtual void updateFocus() {};
 
-  /// Return the attribute values wrapped in a list of viewer presentations
-  /// \return a list of viewer presentations, which contains an attribute result and
-  /// a shape. If the attribute do not uses the shape, it is empty
-  // NDS: has body is temporary
-  virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getAttributeSelection() const;
+  /// Retunrs a list of possible shape types
+  /// \return a list of shapes
+  QIntList getShapeTypes() const;
 
   /// Retunrs a list of possible shape types
   /// \return a list of shapes
-  virtual QIntList getShapeTypes() const = 0;
+  virtual QIntList shapeTypes() const = 0;
 
   /// Computes and updates name of selected object in the widget
   // NDS: has body is temporary
@@ -94,7 +114,8 @@ protected:
   /// in the construction.
   /// \param theShape a shape
   /// \param theResult a selected result
-  bool acceptSubShape(const GeomShapePtr& theShape, const ResultPtr& theResult) const;
+  bool acceptSubShape(const GeomShapePtr& theShape,
+                      const std::shared_ptr<ModelAPI_Result>& theResult) const;
 
   /// Return an object and geom shape by the viewer presentation
   /// \param thePrs a selection
@@ -104,12 +125,8 @@ protected:
                                 ObjectPtr& theObject,
                                 GeomShapePtr& theShape);
 
-  //----------- Class members -------------
-  /// Returns a name in the next form: attribute_feature_name/attribute_id
-  /// \param theAttribute a model attribute
-  /// \return string value
-  static std::string generateName(const AttributePtr& theAttribite,
-                                  ModuleBase_IWorkshop* theWorkshop);
+protected:
+  bool myIsPointsFiltering;
 };
 
 #endif