-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File: ModuleBase_WidgetSelector.h
-// Created: 19 June 2015
-// Author: Natalia ERMOLAEVA
+// Copyright (C) 2014-2023 CEA, EDF
+//
+// 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>
class Config_WidgetAPI;
class QWidget;
class ModuleBase_IWorkshop;
+class ModuleBase_ViewerPrs;
+class ModelAPI_Result;
/**
* \ingroup GUI
/// \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_WidgetSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
- const Config_WidgetAPI* theData, const std::string& theParentId);
+ 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
- void 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
/// \return a boolean value
- virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
+ 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 ModuleBase_ViewerPrs& thePrs);
+ virtual bool setSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
/// The methiod called when widget is deactivated
virtual void deactivate();
- private slots:
- /// Slot which is called on selection event
- 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;
+
+ virtual bool isWholeResultAllowed() const;
+
+protected:
+ /// Returns true if envent is processed. The default implementation is empty, returns false.
+ virtual bool processSelection();
- protected:
- /// Set an empty value to attribute
- virtual void clearAttribute() = 0;
+ /// 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
- virtual void updateFocus() = 0;
+ // 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
- virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const = 0;
+ /// 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
- virtual void updateSelectionName() = 0;
-
- /// Store the values to the model attribute of the widget. It casts this attribute to
- /// the specific type and set the given values
- /// \param theSelectedObject an object
- /// \param theShape a selected shape, which is used in the selection attribute
- /// \return true if it is succeed
- virtual void setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape) = 0;
+ // NDS: has body is temporary
+ virtual void updateSelectionName() {};
/// The methiod called when widget is activated
virtual void activateCustom();
/// 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
/// \param theObject an output object
/// \param theShape a shape of the selection
- virtual void getGeomSelection(const ModuleBase_ViewerPrs& thePrs,
+ virtual void getGeomSelection(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,
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