* fix spelling in comments to please John.

[lyx.git] / src / frontends / qt4 / TocModel.h

diff --git a/src/frontends/qt4/TocModel.h b/src/frontends/qt4/TocModel.h
index f4ac2a28c6791b2be4af3d62917840ae42d2d985..7475416160198a57ac531b2341acaeee25b3f959 100644 (file)
--- a/src/frontends/qt4/TocModel.h
+++ b/src/frontends/qt4/TocModel.h
@@ -29,6 +29,8 @@ class TocItem;
 
 namespace frontend {
 
+/// A QStandardItemModel that gives access to the reset method.
+/// This is needed in order to fix http://www.lyx.org/trac/ticket/3740
 class TocTypeModel : public QStandardItemModel
 {
 public:
@@ -38,7 +40,9 @@ public:
        void reset();
 };
 
-
+/// A class that adapt the TocBackend of a Buffer into standard Qt models for
+/// GUI visualisation.
+/// There is one TocModel per list in the TocBackend.
 class TocModel
 {
 public:
@@ -49,6 +53,8 @@ public:
        ///
        void reset();
        ///
+       void updateItem(DocIterator const & dit);
+       ///
        void clear();
        ///
        QAbstractItemModel * model();
@@ -83,6 +89,7 @@ private:
 };
 
 
+/// A container for the different TocModels.
 class TocModels : public QObject
 {
        Q_OBJECT
@@ -106,9 +113,14 @@ public:
        ///
        void updateBackend() const;
        ///
+       void updateItem(QString const & type, DocIterator const & dit);
+       ///
        void sort(QString const & type, bool sort_it);
        ///
        bool isSorted(QString const & type) const;
+       /// the item that is currently selected
+       TocItem const currentItem(QString const & type,
+               QModelIndex const & index) const;
 
 Q_SIGNALS:
        /// Signal that the internal toc_models_ has been reset.