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