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 QComboBox;
  41 class ModuleBase_ListView;
  42 class ModuleBase_IWorkshop;
  43
  44 /**
  45 * \ingroup GUI
  46 * Implementation of widget for shapes selection. This widget provides selection of several shapes.
  47 * It can be defined in XML file as following:
  48 * \code
  49 * <multi_selector id="group_list"
  50 *    tooltip="Select a set of objects"
  51 *    type_choice="Vertices Edges Faces Solids" />
  52 * \endcode
  53 * It uses following parameters:
  54 * - id - is a name of corresponded attribute
  55 * - tooltip - a tooltip for the widget
  56 * - type_choice - list of expected shape types.
  57 */
  58 class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetSelector
  59 {
  60   Q_OBJECT
  61  public:
  62   /// Constructor
  63   /// \param theParent the parent object
  64   /// \param theWorkshop instance of workshop interface
  65   /// \param theData the widget configuration. The attribute of the model widget is obtained from
  66   ModuleBase_WidgetMultiSelector(QWidget* theParent,
  67                                  ModuleBase_IWorkshop* theWorkshop,
  68                                  const Config_WidgetAPI* theData);
  69   virtual ~ModuleBase_WidgetMultiSelector();
  70
  71   /// Returns list of widget controls
  72   /// \return a control list
  73   virtual QList<QWidget*> getControls() const;
  74
  75   /// The methiod called when widget is deactivated
  76   virtual void deactivate();
  77
  78   /// Update Undo/Redo actions state
  79   virtual void updateAfterDeactivation();
  80
  81   /// Update Undo/Redo actions state
  82   virtual void updateAfterActivation();
  83
  84   /// Set the given wrapped value to the current widget
  85   /// This value should be processed in the widget according to the needs
  86   /// \param theValues the wrapped selection values
  87   /// \param theToValidate a validation of the values flag
  88   virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
  89                             const bool theToValidate);
  90
  91   /// Returns values which should be highlighted when the whidget is active
  92   /// \param theValues a list of presentations
  93   virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
  94
  95   /// Returns true if the action can be processed. By default it is empty and returns false.
  96   /// \param theActionType an action type
  97   /// \param isActionEnabled if true, the enable state of the action
  98   virtual bool canProcessAction(ModuleBase_ActionType theActionType, bool& isActionEnabled);
  99
 100   /// Returns true if the event is processed. The default implementation is empty, returns false.
 101   virtual bool processAction(ModuleBase_ActionType theActionType,
 102                              const ActionParamPtr& theParam = ActionParamPtr());
 103
 104   /// Checks the widget validity. By default, it returns true.
 105   /// \param thePrs a selected presentation in the view
 106   /// \return a boolean value
 107   virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 108
 109   /// Returns list of accessible actions for Undo/Redo commands. By default it returns empty list.
 110   /// \param theActionType type of action. It can be ActionUndo or ActionRedo.
 111   virtual QList<ActionInfo> actionsList(ModuleBase_ActionType theActionType) const;
 112
 113 public slots:
 114   /// Slot is called on selection type changed
 115   void onSelectionTypeChanged();
 116
 117 protected:
 118   /// Returns true if envent is processed.
 119   /// Redefined to process XML state about clear selection in neutral point
 120   virtual bool processSelection();
 121
 122 protected slots:
 123   /// Slot for delete command in a list pop-up menu
 124   void onDeleteItem();
 125
 126   /// Slot is called on selection of list of selected items
 127   void onListSelection();
 128
 129 protected:
 130   /// Returns true if the event is processed. The default implementation is empty, returns false.
 131   virtual bool processDelete();
 132
 133   /// The methiod called when widget is activated
 134   virtual void activateCustom();
 135
 136   /// Saves the internal parameters to the given feature
 137   /// \return True in success
 138   virtual bool storeValueCustom();
 139
 140   /// restire type of selection by feature attribute
 141   virtual bool restoreValueCustom();
 142
 143   /// Creates an element of the attribute current selection if history is empty
 144   virtual void appendFirstSelectionInHistory();
 145
 146   /// Create an element in the history that stores the current selection,
 147   /// position in the history is incremented
 148   void appendSelectionInHistory();
 149
 150   /// Clear list of stored selected items, reset current position into '-1'
 151   void clearSelectedHistory();
 152
 153   /// Set the focus on the last item in  the list
 154   virtual void updateFocus();
 155
 156   /// Computes and updates name of selected object in the widget
 157   virtual void updateSelectionName();
 158
 159   /// Emits model changed info, updates the current control by selection change
 160   /// \param theDone a state whether the selection is set
 161   virtual void updateOnSelectionChanged(const bool theDone);
 162
 163   /// Retunrs a list of possible shape types
 164   /// \return a list of shapes
 165   virtual QIntList shapeTypes() const;
 166
 167   /// Set current shape type for selection
 168   void setCurrentShapeType(const int theShapeType);
 169
 170   /// Return the attribute values wrapped in a list of viewer presentations
 171   /// \return a list of viewer presentations, which contains an attribute result and
 172   /// a shape. If the attribute do not uses the shape, it is empty
 173   virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getAttributeSelection() const;
 174
 175   /// Fills the list control by the attribute values
 176   void updateSelectionList();
 177
 178   /// Converts the XML defined type choice to the validator type
 179   /// For example, the "Edges" is converted to "edge"
 180   std::string validatorType(const QString& theType) const;
 181
 182   /// Clear selection in the viewer. The content of the widget is cleared also
 183   void clearSelection();
 184
 185 protected:
 186   /// Returns attribute indices selected in the widget selection list
 187   /// \param theIndices a list of indices
 188   void getSelectedAttributeIndices(std::set<int>& theIndices);
 189
 190   /// Gets the feature attribute and fill a list of viewer presentation for the attribute
 191   /// indices. If the the container of indices is empty, it returns all objects.
 192   /// \param theAttributeIds indices in attribute list to be returned
 193   /// \param theValues the result presentations, filled with object and shape of an attribute item
 194   void convertIndicesToViewerSelection(std::set<int> theAttributeIds,
 195                             QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) const;
 196
 197   /// Iterates throgh the model attribute list and remove elements which do not present in the list
 198   /// \param theValues the wrapped selection values
 199   /// \return true if at least one object is removed
 200   virtual bool removeUnusedAttributeObjects(
 201     QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
 202
 203   /// Converts viewer presentation selection list to objects and shapes map
 204   /// \param theValues the wrapped selection values
 205   /// \return selection list
 206   std::map<ObjectPtr, std::set<GeomShapePtr> > convertSelection
 207                                           (QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
 208
 209   /// Returns true if the object and shape present in the container
 210   /// \param theObject a model object, a set of shapes is searched by it
 211   /// \param theShape a shape to be in the set of the object shapes
 212   /// \param theGeomSelection a map built on selection
 213   /// \param theWorkshop a current workshop
 214   /// \return boolean result
 215   static bool findInSelection(const ObjectPtr& theObject,
 216                             GeomShapePtr theShape,
 217                             const std::map<ObjectPtr, std::set<GeomShapePtr> >& theGeomSelection,
 218                             ModuleBase_IWorkshop* theWorkshop);
 219
 220 protected:
 221   ModuleBase_ListView* myListView; ///< List control
 222   QComboBox* myTypeCombo; ///< Combobox of types
 223   bool myIsUseChoice; /// A flag to store use_choice parameter state
 224
 225   /// A flag to clear selection by click in empty place in the viewer
 226   bool myIsNeutralPointClear;
 227
 228   /// A flag to block set selection perform if the method is in process
 229   bool myIsSetSelectionBlocked;
 230
 231   /// A container of selected objects
 232   QList<QList<std::shared_ptr<ModuleBase_ViewerPrs> > > mySelectedHistoryValues;
 233   /// Position in a container of selected values
 234   int myCurrentHistoryIndex;
 235 };
 236
 237 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */