-// File: ModuleBase_WidgetShapeSelector.h
-// Created: 2 June 2014
-// Author: Vitaly Smetannikov
+// Copyright (C) 2014-2020 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_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>
#include <QStringList>
-#include <QPalette>
class Config_WidgetAPI;
class QWidget;
class QLineEdit;
class QToolButton;
class ModuleBase_IWorkshop;
-
-class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_ModelWidget
+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:
+* \code
+* <shape_selector id="main_object"
+* label="Main object"
+* icon=":icons/cut_shape.png"
+* tooltip="Select an object solid"
+* shape_types="solid shell"
+* concealment="true"
+* />
+* \endcode
+* It can use following parameters:
+* - id - name of object attribute
+* - label - content of widget's label
+* - icon - icon which can be used instead label
+* - tooltip - the witget's tooltip text
+* - shape_types - list of shape types for selection.
+* Possible values: face, vertex, wire, edge, shell, solid
+* - object_types - types of selectable objects.
+* For today it supports only one type "construction"
+* which corresponds to ModelAPI_ResultConstruction object type
+* - concealment - hide or not hide selected object after operation
+*/
+class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_WidgetSelector
{
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_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
- /// \param theObject a model feature to be changed
- virtual bool storeValue() const;
-
- virtual bool restoreValue();
-
- virtual bool focusTo();
-
- /// 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;
- ObjectPtr selectedFeature() const
- {
- return mySelectedObject;
- }
+ /// Returns True if data of its feature was modified during operation
+ virtual bool isModified() const;
- public slots:
+ protected:
+ /// Saves the internal parameters to the given feature
+ /// \return True in success
+ virtual bool storeValueCustom();
+
+ virtual bool restoreValueCustom();
- /// Activate or deactivate selection
- void activateSelection(bool toActivate);
+ /// Computes and updates name of selected object in the widget
+ virtual void updateSelectionName();
-private slots:
- void onSelectionChanged();
+ // Update focus after the attribute value change
+ virtual void updateFocus();
-protected:
- bool eventFilter(QObject* theObj, QEvent* theEvent);
+ /// Retunrs a list of possible shape types
+ /// \return a list of shapes
+ virtual QIntList shapeTypes() const;
-private:
- void updateSelectionName();
- void raisePanel() const;
- bool isAccepted(const ObjectPtr theObject) const;
+ /// Get the shape from the attribute if the attribute contains a shape, e.g. selection attribute
+ /// \return a shape
+ virtual GeomShapePtr getShape() const;
- static TopAbs_ShapeEnum shapeType(const QString& theType);
+ /// 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;
- QWidget* myContainer;
+ //----------- Class members -------------
+ protected:
+ /// Label of the widget
QLabel* myLabel;
- QLineEdit* myTextLine;
- //QToolButton* myActivateBtn;
- ModuleBase_IWorkshop* myWorkshop;
+ /// Input control of the widget
+ QLineEdit* myTextLine;
- ObjectPtr mySelectedObject;
+ /// List of accepting shapes types
QStringList myShapeTypes;
-
- QPalette myBasePalet;
- QPalette myInactivePalet;
-
- bool myIsActive;
};
#endif
