Issue #389 Undo/redo problem on sketch line creation

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

diff --git a/src/XGUI/XGUI_PartDataModel.h b/src/XGUI/XGUI_PartDataModel.h
index 4ef9cd58fe5e77611c73fb0f32d3fd04994183b1..56f28ad5e441a6d2229d9e4454e7751187c33bf6 100644 (file)
--- a/src/XGUI/XGUI_PartDataModel.h
+++ b/src/XGUI/XGUI_PartDataModel.h
@@ -15,22 +15,50 @@ class XGUI_EXPORT XGUI_TopDataModel : public XGUI_FeaturesModel
 {
 Q_OBJECT
  public:
+   /// Constructor
+   /// \param theParent a parent object
   XGUI_TopDataModel(QObject* theParent);
   virtual ~XGUI_TopDataModel();
 
   // Reimpl from QAbstractItemModel
+
+  /// Returns the data stored under the given role for the item referred to by the index.
+  /// \param theIndex a model index
+  /// \param theRole a data role (see Qt::ItemDataRole)
   virtual QVariant data(const QModelIndex& theIndex, int theRole) const;
-  virtual QVariant headerData(int section, Qt::Orientation orientation,
-                              int role = Qt::DisplayRole) const;
 
-  virtual int rowCount(const QModelIndex &parent = QModelIndex()) const;
-  virtual int columnCount(const QModelIndex &parent = QModelIndex()) const;
+  /// Returns the data for the given role and section in the header with the specified orientation.
+  /// \param theSection a section
+  /// \param theOrient an orientation
+  /// \param theRole a data role (see Qt::ItemDataRole)
+  virtual QVariant headerData(int theSection, Qt::Orientation theOrient,
+                              int theRole = Qt::DisplayRole) const;
+
+  /// Returns the number of rows under the given parent. When the parent is valid it means that 
+  /// rowCount is returning the number of children of parent.
+  /// \param theParent a parent model index
+  virtual int rowCount(const QModelIndex &theParent = QModelIndex()) const;
+
+  /// Returns the number of columns for the children of the given parent.
+  /// It has a one column
+  /// \param theParent a parent model index
+  virtual int columnCount(const QModelIndex &theParent = QModelIndex()) const;
 
+
+  /// Returns the index of the item in the model specified by the given row, column and parent index.
+  /// \param theRow a row
+  /// \param theColumn a column
+  /// \param theParent a parent model index
   virtual QModelIndex index(int theRow, int theColumn, const QModelIndex& theParent =
                                 QModelIndex()) const;
 
+  /// Returns the parent of the model item with the given index. 
+  /// If the item has no parent, an invalid QModelIndex is returned.
+  /// \param theIndex a model index
   virtual QModelIndex parent(const QModelIndex& theIndex) const;
 
+  /// Returns true if parent has any children; otherwise returns false.
+  /// \param theParent a parent model index
   virtual bool hasChildren(const QModelIndex& theParent = QModelIndex()) const;
 
   //! Returns object by the given Model index.
@@ -70,22 +98,49 @@ class XGUI_PartDataModel : public XGUI_PartModel
 {
 Q_OBJECT
  public:
+   /// Constructor
+   /// \param theParent a parent object
   XGUI_PartDataModel(QObject* theParent);
   virtual ~XGUI_PartDataModel();
 
   // Reimpl from QAbstractItemModel
-  virtual QVariant data(const QModelIndex& theIndex, int theRole) const;
-  virtual QVariant headerData(int section, Qt::Orientation orientation,
-                              int role = Qt::DisplayRole) const;
 
-  virtual int rowCount(const QModelIndex &parent = QModelIndex()) const;
-  virtual int columnCount(const QModelIndex &parent = QModelIndex()) const;
+  /// Returns the data stored under the given role for the item referred to by the index.
+  /// \param theIndex a model index
+  /// \param theRole a data role (see Qt::ItemDataRole)
+  virtual QVariant data(const QModelIndex& theIndex, int theRole) const;
 
+  /// Returns the data for the given role and section in the header with the specified orientation.
+  /// \param theSection a section
+  /// \param theOrient an orientation
+  /// \param theRole a data role (see Qt::ItemDataRole)
+  virtual QVariant headerData(int theSection, Qt::Orientation theOrient,
+                              int theRole = Qt::DisplayRole) const;
+
+  /// Returns the number of rows under the given parent. When the parent is valid it means that 
+  /// rowCount is returning the number of children of parent.
+  /// \param theParent a parent model index
+  virtual int rowCount(const QModelIndex &theParent = QModelIndex()) const;
+
+  /// Returns the number of columns for the children of the given parent.
+  /// It has a one column
+  /// \param theParent a parent model index
+  virtual int columnCount(const QModelIndex &theParent = QModelIndex()) const;
+
+  /// Returns the index of the item in the model specified by the given row, column and parent index.
+  /// \param theRow a row
+  /// \param theColumn a column
+  /// \param theParent a parent model index
   virtual QModelIndex index(int theRow, int theColumn, const QModelIndex& theParent =
                                 QModelIndex()) const;
 
+  /// Returns the parent of the model item with the given index. 
+  /// If the item has no parent, an invalid QModelIndex is returned.
+  /// \param theIndex a model index
   virtual QModelIndex parent(const QModelIndex& theIndex) const;
 
+  /// Returns true if parent has any children; otherwise returns false.
+  /// \param theParent a parent model index
   virtual bool hasChildren(const QModelIndex& theParent = QModelIndex()) const;
 
   //! Returns object by the given Model index.
@@ -113,6 +168,7 @@ Q_OBJECT
   //! Returns document of the current part
   DocumentPtr partDocument() const;
 
+  //! Returns defult number of rows
   int getRowsNumber() const;
 
   //! Types of QModelIndexes