Salome HOME
Remove linking to GeomValidators.
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetMultiSelector.h
old mode 100644 (file)
new mode 100755 (executable)
index cc702f6..d8df98a
 #define MODULEBASE_WIDGETMULTISELECTOR_H_
 
 #include <ModuleBase.h>
-#include <ModuleBase_WidgetValidated.h>
+#include <ModuleBase_WidgetSelector.h>
 
 #include <GeomAPI_Shape.h>
 #include <ModelAPI_Result.h>
-#include <ModelAPI_AttributeSelectionList.h>
 
 #include <NCollection_List.hxx>
 #include <TopoDS_Shape.hxx>
@@ -24,6 +23,7 @@
 #include <QString>
 #include <QStringList>
 #include <QPair>
+#include <QMap>
 
 class QWidget;
 class QListWidget;
@@ -41,19 +41,19 @@ class QAction;
 *    tooltip="Select a set of objects" 
 *    type_choice="Vertices Edges Faces Solids" /> 
 * \endcode
-* It uses folloing parameters:
+* 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_WidgetValidated
+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 configuation. The attribute of the model widget is obtained from
+  /// \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,
@@ -61,28 +61,26 @@ class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_Widge
                                  const std::string& theParentId);
   virtual ~ModuleBase_WidgetMultiSelector();
 
-  virtual bool restoreValue();
-
   /// Returns list of widget controls
   /// \return a control list
   virtual QList<QWidget*> getControls() const;
 
-  virtual bool eventFilter(QObject* , QEvent* );
-
-  /// The methiod called when widget is deactivated
-  virtual void deactivate();
+  /// 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
+  /// \param theToValidate a validation of the values flag
+  virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
+                            const bool theToValidate);
 
-  /// Fills the attribute with the value of the selected owner
-  /// \param theOwner a selected owner
-  virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
+  /// Checks the widget validity. By default, it returns true.
+  /// \param thePrs a selected presentation in the view
+  /// \return a boolean value
+  virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
 
  public slots:
   /// Slot is called on selection type changed
   void onSelectionTypeChanged();
 
-  /// Slot is called on selection changed
-  virtual void onSelectionChanged();
-
 protected slots:
   /// Slot for copy command in a list pop-up menu
   void onCopyItem();
@@ -90,19 +88,38 @@ protected slots:
   /// Slot is called on selection of list of selected items
   void onListSelection();
 
- protected:
-  /// The methiod called when widget is activated
-  virtual void activateCustom();
-
+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
@@ -112,25 +129,25 @@ protected slots:
   /// Set current shape type for selection
   void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
 
-  /// Start shape selection
-  void activateShapeSelection();
+  /// 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<ModuleBase_ViewerPrs> getAttributeSelection() const;
+
+  /// Fills the list control by the attribute values
+  void updateSelectionList();
 
- protected:
-   /// 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;
 
-   /// List control
+protected:
+  /// List control
   QListWidget* myListControl;
 
   /// Combobox of types
   QComboBox* myTypeCombo;
 
-  //TODO: Move into the base of selectors
-  ModuleBase_IWorkshop* myWorkshop;
-
-  /// If true then local selector has to be activated in context
-  bool myIsActive;
-
   /// Provides correspondance between Result object and its shape
   typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
 
@@ -144,7 +161,10 @@ protected slots:
   std::string mySelectionType;
 
   /// Variable of GeomSelection
-  QList<GeomSelection> mySelection;
+  int mySelectionCount; // number of elements in the attribute selection list when store
+
+  /// A flag to store use_choice parameter state
+  bool myIsUseChoice;
 };
 
 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */