Salome HOME
updated copyright message
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetShapeSelector.h
index bcf13cbf1d0393192223d4c8131964f3694e94ad..162aa72dd35b694a11ef0033dd18e3f346a5630c 100644 (file)
@@ -1,16 +1,28 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        ModuleBase_WidgetShapeSelector.h
-// Created:     2 June 2014
-// Author:      Vitaly Smetannikov
+// 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_WidgetShapeSelector_H
 #define ModuleBase_WidgetShapeSelector_H
 
 #include "ModuleBase.h"
-#include "ModuleBase_WidgetValidated.h"
+#include "ModuleBase_WidgetSelector.h"
 #include "ModuleBase_ViewerFilters.h"
-#include <ModuleBase_ViewerPrs.h>
 
 #include <ModelAPI_Object.h>
 #include <ModelAPI_Attribute.h>
@@ -26,6 +38,8 @@ class QLabel;
 class QLineEdit;
 class QToolButton;
 class ModuleBase_IWorkshop;
+class ModuleBase_ViewerPrs;
+class ModelAPI_Validator;
 
 /**
 * \ingroup GUI
@@ -53,88 +67,61 @@ class ModuleBase_IWorkshop;
 *        which corresponds to ModelAPI_ResultConstruction object type
 * - concealment - hide or not hide selected object after operation
 */
-class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_WidgetValidated
+class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_WidgetSelector
 {
 Q_OBJECT
  public:
 
-   /// Converts string value (name of shape type) to shape enum value
-   /// \param theType - string with shape type name
-   /// \return TopAbs_ShapeEnum value
-  static TopAbs_ShapeEnum shapeType(const QString& theType);
-
   /// 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_WidgetShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
-                            const Config_WidgetAPI* theData, const std::string& theParentId);
+                                 const Config_WidgetAPI* theData);
 
   virtual ~ModuleBase_WidgetShapeSelector();
 
-  virtual bool restoreValue();
-
-  /// Defines if it is supposed that the widget should interact with the viewer.
-  virtual bool isViewerSelector() { return true; }
+  /// Set the given wrapped value to the current widget
+  /// This value should be processed in the widget according to the needs
+  /// The method is called by the current operation to process the operation preselection.
+  /// It is redefined to check the value validity and if it is, fill the attribute with by value
+  /// \param theValues the wrapped selection values
+  /// \param theToValidate a flag on validation of the values
+  virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
+                            const bool theToValidate);
 
   /// Returns list of widget controls
   /// \return a control list
   virtual QList<QWidget*> getControls() const;
 
-  /// Fills the attribute with the value of the selected owner
-  /// \param theOwner a selected owner
-  virtual bool setSelection(const Handle_SelectMgr_EntityOwner& theOwner);
-
-  /// The methiod called when widget is deactivated
-  virtual void deactivate();
-
- public slots:
-
-  /// Activate or deactivate selection
-  void activateSelection(bool toActivate);
-
- private slots:
-   /// Slot which is called on selection event
-  void onSelectionChanged();
+  /// Returns True if data of its feature was modified during operation
+  virtual bool isModified() const;
 
  protected:
   /// Saves the internal parameters to the given feature
   /// \return True in success
-  virtual bool storeValueCustom() const;
-
-  /// The methiod called when widget is activated
-  virtual void activateCustom();
+  virtual bool storeValueCustom();
 
-  /// Creates a backup of the current values of the attribute
-  /// It should be realized in the specific widget because of different
-  /// parameters of the current attribute
-  /// \param isBackup a boolean flag, if true, store values from the attribute
-  /// to backup, otherwise set the backed up values to the attribute
-  virtual void backupAttributeValue(const bool isBackup);
+  virtual bool restoreValueCustom();
 
   /// Computes and updates name of selected object in the widget
-  void updateSelectionName();
+  virtual void updateSelectionName();
 
-  /// Raise panel which contains this widget
-  void raisePanel() const;
+  // Update focus after the attribute value change
+  virtual void updateFocus();
 
-  /// Returns true if selected shape corresponds to requested shape types
-  /// \param theShape a shape
-  virtual bool acceptSubShape(std::shared_ptr<GeomAPI_Shape> theShape) const;
+  /// Retunrs a list of possible shape types
+  /// \return a list of shapes
+  virtual QIntList shapeTypes() const;
 
-  // Get the shape from the attribute it the attribute contain a shape, e.g. selection attribute
+  /// Get the shape from the attribute if the attribute contains a shape, e.g. selection attribute
   /// \return a shape
-  GeomShapePtr getShape() const;
-
-  /// Clear attribute
-  void clearAttribute();
+  virtual GeomShapePtr getShape() const;
 
-  /// 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
-  virtual bool storeAttributeValues(ObjectPtr theSelectedObject, GeomShapePtr theShape) const;
+  /// 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;
 
   //----------- Class members -------------
   protected:
@@ -144,26 +131,8 @@ Q_OBJECT
   /// Input control of the widget
   QLineEdit* myTextLine;
 
-  /// Reference to workshop
-  ModuleBase_IWorkshop* myWorkshop;
-
   /// List of accepting shapes types
   QStringList myShapeTypes;
-
-  /// Active/inactive flag
-  bool myIsActive;
-
-  /// backup parameters of the model attribute. The class processes three types of attribute:
-  /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
-  /// values are reserved in the backup
-  /// An attribute object
-  ObjectPtr myObject;
-  /// An attribute shape
-  GeomShapePtr myShape;
-  /// A reference of the attribute
-  AttributePtr myRefAttribute;
-  /// A boolean value whether refAttr uses reference of object
-  bool myIsObject;
 };
 
 #endif