Fix the tab ordering of GuiDocument components.

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

diff --git a/src/frontends/qt4/TocModel.h b/src/frontends/qt4/TocModel.h
index 59e83a999c39fc92b424008802e5082525534dd0..4e557ccbac1b4e4395897710e5b5ee4192c37534 100644 (file)
--- a/src/frontends/qt4/TocModel.h
+++ b/src/frontends/qt4/TocModel.h
@@ -14,9 +14,9 @@
 
 #include "qt_helpers.h"
 
-#include <QList>
+#include <QHash>
+#include <QSortFilterProxyModel>
 #include <QStandardItemModel>
-#include <QStringList>
 
 namespace lyx {
 
@@ -28,26 +28,33 @@ class TocItem;
 
 namespace frontend {
 
-class TocTypeModel : public QStandardItemModel
-{
-public:
-       ///
-       TocTypeModel(QObject * parent = 0);
-       ///
-       void reset();
-};
+class TocTypeModel;
 
-
-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,33 +65,59 @@ 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 filter to sort the models alphabetically but with
+/// the table of contents on top.
+class TocModelSortProxyModel : public QSortFilterProxyModel
+{
+public:
+       TocModelSortProxyModel(QObject * w) 
+               : QSortFilterProxyModel(w)
+       {}
+
+       bool lessThan (const QModelIndex & left, const QModelIndex & right) const
+       {
+               if (left.model()->data(left, Qt::UserRole).toString()
+                         == QString("tableofcontents"))
+                       return true;
+               else if (right.model()->data(right, Qt::UserRole).toString()
+                         == QString("tableofcontents"))
+                       return false;
+               else
+                       return QSortFilterProxyModel::lessThan(left, right);
+       }
+};
+
+
+
+/// A container for the different TocModels.
+class TocModels : public QObject
 {
        Q_OBJECT
 public:
        ///
        TocModels();
        ///
-       typedef QHash<QString, TocModel *>::const_iterator const_iterator;
-       const_iterator begin() const { return models_.begin(); }
-       const_iterator end() const { return models_.end(); }
-       ///
        void reset(BufferView const * bv);
        ///
        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;
        ///
@@ -93,23 +126,33 @@ 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.
        void modelReset();
 
 private:
+       typedef QHash<QString, TocModel *>::const_iterator const_iterator;
        typedef QHash<QString, TocModel *>::iterator iterator;
        ///
        void clear();
        ///
-       void deleteAll();
-       ///
        BufferView const * bv_;
        ///
        QHash<QString, TocModel *> models_;
        ///
        TocTypeModel * names_;
+       ///
+       TocModelSortProxyModel * names_sorted_;
 };
 
 } // namespace frontend