okular/ui/annotationproxymodels.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Tobias Koenig <tokoe@kde.org>                   *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  ***************************************************************************/
   9
  10 #ifndef ANNOTATIONPROXYMODEL_H
  11 #define ANNOTATIONPROXYMODEL_H
  12
  13 #include <QtGui/QSortFilterProxyModel>
  14 #include <QtCore/QPair>
  15
  16 /**
  17  * A proxy model, which filters out all pages except the
  18  * current one.
  19  */
  20 class PageFilterProxyModel : public QSortFilterProxyModel
  21 {
  22   Q_OBJECT
  23
  24   public:
  25     /**
  26      * Creates a new page filter proxy model.
  27      *
  28      * @param parent The parent object.
  29      */
  30     PageFilterProxyModel( QObject *parent = 0 );
  31
  32     /**
  33      * Reimplemented from QSortFilterProxy.
  34      */
  35     virtual bool filterAcceptsRow( int, const QModelIndex& ) const;
  36
  37   public Q_SLOTS:
  38     /**
  39      * Sets whether the proxy model shall filter
  40      * by current page.
  41      */
  42     void groupByCurrentPage( bool value );
  43
  44     /**
  45      * Sets the current page.
  46      */
  47     void setCurrentPage( int page );
  48
  49   private:
  50     bool mGroupByCurrentPage;
  51     int mCurrentPage;
  52 };
  53
  54 /**
  55  * A proxy model which either groups the annotations by
  56  * pages or shows them all as list.
  57  */
  58 class PageGroupProxyModel : public QAbstractProxyModel
  59 {
  60   Q_OBJECT
  61
  62   public:
  63     /**
  64      * Creates a new page group proxy model.
  65      *
  66      * @param parent The parent object.
  67      */
  68     PageGroupProxyModel( QObject *parent = 0 );
  69
  70     virtual int columnCount( const QModelIndex &parentIndex ) const;
  71     virtual int rowCount( const QModelIndex &parentIndex ) const;
  72
  73     virtual QModelIndex index( int row, int column, const QModelIndex &parentIndex = QModelIndex() ) const;
  74     virtual QModelIndex parent( const QModelIndex &index ) const;
  75
  76     virtual QModelIndex mapFromSource( const QModelIndex &sourceIndex ) const;
  77     virtual QModelIndex mapToSource( const QModelIndex &proxyIndex ) const;
  78
  79     virtual void setSourceModel( QAbstractItemModel *model );
  80
  81   public Q_SLOTS:
  82     /**
  83      * Sets whether the proxy model shall group
  84      * the annotations by page.
  85      */
  86     void groupByPage( bool value );
  87
  88   private Q_SLOTS:
  89     void rebuildIndexes();
  90
  91   private:
  92     bool mGroupByPage;
  93     QList<QModelIndex> mIndexes;
  94     QList<QPair< QModelIndex, QList<QModelIndex> > > mTreeIndexes;
  95 };
  96
  97 /**
  98  * A proxy model which groups the annotations by author.
  99  */
 100 class AuthorGroupProxyModel : public QAbstractProxyModel
 101 {
 102     Q_OBJECT
 103
 104     public:
 105         /**
 106          * Creates a new author group proxy model.
 107          *
 108          * @param parent The parent object.
 109          */
 110         AuthorGroupProxyModel( QObject *parent = 0 );
 111         ~AuthorGroupProxyModel();
 112
 113         virtual int columnCount( const QModelIndex &parentIndex ) const;
 114         virtual int rowCount( const QModelIndex &parentIndex ) const;
 115
 116         virtual QModelIndex index( int row, int column, const QModelIndex &parentIndex = QModelIndex() ) const;
 117         virtual QModelIndex parent( const QModelIndex &index ) const;
 118
 119         virtual QModelIndex mapFromSource( const QModelIndex &sourceIndex ) const;
 120         virtual QModelIndex mapToSource( const QModelIndex &proxyIndex ) const;
 121
 122         virtual void setSourceModel( QAbstractItemModel *model );
 123
 124         virtual QItemSelection mapSelectionToSource(const QItemSelection &selection) const;
 125         virtual QItemSelection mapSelectionFromSource(const QItemSelection &selection) const;
 126         QVariant data(const QModelIndex &proxyIndex, int role = Qt::DisplayRole) const;
 127         QMap<int, QVariant> itemData(const QModelIndex &index) const;
 128         Qt::ItemFlags flags(const QModelIndex &index) const;
 129
 130     public Q_SLOTS:
 131         /**
 132          * Sets whether the proxy model shall group
 133          * the annotations by author.
 134          */
 135         void groupByAuthor( bool value );
 136
 137     private Q_SLOTS:
 138         void rebuildIndexes();
 139
 140     private:
 141         class Private;
 142         Private* const d;
 143 };
 144
 145 #endif