Salome HOME
Remove French translations
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetSelector.h
old mode 100755 (executable)
new mode 100644 (file)
index 11f3e47..b8e8816
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
-\r
-// File:        ModuleBase_WidgetSelector.h\r
-// Created:     19 June 2015\r
-// Author:      Natalia ERMOLAEVA\r
-\r
-#ifndef ModuleBase_WidgetSelector_H\r
-#define ModuleBase_WidgetSelector_H\r
-\r
-#include "ModuleBase.h"\r
-#include "ModuleBase_WidgetValidated.h"\r
-#include "ModuleBase_Definitions.h"\r
-\r
-#include <ModelAPI_Object.h>\r
-#include <ModelAPI_Attribute.h>\r
-#include <GeomAPI_Shape.h>\r
-\r
-class Config_WidgetAPI;\r
-class QWidget;\r
-class ModuleBase_IWorkshop;\r
-class ModuleBase_ViewerPrs;\r
-class ModelAPI_Result;\r
-\r
-/**\r
-* \ingroup GUI\r
-* Implementation of widget for selection.\r
-* This abstract interface is designed to be used for shape/multi shape selector widgets.\r
-*/\r
-class MODULEBASE_EXPORT ModuleBase_WidgetSelector : public ModuleBase_WidgetValidated\r
-{\r
-Q_OBJECT\r
- public:\r
-\r
-  /// Constructor\r
-  /// \param theParent the parent object\r
-  /// \param theWorkshop instance of workshop interface\r
-  /// \param theData the widget configuation. The attribute of the model widget is obtained from\r
-  ModuleBase_WidgetSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,\r
-                            const Config_WidgetAPI* theData);\r
-\r
-  virtual ~ModuleBase_WidgetSelector();\r
-\r
-  /// Defines if it is supposed that the widget should interact with the viewer.\r
-  virtual bool isViewerSelector() { return true; }\r
-\r
-  /// Activate or deactivate selection and selection filters\r
-  /// \return true if the selection filter of the widget is activated in viewer context\r
-  virtual bool activateSelectionAndFilters(bool toActivate);\r
-\r
-  /// Checks the widget validity. By default, it returns true.\r
-  /// \param thePrs a selected presentation in the view\r
-  /// \return a boolean value\r
-  virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);\r
-\r
-  /// Fills the attribute with the value of the selected owner\r
-  /// \param thePrs a selected owner\r
-  virtual bool setSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);\r
-\r
-  /// The methiod called when widget is deactivated\r
-  virtual void deactivate();\r
-\r
-  /// Return the attribute values wrapped in a list of viewer presentations\r
-  /// \return a list of viewer presentations, which contains an attribute result and\r
-  /// a shape. If the attribute do not uses the shape, it is empty\r
-  virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getAttributeSelection() const;\r
-\r
-protected slots:\r
-  /// Slot which is called on selection event\r
-  virtual void onSelectionChanged();\r
-\r
-protected:\r
-  /// Emits model changed info, updates the current control by selection change\r
-  /// \param theDone a state whether the selection is set\r
-  virtual void updateOnSelectionChanged(const bool theDone);\r
-\r
-  /// Update focus after the attribute value change\r
-  // NDS: has body is temporary\r
-   virtual void updateFocus() {};\r
-\r
-  /// Retunrs a list of possible shape types\r
-  /// \return a list of shapes\r
-  QIntList getShapeTypes() const;\r
-\r
-  /// Retunrs a list of possible shape types\r
-  /// \return a list of shapes\r
-  virtual QIntList shapeTypes() const = 0;\r
-\r
-  /// Computes and updates name of selected object in the widget\r
-  // NDS: has body is temporary\r
-  virtual void updateSelectionName() {};\r
-\r
-  /// The methiod called when widget is activated\r
-  virtual void activateCustom();\r
-\r
-  /// Returns true if selected shape corresponds to requested shape types.\r
-  /// If the widget type of shapes contains the faces item, the result is converted\r
-  /// to construction result and the method returns true if there is at least one face\r
-  /// in the construction.\r
-  /// \param theShape a shape\r
-  /// \param theResult a selected result\r
-  bool acceptSubShape(const GeomShapePtr& theShape,\r
-                      const std::shared_ptr<ModelAPI_Result>& theResult) const;\r
-\r
-  /// Return an object and geom shape by the viewer presentation\r
-  /// \param thePrs a selection\r
-  /// \param theObject an output object\r
-  /// \param theShape a shape of the selection\r
-  virtual void getGeomSelection(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,\r
-                                ObjectPtr& theObject,\r
-                                GeomShapePtr& theShape);\r
-\r
-  //----------- Class members -------------\r
-  /// Returns a name in the next form: attribute_feature_name/attribute_id\r
-  /// \param theAttribute a model attribute\r
-  /// \param theWorkshop a workshop class instance\r
-  /// \return string value\r
-  static std::string generateName(const AttributePtr& theAttribute,\r
-                                  ModuleBase_IWorkshop* theWorkshop);\r
-};\r
-\r
-#endif\r
+// 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_Definitions.h"
+
+#include <ModelAPI_Object.h>
+#include <ModelAPI_Attribute.h>
+#include <GeomAPI_Shape.h>
+
+class Config_WidgetAPI;
+class QWidget;
+class ModuleBase_IWorkshop;
+class ModuleBase_ViewerPrs;
+class ModelAPI_Result;
+
+/**
+* \ingroup GUI
+* Implementation of widget for selection.
+* This abstract interface is designed to be used for shape/multi shape selector widgets.
+*/
+class MODULEBASE_EXPORT ModuleBase_WidgetSelector : public ModuleBase_WidgetValidated
+{
+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
+  ModuleBase_WidgetSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
+                            const Config_WidgetAPI* theData);
+
+  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
+  virtual void updateSelectionModesAndFilters(bool toActivate);
+
+  /// Checks the widget validity. By default, it returns true.
+  /// \param thePrs a selected presentation in the view
+  /// \return a boolean value
+  virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
+
+  /// Fills the attribute with the value of the selected owner
+  /// \param thePrs a selected owner
+  virtual bool setSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
+
+  /// The methiod called when widget is deactivated
+  virtual void deactivate();
+
+  /// 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;
+
+  virtual bool isWholeResultAllowed() 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);
+
+  /// Update focus after the attribute value change
+  // NDS: has body is temporary
+   virtual void updateFocus() {};
+
+  /// 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 shapeTypes() const = 0;
+
+  /// Computes and updates name of selected object in the widget
+  // NDS: has body is temporary
+  virtual void updateSelectionName() {};
+
+  /// The methiod called when widget is activated
+  virtual void activateCustom();
+
+  /// Returns true if selected shape corresponds to requested shape types.
+  /// If the widget type of shapes contains the faces item, the result is converted
+  /// to construction result and the method returns true if there is at least one face
+  /// in the construction.
+  /// \param theShape a shape
+  /// \param theResult a selected result
+  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
+  /// \param theObject an output object
+  /// \param theShape a shape of the selection
+  virtual void getGeomSelection(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,
+                                ObjectPtr& theObject,
+                                GeomShapePtr& theShape);
+
+protected:
+  bool myIsPointsFiltering;
+};
+
+#endif