src/ModuleBase/ModuleBase_WidgetMultiSelector.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_WidgetMultiSelector.h
   5  *
   6  *  Created on: Oct 8, 2014
   7  *      Author: sbh
   8  */
   9
  10 #ifndef MODULEBASE_WIDGETMULTISELECTOR_H_
  11 #define MODULEBASE_WIDGETMULTISELECTOR_H_
  12
  13 #include <ModuleBase.h>
  14 #include <ModuleBase_WidgetSelector.h>
  15
  16 #include <GeomAPI_Shape.h>
  17 #include <ModelAPI_Result.h>
  18
  19 #include <NCollection_List.hxx>
  20 #include <TopoDS_Shape.hxx>
  21
  22 #include <QList>
  23 #include <QString>
  24 #include <QStringList>
  25 #include <QPair>
  26 #include <QMap>
  27
  28 class QWidget;
  29 class QListWidget;
  30 class QComboBox;
  31 class ModuleBase_IWorkshop;
  32 class QAction;
  33
  34
  35 /**
  36 * \ingroup GUI
  37 * Implementation of widget for shapes selection. This widget provides selection of several shapes.
  38 * It can be defined in XML file as following:
  39 * \code
  40 * <multi_selector id="group_list"
  41 *    tooltip="Select a set of objects"
  42 *    type_choice="Vertices Edges Faces Solids" />
  43 * \endcode
  44 * It uses following parameters:
  45 * - id - is a name of corresponded attribute
  46 * - tooltip - a tooltip for the widget
  47 * - type_choice - list of expected shape types.
  48 */
  49 class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetSelector
  50 {
  51   Q_OBJECT
  52  public:
  53   /// Constructor
  54   /// \param theParent the parent object
  55   /// \param theWorkshop instance of workshop interface
  56   /// \param theData the widget configuration. The attribute of the model widget is obtained from
  57   ModuleBase_WidgetMultiSelector(QWidget* theParent,
  58                                  ModuleBase_IWorkshop* theWorkshop,
  59                                  const Config_WidgetAPI* theData);
  60   virtual ~ModuleBase_WidgetMultiSelector();
  61
  62   /// Returns list of widget controls
  63   /// \return a control list
  64   virtual QList<QWidget*> getControls() const;
  65
  66   /// The methiod called when widget is deactivated
  67   virtual void deactivate();
  68
  69   /// Set the given wrapped value to the current widget
  70   /// This value should be processed in the widget according to the needs
  71   /// \param theValues the wrapped selection values
  72   /// \param theToValidate a validation of the values flag
  73   virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
  74                             const bool theToValidate);
  75
  76   /// Returns values which should be highlighted when the whidget is active
  77   /// \param theValues a list of presentations
  78   virtual void getHighlighted(QList<ModuleBase_ViewerPrs>& theValues);
  79
  80   /// Checks the widget validity. By default, it returns true.
  81   /// \param thePrs a selected presentation in the view
  82   /// \return a boolean value
  83   virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  84
  85   /// Returns true if the event is processed. The default implementation is empty, returns false.
  86   virtual bool processDelete();
  87
  88 public slots:
  89   /// Slot is called on selection type changed
  90   void onSelectionTypeChanged();
  91
  92 protected slots:
  93   /// Slot for copy command in a list pop-up menu
  94   void onCopyItem();
  95
  96   /// Slot for delete command in a list pop-up menu
  97   void onDeleteItem();
  98
  99   /// Slot is called on selection of list of selected items
 100   void onListSelection();
 101
 102 protected:
 103   /// The methiod called when widget is activated
 104   virtual void activateCustom();
 105
 106   /// Saves the internal parameters to the given feature
 107   /// \return True in success
 108   virtual bool storeValueCustom() const;
 109
 110   virtual bool restoreValueCustom();
 111
 112   /// Creates a backup of the current values of the attribute
 113   /// It should be realized in the specific widget because of different
 114   /// parameters of the current attribute
 115   virtual void storeAttributeValue();
 116
 117   /// Set the focus on the last item in  the list
 118   virtual void updateFocus();
 119
 120   /// Computes and updates name of selected object in the widget
 121   virtual void updateSelectionName();
 122
 123   /// Retunrs a list of possible shape types
 124   /// \return a list of shapes
 125   virtual QIntList getShapeTypes() const;
 126
 127   /// Creates a backup of the current values of the attribute
 128   /// It should be realized in the specific widget because of different
 129   /// parameters of the current attribute
 130   /// \param theValid a boolean flag, if restore happens for valid parameters
 131   virtual void restoreAttributeValue(const bool theValid);
 132
 133   /// Set current shape type for selection
 134   void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
 135
 136   /// Return the attribute values wrapped in a list of viewer presentations
 137   /// \return a list of viewer presentations, which contains an attribute result and
 138   /// a shape. If the attribute do not uses the shape, it is empty
 139   virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
 140
 141   /// Fills the list control by the attribute values
 142   void updateSelectionList();
 143
 144   /// Converts the XML defined type choice to the validator type
 145   /// For example, the "Edges" is converted to "edge"
 146   std::string validatorType(const QString& theType) const;
 147
 148 protected:
 149   /// Returns attribute indices selected in the widget selection list
 150   /// \param theIndices a list of indices
 151   void getSelectedAttributeIndices(std::set<int>& theIndices);
 152
 153   /// Gets the feature attribute and fill a list of viewer presentation for the attribute
 154   /// indices. If the the container of indices is empty, it returns all objects.
 155   /// \param theAttributeIds indices in attribute list to be returned
 156   /// \param theValues the result presentations, filled with object and shape of an attribute item
 157   void convertIndicesToViewerSelection(std::set<int> theAttributeIds,
 158                                        QList<ModuleBase_ViewerPrs>& theValues) const;
 159
 160   /// Iterates throgh the model attribute list and remove elements which do not present in the list
 161   /// \param theValues the wrapped selection values
 162   virtual void removeUnusedAttributeObjects(QList<ModuleBase_ViewerPrs>& theValues);
 163
 164   /// Converts viewer presentation selection list to objects and shapes map
 165   /// \param theValues the wrapped selection values
 166   /// \return selection list
 167   std::map<ObjectPtr, std::set<GeomShapePtr> > convertSelection
 168                                           (QList<ModuleBase_ViewerPrs>& theValues);
 169
 170   /// Returns true if the object and shape present in the container
 171   /// \param theObject a model object, a set of shapes is searched by it
 172   /// \param theShape a shape to be in the set of the object shapes
 173   /// \param theGeomSelection a map built on selection
 174   /// \return boolean result
 175   static bool findInSelection(const ObjectPtr& theObject,
 176                             const GeomShapePtr& theShape,
 177                             const std::map<ObjectPtr, std::set<GeomShapePtr> >& theGeomSelection);
 178
 179 protected:
 180   /// List control
 181   QListWidget* myListControl;
 182
 183   /// Combobox of types
 184   QComboBox* myTypeCombo;
 185
 186   /// Provides correspondance between Result object and its shape
 187   typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
 188
 189   /// An action for pop-up menu in a list control
 190   QAction* myCopyAction;
 191   QAction* myDeleteAction;
 192
 193   /// backup parameters of the model attribute. The class processes three types of attribute:
 194   /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
 195   /// values are reserved in the backup
 196   /// Variable of selection type
 197   std::string mySelectionType;
 198
 199   /// Variable of GeomSelection
 200   int mySelectionCount; // number of elements in the attribute selection list when store
 201
 202   /// A flag to store use_choice parameter state
 203   bool myIsUseChoice;
 204 };
 205
 206 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */