-// 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_ModelWidget.h"
+#include "ModuleBase_WidgetSelector.h"
#include "ModuleBase_ViewerFilters.h"
#include <ModelAPI_Object.h>
+#include <ModelAPI_Attribute.h>
#include <GeomAPI_Shape.h>
#include <TopAbs_ShapeEnum.hxx>
class QLineEdit;
class QToolButton;
class ModuleBase_IWorkshop;
+class ModuleBase_ViewerPrs;
+class ModelAPI_Validator;
/**
+* \ingroup GUI
* Implementation of widget for shapes selection.
* This type of widget can be defined in XML file with 'shape_selector' keyword.
* For example:
* which corresponds to ModelAPI_ResultConstruction object type
* - concealment - hide or not hide selected object after operation
*/
-class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_ModelWidget
+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();
- /// Saves the internal parameters to the given feature
- virtual bool storeValue() const;
-
- virtual bool restoreValue();
-
- /// Defines if it is supposed that the widget should interact with the viewer.
- virtual bool isViewerSelector() { return true; }
-
- /// Returns the internal parent wiget control, that can be shown anywhere
- /// \returns the widget
- QWidget* getControl() const
- {
- return myContainer;
- }
+ /// 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;
- /// Returns currently selected data object
- ObjectPtr selectedFeature() const
- {
- return mySelectedObject;
- }
-
- /// Set the given wrapped value to the current widget
- /// This value should be processed in the widget according to the needs
- /// \param theValue the wrapped widget value
- virtual bool setSelection(ModuleBase_ViewerPrs theValue);
-
-
- /// The methiod called when widget is activated
- virtual void activate();
-
- /// 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:
- /// Computes and updates name of selected object in the widget
- void updateSelectionName();
-
- /// Raise panel which contains this widget
- void raisePanel() const;
+ /// Saves the internal parameters to the given feature
+ /// \return True in success
+ virtual bool storeValueCustom();
- /// Returns true if selected shape corresponds to requested shape types
- /// \param theShape a shape
- virtual bool acceptSubShape(std::shared_ptr<GeomAPI_Shape> theShape) const;
+ virtual bool restoreValueCustom();
- /// Returns true if selected object corresponds to requested Object type
- /// Thid method is used in any selection mode
- /// \param theObject an object
- virtual bool acceptObjectType(const ObjectPtr theObject) const;
+ /// Computes and updates name of selected object in the widget
+ virtual void updateSelectionName();
+ // Update focus after the attribute value change
+ virtual void updateFocus();
- // Set the given object as a value of the widget
- /// \param theObj an object
- /// \param theShape a shape
- void setObject(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape = std::shared_ptr<GeomAPI_Shape>());
+ /// Retunrs a list of possible shape types
+ /// \return a list of shapes
+ virtual QIntList shapeTypes() const;
- /// Check the selected with validators if installed
- /// \param theObj the object for checking
- /// \param theShape the shape for checking
- virtual bool isValid(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape);
+ /// Get the shape from the attribute if the attribute contains a shape, e.g. selection attribute
+ /// \return a shape
+ virtual GeomShapePtr getShape() const;
- /// Clear attribute
- void clearAttribute();
+ /// 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:
-
- /// Container of the widget's control
- QWidget* myContainer;
-
+ protected:
/// Label of the widget
QLabel* myLabel;
/// Input control of the widget
QLineEdit* myTextLine;
- /// Reference to workshop
- ModuleBase_IWorkshop* myWorkshop;
-
- /// Pointer to selected object
- ObjectPtr mySelectedObject;
-
- /// Pointer to selected shape
- GeomShapePtr myShape;
-
/// List of accepting shapes types
QStringList myShapeTypes;
-
- /// List of accepting object types
- QStringList myObjectTypes;
-
- /// Active/inactive flag
- bool myIsActive;
-
- /// Filter by objects types
- Handle(ModuleBase_ObjectTypesFilter) myObjTypeFilter;
};
#endif
