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="Vertices Edges Faces Solids" />
  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   //TODO: nds stabilization hotfix
  67   virtual void disconnectSignals();
  68
  69   virtual bool restoreValue();
  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   /// Set the given wrapped value to the current widget
  79   /// This value should be processed in the widget according to the needs
  80   /// \param theValues the wrapped selection values
  81   /// \param thePosition an index in the list of values, the values should be get from the index
  82   virtual bool setSelection(const QList<ModuleBase_ViewerPrs>& theValues, int& thePosition);
  83
  84   /// Checks the widget validity. By default, it returns true.
  85   /// \param theValue a selected presentation in the view
  86   /// \return a boolean value
  87   virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  88
  89   /// Fills the attribute with the value of the selected owner
  90   /// \param theOwner a selected owner
  91   virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
  92
  93  public slots:
  94   /// Slot is called on selection type changed
  95   void onSelectionTypeChanged();
  96
  97   /// Slot is called on selection changed
  98   virtual void onSelectionChanged();
  99
 100 protected slots:
 101   /// Slot for copy command in a list pop-up menu
 102   void onCopyItem();
 103
 104   /// Slot is called on selection of list of selected items
 105   void onListSelection();
 106
 107  protected:
 108   /// The methiod called when widget is activated
 109   virtual void activateCustom();
 110
 111   /// Saves the internal parameters to the given feature
 112   /// \return True in success
 113   virtual bool storeValueCustom() const;
 114
 115   /// Creates a backup of the current values of the attribute
 116   /// It should be realized in the specific widget because of different
 117   /// parameters of the current attribute
 118   virtual void storeAttributeValue();
 119
 120   /// Creates a backup of the current values of the attribute
 121   /// It should be realized in the specific widget because of different
 122   /// parameters of the current attribute
 123   /// \param theValid a boolean flag, if restore happens for valid parameters
 124   virtual void restoreAttributeValue(const bool theValid);
 125
 126   /// Puts additional validators to the given list. A separate validator is created for each of the
 127   /// "type_choice" value
 128   /// \param theValidators a list of validators
 129   /// \param theArguments a list of validators arguments
 130   virtual void customValidators(std::list<ModelAPI_Validator*>& theValidators,
 131                                 std::list<std::list<std::string> >& theArguments) const;
 132
 133   /// Returns true if selected shape corresponds to requested shape types
 134   /// \param theShape a shape
 135   bool acceptSubShape(const TopoDS_Shape& theShape) const;
 136
 137   /// Set current shape type for selection
 138   void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
 139
 140   /// Start shape selection
 141   /// \param isActivated a state whether the shape is activated or deactivated in selection
 142   void activateShapeSelection(const bool isActivated);
 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   QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
 148
 149  protected:
 150   /// Update selection list
 151   void updateSelectionList(AttributeSelectionListPtr);
 152
 153   /// Converts the XML defined type choice to the validator type
 154   /// For example, the "Edges" is converted to "edge"
 155   std::string validatorType(const QString& theType) const;
 156
 157    /// List control
 158   QListWidget* myListControl;
 159
 160   /// Combobox of types
 161   QComboBox* myTypeCombo;
 162
 163   //TODO: Move into the base of selectors
 164   ModuleBase_IWorkshop* myWorkshop;
 165
 166   /// Provides correspondance between Result object and its shape
 167   typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
 168
 169   /// An action for pop-up menu in a list control
 170   QAction* myCopyAction;
 171
 172   /// backup parameters of the model attribute. The class processes three types of attribute:
 173   /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
 174   /// values are reserved in the backup
 175   /// Variable of selection type
 176   std::string mySelectionType;
 177
 178   /// Variable of GeomSelection
 179   QList<GeomSelection> mySelection;
 180
 181   /// An instance of the "type_choice" validator. It is returns on validating in customValidator()
 182   GeomValidators_ShapeType* myShapeValidator;
 183
 184   //bool myIsUseChoice;
 185 };
 186
 187 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */