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_WidgetValidated.h>
  15
  16 #include <GeomAPI_Shape.h>
  17 #include <ModelAPI_Result.h>
  18 #include <ModelAPI_AttributeSelectionList.h>
  19
  20 #include <NCollection_List.hxx>
  21 #include <TopoDS_Shape.hxx>
  22
  23 #include <QList>
  24 #include <QString>
  25 #include <QStringList>
  26 #include <QPair>
  27 #include <QMap>
  28
  29 class QWidget;
  30 class QListWidget;
  31 class QComboBox;
  32 class ModuleBase_IWorkshop;
  33 class GeomValidators_ShapeType;
  34 class QAction;
  35
  36
  37 /**
  38 * \ingroup GUI
  39 * Implementation of widget for shapes selection. This widget provides selection of several shapes.
  40 * It can be defined in XML file as following:
  41 * \code
  42 * <multi_selector id="group_list"
  43 *    tooltip="Select a set of objects"
  44 *    type_choice="vertex edge face solid" />
  45 * \endcode
  46 * It uses folloing parameters:
  47 * - id - is a name of corresponded attribute
  48 * - tooltip - a tooltip for the widget
  49 * - type_choice - list of expected shape types.
  50 */
  51 class MODULEBASE_EXPORT ModuleBase_WidgetMultiSelector : public ModuleBase_WidgetValidated
  52 {
  53   Q_OBJECT
  54  public:
  55   /// Constructor
  56   /// \param theParent the parent object
  57   /// \param theWorkshop instance of workshop interface
  58   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  59   /// \param theParentId is Id of a parent of the current attribute
  60   ModuleBase_WidgetMultiSelector(QWidget* theParent,
  61                                  ModuleBase_IWorkshop* theWorkshop,
  62                                  const Config_WidgetAPI* theData,
  63                                  const std::string& theParentId);
  64   virtual ~ModuleBase_WidgetMultiSelector();
  65
  66   virtual bool restoreValue();
  67
  68   /// Returns list of widget controls
  69   /// \return a control list
  70   virtual QList<QWidget*> getControls() const;
  71
  72   virtual bool eventFilter(QObject* , QEvent* );
  73
  74   /// The methiod called when widget is deactivated
  75   virtual void deactivate();
  76
  77   /// Set the given wrapped value to the current widget
  78   /// This value should be processed in the widget according to the needs
  79   /// \param theValues the wrapped selection values
  80   /// \param thePosition an index in the list of values, the values should be get from the index
  81   virtual bool setSelection(const QList<ModuleBase_ViewerPrs>& theValues, int& thePosition);
  82
  83   /// Fills the attribute with the value of the selected owner
  84   /// \param theOwner a selected owner
  85   virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  86
  87  public slots:
  88   /// Slot is called on selection type changed
  89   void onSelectionTypeChanged();
  90
  91   /// Slot is called on selection changed
  92   virtual void onSelectionChanged();
  93
  94 protected slots:
  95   /// Slot for copy command in a list pop-up menu
  96   void onCopyItem();
  97
  98   /// Slot is called on selection of list of selected items
  99   void onListSelection();
 100
 101  protected:
 102   /// The methiod called when widget is activated
 103   virtual void activateCustom();
 104
 105   /// Saves the internal parameters to the given feature
 106   /// \return True in success
 107   virtual bool storeValueCustom() const;
 108
 109   /// Creates a backup of the current values of the attribute
 110   /// It should be realized in the specific widget because of different
 111   /// parameters of the current attribute
 112   virtual void storeAttributeValue();
 113
 114   /// Creates a backup of the current values of the attribute
 115   /// It should be realized in the specific widget because of different
 116   /// parameters of the current attribute
 117   /// \param theValid a boolean flag, if restore happens for valid parameters
 118   virtual void restoreAttributeValue(const bool theValid);
 119
 120   /// Puts additional validators to the given list. A separate validator is created for each of the
 121   /// "type_choice" value
 122   /// \param theValidators a list of validators
 123   /// \param theArguments a list of validators arguments
 124   virtual void customValidators(std::list<ModelAPI_Validator*>& theValidators,
 125                                 std::list<std::list<std::string> >& theArguments) const;
 126
 127   /// Set current shape type for selection
 128   void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
 129
 130   /// Start shape selection
 131   /// \param isActivated a state whether the shape is activated or deactivated in selection
 132   void activateShapeSelection(const bool isActivated);
 133
 134   /// Return the attribute values wrapped in a list of viewer presentations
 135   /// \return a list of viewer presentations, which contains an attribute result and
 136   /// a shape. If the attribute do not uses the shape, it is empty
 137   QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
 138
 139  protected:
 140    /// Update selection list
 141    void updateSelectionList(AttributeSelectionListPtr);
 142
 143    /// List control
 144   QListWidget* myListControl;
 145
 146   /// Combobox of types
 147   QComboBox* myTypeCombo;
 148
 149   //TODO: Move into the base of selectors
 150   ModuleBase_IWorkshop* myWorkshop;
 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   QList<GeomSelection> mySelection;
 166
 167   /// A map of "type_choice" validators.
 168   GeomValidators_ShapeType* myShapeValidator;
 169 };
 170
 171 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */