src/ModuleBase/ModuleBase_WidgetMultiSelector.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef MODULEBASE_WIDGETMULTISELECTOR_H_
  22 #define MODULEBASE_WIDGETMULTISELECTOR_H_
  23
  24 #include <ModuleBase.h>
  25 #include <ModuleBase_WidgetSelector.h>
  26
  27 #include <GeomAPI_Shape.h>
  28 #include <ModelAPI_Result.h>
  29
  30 #include <NCollection_List.hxx>
  31 #include <TopoDS_Shape.hxx>
  32
  33 #include <QList>
  34 #include <QString>
  35 #include <QStringList>
  36 #include <QPair>
  37 #include <QMap>
  38
  39 class QWidget;
  40 class QListWidget;
  41 class QComboBox;
  42 class ModuleBase_IWorkshop;
  43 class QAction;
  44
  45
  46 /**
  47 * \ingroup GUI
  48 * Implementation of widget for shapes selection. This widget provides selection of several shapes.
  49 * It can be defined in XML file as following:
  50 * \code
  51 * <multi_selector id="group_list"
  52 *    tooltip="Select a set of objects"
  53 *    type_choice="Vertices Edges Faces Solids" />
  54 * \endcode
  55 * It uses following parameters:
  56 * - id - is a name of corresponded attribute
  57 * - tooltip - a tooltip for the widget
  58 * - type_choice - list of expected shape types.
  59 */
  60 class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetSelector
  61 {
  62   Q_OBJECT
  63  public:
  64   /// Constructor
  65   /// \param theParent the parent object
  66   /// \param theWorkshop instance of workshop interface
  67   /// \param theData the widget configuration. The attribute of the model widget is obtained from
  68   ModuleBase_WidgetMultiSelector(QWidget* theParent,
  69                                  ModuleBase_IWorkshop* theWorkshop,
  70                                  const Config_WidgetAPI* theData);
  71   virtual ~ModuleBase_WidgetMultiSelector();
  72
  73   /// Returns list of widget controls
  74   /// \return a control list
  75   virtual QList<QWidget*> getControls() const;
  76
  77   /// The methiod called when widget is deactivated
  78   virtual void deactivate();
  79
  80   /// Set the given wrapped value to the current widget
  81   /// This value should be processed in the widget according to the needs
  82   /// \param theValues the wrapped selection values
  83   /// \param theToValidate a validation of the values flag
  84   virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
  85                             const bool theToValidate);
  86
  87   /// Returns values which should be highlighted when the whidget is active
  88   /// \param theValues a list of presentations
  89   virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
  90
  91   /// Checks the widget validity. By default, it returns true.
  92   /// \param thePrs a selected presentation in the view
  93   /// \return a boolean value
  94   virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
  95
  96   /// Returns true if the event is processed. The default implementation is empty, returns false.
  97   virtual bool processDelete();
  98
  99 public slots:
 100   /// Slot is called on selection type changed
 101   void onSelectionTypeChanged();
 102
 103   /// Slot which is called on selection event. Redefined to process XML state about
 104   /// clear selection in neutral point
 105   virtual void onSelectionChanged();
 106
 107 protected slots:
 108   /// Slot for copy command in a list pop-up menu
 109   void onCopyItem();
 110
 111   /// Slot for delete command in a list pop-up menu
 112   void onDeleteItem();
 113
 114   /// Slot is called on selection of list of selected items
 115   void onListSelection();
 116
 117 protected:
 118   /// The methiod called when widget is activated
 119   virtual void activateCustom();
 120
 121   /// Saves the internal parameters to the given feature
 122   /// \return True in success
 123   virtual bool storeValueCustom();
 124
 125   virtual bool restoreValueCustom();
 126
 127   /// Set the focus on the last item in  the list
 128   virtual void updateFocus();
 129
 130   /// Computes and updates name of selected object in the widget
 131   virtual void updateSelectionName();
 132
 133   /// Emits model changed info, updates the current control by selection change
 134   /// \param theDone a state whether the selection is set
 135   virtual void updateOnSelectionChanged(const bool theDone);
 136
 137   /// Retunrs a list of possible shape types
 138   /// \return a list of shapes
 139   virtual QIntList shapeTypes() const;
 140
 141   /// Set current shape type for selection
 142   void setCurrentShapeType(const int theShapeType);
 143
 144   /// Return the attribute values wrapped in a list of viewer presentations
 145   /// \return a list of viewer presentations, which contains an attribute result and
 146   /// a shape. If the attribute do not uses the shape, it is empty
 147   virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getAttributeSelection() const;
 148
 149   /// Fills the list control by the attribute values
 150   void updateSelectionList();
 151
 152   /// Converts the XML defined type choice to the validator type
 153   /// For example, the "Edges" is converted to "edge"
 154   std::string validatorType(const QString& theType) const;
 155
 156   /// Clear selection in the viewer. The content of the widget is cleared also
 157   void clearSelection();
 158
 159 protected:
 160   /// Returns attribute indices selected in the widget selection list
 161   /// \param theIndices a list of indices
 162   void getSelectedAttributeIndices(std::set<int>& theIndices);
 163
 164   /// Gets the feature attribute and fill a list of viewer presentation for the attribute
 165   /// indices. If the the container of indices is empty, it returns all objects.
 166   /// \param theAttributeIds indices in attribute list to be returned
 167   /// \param theValues the result presentations, filled with object and shape of an attribute item
 168   void convertIndicesToViewerSelection(std::set<int> theAttributeIds,
 169                             QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) const;
 170
 171   /// Iterates throgh the model attribute list and remove elements which do not present in the list
 172   /// \param theValues the wrapped selection values
 173   /// \return true if at least one object is removed
 174   virtual bool removeUnusedAttributeObjects(
 175     QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
 176
 177   /// Converts viewer presentation selection list to objects and shapes map
 178   /// \param theValues the wrapped selection values
 179   /// \return selection list
 180   std::map<ObjectPtr, std::set<GeomShapePtr> > convertSelection
 181                                           (QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
 182
 183   /// Returns true if the object and shape present in the container
 184   /// \param theObject a model object, a set of shapes is searched by it
 185   /// \param theShape a shape to be in the set of the object shapes
 186   /// \param theGeomSelection a map built on selection
 187   /// \return boolean result
 188   static bool findInSelection(const ObjectPtr& theObject,
 189                             const GeomShapePtr& theShape,
 190                             const std::map<ObjectPtr, std::set<GeomShapePtr> >& theGeomSelection);
 191
 192 protected:
 193   /// List control
 194   QListWidget* myListControl;
 195
 196   /// Combobox of types
 197   QComboBox* myTypeCombo;
 198
 199   /// Provides correspondance between Result object and its shape
 200   typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
 201
 202   /// A copy action for pop-up menu in a list control
 203   QAction* myCopyAction;
 204
 205   /// A delete action for pop-up menu in a list control
 206   QAction* myDeleteAction;
 207
 208   /// A flag to store use_choice parameter state
 209   bool myIsUseChoice;
 210
 211   /// A flag to clear selection by click in empty place in the viewer
 212   bool myIsNeutralPointClear;
 213
 214   /// A flag to block set selection perform if the method is in process
 215   bool myIsSetSelectionBlocked;
 216 };
 217
 218 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */