Salome HOME
Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0
[modules/shaper.git] / src / PartSet / PartSet_WidgetShapeSelector.h
index 8f187cd8b47b1d1f8074506210f471f690ce91b6..fb32bff9cc7242135412d6e1fc82a7b421395003 100644 (file)
 
 #include <ModelAPI_CompositeFeature.h>
 
+
+/**
+* \ingroup Modules
+* Customosation of ModuleBase_WidgetShapeSelector in order to provide 
+* working with sketch specific objects.
+*/
 class PARTSET_EXPORT PartSet_WidgetShapeSelector: public ModuleBase_WidgetShapeSelector
 {
 Q_OBJECT
  public:
+  /// Constructor
+  /// \param theParent the parent object
+  /// \param theWorkshop instance of workshop interface
+  /// \param theData the widget configuation. The attribute of the model widget is obtained from
+  /// \param theParentId is Id of a parent of the current attribute
   PartSet_WidgetShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
-    const Config_WidgetAPI* theData, const std::string& theParentId)
-    : ModuleBase_WidgetShapeSelector(theParent, theWorkshop, theData, theParentId) {}
+    const Config_WidgetAPI* theData, const std::string& theParentId);
 
   virtual ~PartSet_WidgetShapeSelector() {}
 
-  /// Saves the internal parameters to the given feature
-  virtual bool storeValue() const;
-
+  /// Set sketcher
+  /// \param theSketch a sketcher object
   void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
+
+  /// Retrurns installed sketcher
   CompositeFeaturePtr sketch() const { return mySketch; }
 
 protected:
-  /// Check the selected with validators if installed
-  virtual bool isValid(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape);
-
-private:
-  CompositeFeaturePtr mySketch;
-};
-
-
-class PARTSET_EXPORT PartSet_WidgetConstraintShapeSelector: public ModuleBase_WidgetShapeSelector
-{
-Q_OBJECT
- public:
-  PartSet_WidgetConstraintShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
-    const Config_WidgetAPI* theData, const std::string& theParentId)
-    : ModuleBase_WidgetShapeSelector(theParent, theWorkshop, theData, theParentId) {}
-
-  virtual ~PartSet_WidgetConstraintShapeSelector() {}
+  /// Store the values to the model attribute of the widget. It casts this attribute to
+  /// the specific type and set the given values
+  /// \param theSelectedObject an object
+  /// \param theShape a selected shape, which is used in the selection attribute
+  virtual bool setObject(ObjectPtr theSelectedObject, GeomShapePtr theShape);
 
-  /// Saves the internal parameters to the given feature
-  virtual bool storeValue() const;
+  /// Creates a backup of the current values of the attribute
+  /// It should be realized in the specific widget because of different
+  /// parameters of the current attribute
+  /// \param theValid a boolean flag, if restore happens for valid parameters
+  void restoreAttributeValue(const bool theValid);
 
-  void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
-  CompositeFeaturePtr sketch() const { return mySketch; }
+  // Removes the external presentation from the model
+  void removeExternal();
 
-private:
+protected:
+  /// Pointer to a sketch 
   CompositeFeaturePtr mySketch;
+
+  /// An external object
+  ObjectPtr myExternalObject;
 };
 
 #endif
\ No newline at end of file