X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_WidgetShapeSelector.h;h=bf0fb6800d39f5d4b5029b6b29d53ee6aba28c6e;hb=4ac6f2284fe917736f0b30978799a20c3ea775d1;hp=ad3d3b857931ff08b2f62fdc6c82137295c7473f;hpb=3c5cc0cd68b845cee1d58e61974ae0013b50199c;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_WidgetShapeSelector.h b/src/ModuleBase/ModuleBase_WidgetShapeSelector.h index ad3d3b857..bf0fb6800 100644 --- a/src/ModuleBase/ModuleBase_WidgetShapeSelector.h +++ b/src/ModuleBase/ModuleBase_WidgetShapeSelector.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModuleBase_WidgetShapeSelector.h // Created: 2 June 2014 // Author: Vitaly Smetannikov @@ -6,10 +8,12 @@ #define ModuleBase_WidgetShapeSelector_H #include "ModuleBase.h" -#include "ModuleBase_ModelWidget.h" +#include "ModuleBase_WidgetValidated.h" #include "ModuleBase_ViewerFilters.h" +#include #include +#include #include #include @@ -23,45 +27,62 @@ class QLineEdit; class QToolButton; class ModuleBase_IWorkshop; -class MODULEBASE_EXPORT ModuleBase_WidgetShapeSelector : public ModuleBase_ModelWidget +/** +* \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_WidgetValidated { 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); 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; - } + /// Defines if it is supposed that the widget should interact with the viewer. + virtual bool isViewerSelector() { return true; } /// Returns list of widget controls /// \return a control list virtual QList getControls() const; - ObjectPtr selectedFeature() const - { - return mySelectedObject; - } + /// Fills the attribute with the value of the selected owner + /// \param theOwner a selected owner + virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs); - /// 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 setValue(ModuleBase_WidgetValue* theValue); + /// The methiod called when widget is deactivated + virtual void deactivate(); public slots: @@ -69,50 +90,80 @@ Q_OBJECT void activateSelection(bool toActivate); private slots: + /// Slot which is called on selection event void onSelectionChanged(); protected: - bool eventFilter(QObject* theObj, QEvent* theEvent); + /// 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(); + + /// 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(); + /// 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); + + /// Computes and updates name of selected object in the widget void updateSelectionName(); - void raisePanel() const; - /// 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; + /// Raise panel which contains this widget + void raisePanel() const; /// Returns true if selected shape corresponds to requested shape types - /// This method is called only in sub-shapes selection mode - virtual bool acceptSubShape(boost::shared_ptr theShape) const; + /// \param theShape a shape + virtual bool acceptSubShape(std::shared_ptr theShape) const; - /// 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; + // Get the shape from the attribute it the attribute contain a shape, e.g. selection attribute + /// \return a shape + GeomShapePtr getShape() const; + /// Clear attribute + void clearAttribute(); - // Set the given object as a value of the widget - void setObject(ObjectPtr theObj, boost::shared_ptr theShape = boost::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 bool setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape); //----------- Class members ------------- - private: - QWidget* myContainer; + protected: + /// Label of the widget QLabel* myLabel; + + /// Input control of the widget QLineEdit* myTextLine; + /// Reference to workshop ModuleBase_IWorkshop* myWorkshop; - ObjectPtr mySelectedObject; - boost::shared_ptr myShape; - + /// List of accepting shapes types QStringList myShapeTypes; - QStringList myObjectTypes; - - /// If true then local selector has to be activated in context - bool myUseSubShapes; + /// Active/inactive flag 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