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 GeomValidators_ShapeType;
  33 class QAction;
  34
  35
  36 /**
  37 * \ingroup GUI
  38 * Implementation of widget for shapes selection. This widget provides selection of several shapes.
  39 * It can be defined in XML file as following:
  40 * \code
  41 * <multi_selector id="group_list"
  42 *    tooltip="Select a set of objects"
  43 *    type_choice="Vertices Edges Faces Solids" />
  44 * \endcode
  45 * It uses following parameters:
  46 * - id - is a name of corresponded attribute
  47 * - tooltip - a tooltip for the widget
  48 * - type_choice - list of expected shape types.
  49 */
  50 class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetSelector
  51 {
  52   Q_OBJECT
  53  public:
  54   /// Constructor
  55   /// \param theParent the parent object
  56   /// \param theWorkshop instance of workshop interface
  57   /// \param theData the widget configuration. The attribute of the model widget is obtained from
  58   /// \param theParentId is Id of a parent of the current attribute
  59   ModuleBase_WidgetMultiSelector(QWidget* theParent,
  60                                  ModuleBase_IWorkshop* theWorkshop,
  61                                  const Config_WidgetAPI* theData,
  62                                  const std::string& theParentId);
  63   virtual ~ModuleBase_WidgetMultiSelector();
  64
  65   /// Returns list of widget controls
  66   /// \return a control list
  67   virtual QList<QWidget*> getControls() const;
  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   /// Checks the widget validity. By default, it returns true.
  77   /// \param thePrs a selected presentation in the view
  78   /// \return a boolean value
  79   virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  80
  81  public slots:
  82   /// Slot is called on selection type changed
  83   void onSelectionTypeChanged();
  84
  85 protected slots:
  86   /// Slot for copy command in a list pop-up menu
  87   void onCopyItem();
  88
  89   /// Slot is called on selection of list of selected items
  90   void onListSelection();
  91
  92 protected:
  93   /// Saves the internal parameters to the given feature
  94   /// \return True in success
  95   virtual bool storeValueCustom() const;
  96
  97   virtual bool restoreValueCustom();
  98
  99   /// Creates a backup of the current values of the attribute
 100   /// It should be realized in the specific widget because of different
 101   /// parameters of the current attribute
 102   virtual void storeAttributeValue();
 103
 104   /// Clear attribute
 105   virtual void clearAttribute();
 106
 107   /// Set the focus on the last item in  the list
 108   virtual void updateFocus();
 109
 110   /// Computes and updates name of selected object in the widget
 111   virtual void updateSelectionName();
 112
 113   /// Retunrs a list of possible shape types
 114   /// \return a list of shapes
 115   virtual QIntList getShapeTypes() const;
 116
 117   /// Append the values to the model attribute of the widget. It casts this attribute to
 118   /// the specific type and set the given values
 119   /// \param theSelectedObject an object
 120   /// \param theShape a selected shape, which is used in the selection attribute
 121   /// \return true if it is succeed
 122   void setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape);
 123
 124   /// Creates a backup of the current values of the attribute
 125   /// It should be realized in the specific widget because of different
 126   /// parameters of the current attribute
 127   /// \param theValid a boolean flag, if restore happens for valid parameters
 128   virtual void restoreAttributeValue(const bool theValid);
 129
 130   /// Set current shape type for selection
 131   void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
 132
 133   /// Return the attribute values wrapped in a list of viewer presentations
 134   /// \return a list of viewer presentations, which contains an attribute result and
 135   /// a shape. If the attribute do not uses the shape, it is empty
 136   virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
 137
 138   /// Fills the list control by the attribute values
 139   void updateSelectionList();
 140
 141   /// Converts the XML defined type choice to the validator type
 142   /// For example, the "Edges" is converted to "edge"
 143   std::string validatorType(const QString& theType) const;
 144
 145 protected:
 146   /// List control
 147   QListWidget* myListControl;
 148
 149   /// Combobox of types
 150   QComboBox* myTypeCombo;
 151
 152   /// Provides correspondance between Result object and its shape
 153   typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
 154
 155   /// An action for pop-up menu in a list control
 156   QAction* myCopyAction;
 157
 158   /// backup parameters of the model attribute. The class processes three types of attribute:
 159   /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
 160   /// values are reserved in the backup
 161   /// Variable of selection type
 162   std::string mySelectionType;
 163
 164   /// Variable of GeomSelection
 165   int mySelectionCount; // number of elements in the attribute selection list when store
 166
 167   /// A flag to store use_choice parameter state
 168   bool myIsUseChoice;
 169 };
 170
 171 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */