X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_WidgetMultiSelector.h;h=03e07588280b8c813be2872da1a872a59c3d6dff;hb=8f0b2cf49bd24e118ad3fc523eb4a815d067d46c;hp=c38f72d072e1075be0c5c635abf627d9696d0570;hpb=f1cd93fd02a54259f72e3191d037323a496b2bef;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_WidgetMultiSelector.h b/src/ModuleBase/ModuleBase_WidgetMultiSelector.h index c38f72d07..03e075882 100644 --- a/src/ModuleBase/ModuleBase_WidgetMultiSelector.h +++ b/src/ModuleBase/ModuleBase_WidgetMultiSelector.h @@ -11,10 +11,11 @@ #define MODULEBASE_WIDGETMULTISELECTOR_H_ #include -#include +#include #include #include +#include #include #include @@ -23,65 +24,149 @@ #include #include #include +#include class QWidget; class QListWidget; class QComboBox; class ModuleBase_IWorkshop; - -class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_ModelWidget +class GeomValidators_ShapeType; +class QAction; + + +/** +* \ingroup GUI +* Implementation of widget for shapes selection. This widget provides selection of several shapes. +* It can be defined in XML file as following: +* \code +* +* \endcode +* It uses following parameters: +* - id - is a name of corresponded attribute +* - tooltip - a tooltip for the widget +* - type_choice - list of expected shape types. +*/ +class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetSelector { Q_OBJECT public: + /// Constructor + /// \param theParent the parent object + /// \param theWorkshop instance of workshop interface + /// \param theData the widget configuration. The attribute of the model widget is obtained from + /// \param theParentId is Id of a parent of the current attribute ModuleBase_WidgetMultiSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop, const Config_WidgetAPI* theData, const std::string& theParentId); virtual ~ModuleBase_WidgetMultiSelector(); - /// Saves the internal parameters to the given feature - /// \param theObject a model feature to be changed - virtual bool storeValue() const; - - virtual bool restoreValue(); - - /// Returns the internal parent wiget control, that can be shown anywhere - /// \returns the widget - QWidget* getControl() const; - /// Returns list of widget controls /// \return a control list virtual QList getControls() const; - virtual bool eventFilter(QObject* theObj, QEvent* theEvent); + /// Set the given wrapped value to the current widget + /// This value should be processed in the widget according to the needs + /// \param theValues the wrapped selection values + virtual bool setSelection(QList& theValues, + const bool theToValidate); + + /// Checks the widget validity. By default, it returns true. + /// \param theValue a selected presentation in the view + /// \return a boolean value + virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs); public slots: - void activateSelection(bool toActivate); + /// Slot is called on selection type changed void onSelectionTypeChanged(); - void onSelectionChanged(); - protected: - void filterShapes(const NCollection_List& theShapesToFilter, - NCollection_List& theResult); +protected slots: + /// Slot for copy command in a list pop-up menu + void onCopyItem(); + + /// Slot is called on selection of list of selected items + void onListSelection(); + +protected: + /// Saves the internal parameters to the given feature + /// \return True in success + virtual bool storeValueCustom() const; + + virtual bool restoreValueCustom(); + + /// 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(); + + /// Clear attribute + virtual void clearAttribute(); + + // Set the focus on the last item in the list + virtual void updateFocus(); + + /// Computes and updates name of selected object in the widget + virtual void updateSelectionName(); + + /// Retunrs a list of possible shape types + /// \return a list of shapes + virtual QIntList getShapeTypes() const; + + /// Append 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 + void setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape); + + /// 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); + + /// Set current shape type for selection void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType); - void activateShapeSelection(); - private: - void updateSelectionList(); + /// 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; + + /// Update selection list + void updateSelectionList(AttributeSelectionListPtr); + /// Converts the XML defined type choice to the validator type + /// For example, the "Edges" is converted to "edge" + std::string validatorType(const QString& theType) const; + +protected: + /// List control QListWidget* myListControl; + + /// Combobox of types QComboBox* myTypeCombo; - QWidget* myMainWidget; - //TODO: Move into the base of selectors - ModuleBase_IWorkshop* myWorkshop; + /// Provides correspondance between Result object and its shape + typedef QPair GeomSelection; + + /// An action for pop-up menu in a list control + QAction* myCopyAction; - /// If true then local selector has to be activated in context - bool myUseSubShapes; - 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 + /// Variable of selection type + std::string mySelectionType; - typedef QPair GeomSelection; + /// Variable of GeomSelection QList mySelection; + int mySelectionCount; // number of elements in the attribute selection list when store + bool myIsInValidate; // the widget is in validation mode: store is performed, restore is not + + bool myIsUseChoice; }; #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */