Documentation updated

[modules/shaper.git] / src / XGUI / XGUI_DataTreeModel.h

diff --git a/src/XGUI/XGUI_DataTreeModel.h b/src/XGUI/XGUI_DataTreeModel.h
index 05c5f7e123961d7bea1ebad2ff907413198172eb..fb28e59f8406154317e05ff487e3527ef13c7482 100644 (file)
--- a/src/XGUI/XGUI_DataTreeModel.h
+++ b/src/XGUI/XGUI_DataTreeModel.h
@@ -1,12 +1,13 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
 
 #ifndef XGUI_DataTreeModel_H
 #define XGUI_DataTreeModel_H
 
 #include "XGUI.h"
-#include "XGUI_Constants.h"
 
 #include <ModelAPI_Document.h>
 #include <ModelAPI_Feature.h>
+#include <ModelAPI_ResultPart.h>
 
 #include <QAbstractItemModel>
 #include <QColor>
@@ -17,56 +18,79 @@
  */
 class XGUI_EXPORT XGUI_FeaturesModel : public QAbstractItemModel
 {
-public:
-  XGUI_FeaturesModel(const DocumentPtr& theDocument, QObject* theParent):
-      QAbstractItemModel(theParent), myDocument(theDocument), myItemsColor(Qt::black) {}
+ public:
+   /// Constructor
+   /// \param theParent a parent object
+  XGUI_FeaturesModel(QObject* theParent)
+      : QAbstractItemModel(theParent),
+        myItemsColor(Qt::black)
+  {
+  }
 
   //! Returns Feature object by the given Model index.
   //! Returns 0 if the given index is not index of a feature
-  virtual FeaturePtr feature(const QModelIndex& theIndex) const = 0;
+  /// \param theIndex a model index
+  virtual ObjectPtr object(const QModelIndex& theIndex) const = 0;
 
   //! Returns QModelIndex which corresponds to the given feature
   //! If the feature is not found then index is not valid
-  virtual QModelIndex featureIndex(const FeaturePtr& theFeature) const = 0;
+  virtual QModelIndex objectIndex(const ObjectPtr& theFeature) const = 0;
 
   //! Returns parent index of the given feature
-  virtual QModelIndex findParent(const FeaturePtr& theFeature) const = 0;
+  virtual QModelIndex findParent(const ObjectPtr& theObject) const = 0;
 
   //! Returns index corresponded to the group
+  //! \param theGroup a group name
   virtual QModelIndex findGroup(const std::string& theGroup) const = 0;
 
-  void setItemsColor(const QColor& theColor) { myItemsColor = theColor; }
+  //! Set color of items
+  void setItemsColor(const QColor& theColor)
+  {
+    myItemsColor = theColor;
+  }
 
-  QColor itemsColor() const { return myItemsColor; }
+  //! Returns color of items
+  QColor itemsColor() const
+  {
+    return myItemsColor;
+  }
 
-protected:
-  boost::shared_ptr<ModelAPI_Document> myDocument;
+ protected:
+   /// Color of items
   QColor myItemsColor;
 };
 
-
 /**\class XGUI_PartModel
  * \ingroup GUI
  * \brief Abstaract class of model object which operates with parts data.
  */
 class XGUI_PartModel : public XGUI_FeaturesModel
 {
-public:
-  XGUI_PartModel(const DocumentPtr& theDocument, QObject* theParent):
-      XGUI_FeaturesModel(theDocument, theParent) {}
-
-  void setPartId(int theId) { myId = theId; }
+ public:
+   /// Constructor
+   /// \param theParent a parent object
+  XGUI_PartModel(QObject* theParent)
+      : XGUI_FeaturesModel(theParent)
+  {
+  }
+
+  /// Set part id
+  /// \param theId a new id
+  void setPartId(int theId)
+  {
+    myId = theId;
+  }
 
   //! Returns true if the given document is a sub-document of this tree
+  //! \param theDoc a document to check
   virtual bool hasDocument(const DocumentPtr& theDoc) const = 0;
 
   //! Return a Part object
-  virtual FeaturePtr part() const = 0;
+  virtual ResultPartPtr part() const = 0;
 
-protected:
+ protected:
   //! Id of the current part object in the document
   int myId;
 };
 
-
-#endif
\ No newline at end of file
+#endif