* 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 bafc204fc320f22532118450000ff71206a68bce..7475416160198a57ac531b2341acaeee25b3f959 100644 (file)
--- a/src/frontends/qt4/TocModel.h
+++ b/src/frontends/qt4/TocModel.h
@@ -14,9 +14,10 @@
 
 #include "qt_helpers.h"
 
-#include <QList>
+#include <QHash>
 #include <QStandardItemModel>
-#include <QStringList>
+
+class QSortFilterProxyModel;
 
 namespace lyx {
 
@@ -28,26 +29,42 @@ 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:
        ///
-       TocTypeModel(QObject * parent = 0);
+       TocTypeModel(QObject * parent);
        ///
        void reset();
 };
 
-
-class TocModel : public QStandardItemModel
+/// 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:
        ///
-       TocModel(QObject * parent = 0);
+       TocModel(QObject * parent);
        ///
        void reset(Toc const & toc);
        ///
        void reset();
        ///
+       void updateItem(DocIterator const & dit);
+       ///
+       void clear();
+       ///
+       QAbstractItemModel * model();
+       ///
+       QAbstractItemModel const * model() const;
+       ///
+       void sort(bool sort_it);
+       ///
+       bool isSorted() const { return is_sorted_; }
+       ///
        TocItem const & tocItem(QModelIndex const & index) const;
        ///
        QModelIndex modelIndex(DocIterator const & dit) const;
@@ -58,16 +75,22 @@ private:
        ///
        void populate(unsigned int & index, QModelIndex const & parent);
        ///
-       QList<QModelIndex> toc_indexes_;
+       TocTypeModel * model_;
+       ///
+       QSortFilterProxyModel * sorted_model_;
+       ///
+       bool is_sorted_;
        ///
        Toc const * toc_;
        ///
        int maxdepth_;
+       ///
        int mindepth_;
 };
 
 
-class TocModels: public QObject
+/// A container for the different TocModels.
+class TocModels : public QObject
 {
        Q_OBJECT
 public:
@@ -78,9 +101,9 @@ public:
        ///
        int depth(QString const & type);
        ///
-       QStandardItemModel * model(QString const & type);
+       QAbstractItemModel * model(QString const & type);
        ///
-       QStandardItemModel * nameModel() { return names_; }
+       QAbstractItemModel * nameModel();
        ///
        QModelIndex currentIndex(QString const & type) const;
        ///
@@ -89,6 +112,15 @@ public:
        void init(Buffer const & buffer);
        ///
        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.
@@ -105,6 +137,8 @@ private:
        QHash<QString, TocModel *> models_;
        ///
        TocTypeModel * names_;
+       ///
+       QSortFilterProxyModel * names_sorted_;
 };
 
 } // namespace frontend