X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_WidgetShapeSelector.h;h=2c8a10363e630fcade439ae6b895a0545e62459f;hb=2413ba5e387ebc030eb89aaad917991844ae518d;hp=7757d3141070cc520073ac17c7d3a7e7f4d971cd;hpb=01de9cb6d86b7cb7080ce623820996a87a316542;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_WidgetShapeSelector.h b/src/ModuleBase/ModuleBase_WidgetShapeSelector.h index 7757d3141..2c8a10363 100644 --- a/src/ModuleBase/ModuleBase_WidgetShapeSelector.h +++ b/src/ModuleBase/ModuleBase_WidgetShapeSelector.h @@ -1,4 +1,4 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D // File: ModuleBase_WidgetShapeSelector.h // Created: 2 June 2014 @@ -8,10 +8,12 @@ #define ModuleBase_WidgetShapeSelector_H #include "ModuleBase.h" -#include "ModuleBase_ModelWidget.h" +#include "ModuleBase_WidgetSelector.h" #include "ModuleBase_ViewerFilters.h" +#include #include +#include #include #include @@ -24,103 +26,122 @@ class QLabel; class QLineEdit; class QToolButton; class ModuleBase_IWorkshop; - -class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_ModelWidget +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 +* +* \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: - 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, const std::string& theParentId); virtual ~ModuleBase_WidgetShapeSelector(); - /// Saves the internal parameters to the given feature - virtual bool storeValue() const; - - virtual bool restoreValue(); - - /// Returns the internal parent wiget control, that can be shown anywhere - /// \returns the widget - QWidget* getControl() const - { - return myContainer; - } - /// Returns list of widget controls /// \return a control list virtual QList getControls() const; - 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: + protected: + /// Saves the internal parameters to the given feature + /// \return True in success + virtual bool storeValueCustom() const; - /// Activate or deactivate selection - void activateSelection(bool toActivate); + virtual bool restoreValueCustom(); - private slots: - void onSelectionChanged(); + /// 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 + virtual void storeAttributeValue(); - protected: - void updateSelectionName(); - void raisePanel() const; + /// 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 theValid a boolean flag, if restore happens for valid parameters + virtual void restoreAttributeValue(const bool theValid); - /// Returns true if shape of given object corresponds to requested shape type - /// This method is called only in non sub-shapes selection mode - //virtual bool acceptObjectShape(const ObjectPtr theObject) const; + /// Computes and updates name of selected object in the widget + virtual void updateSelectionName(); - /// Returns true if selected shape corresponds to requested shape types - /// This method is called only in sub-shapes selection mode - virtual bool acceptSubShape(std::shared_ptr theShape) const; + /// Clear attribute + virtual void clearAttribute(); - /// Returns true if selected object corresponds to requested Object type - /// Thid method is used in any selection mode - virtual bool acceptObjectType(const ObjectPtr theObject) const; + // Update focus after the attribute value change + virtual void updateFocus(); + /// Retunrs a list of possible shape types + /// \return a list of shapes + virtual QIntList getShapeTypes() const; - // Set the given object as a value of the widget - void setObject(ObjectPtr theObj, std::shared_ptr theShape = std::shared_ptr()); + /// 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); - /// Check the selected with validators if installed - virtual bool isValid(ObjectPtr theObj, std::shared_ptr 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 getAttributeSelection() const; //----------- Class members ------------- - protected: - QWidget* myContainer; + protected: + /// Label of the widget QLabel* myLabel; - QLineEdit* myTextLine; - - ModuleBase_IWorkshop* myWorkshop; - ObjectPtr mySelectedObject; - std::shared_ptr myShape; + /// Input control of the widget + QLineEdit* myTextLine; + /// List of accepting shapes types QStringList myShapeTypes; - QStringList myObjectTypes; - - bool myIsActive; - Handle(ModuleBase_ObjectTypesFilter) myObjTypeFilter; + /// 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