akonadi_next/kcolumnfilterproxymodel.h

   1 /*
   2     Copyright (C) 2010 Klarälvdalens Datakonsult AB,
   3         a KDAB Group company, info@kdab.net,
   4
   5     author Bertjan Broeksema <broeksema@kde.org>
   6
   7     This library is free software; you can redistribute it and/or
   8     modify it under the terms of the GNU Lesser General Public
   9     License as published by the Free Software Foundation; either
  10     version 2.1 of the License, or (at your option) any later version.
  11
  12     This library is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15     Lesser General Public License for more details.
  16
  17     You should have received a copy of the GNU Lesser General Public
  18     License along with this library; if not, write to the Free Software
  19     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  20 */
  21
  22
  23 #ifndef KCOLUMNFILTERPROXYMODEL_H
  24 #define KCOLUMNFILTERPROXYMODEL_H
  25
  26 #include "akonadi_next_export.h"
  27
  28 #include <QtGui/QSortFilterProxyModel>
  29
  30 template <class T> class QVector;
  31
  32 namespace Future
  33 {
  34
  35 class KColumnFilterProxyModelPrivate;
  36
  37 /**
  38   Filter model to make only certain columns of a model visible. By default all
  39   columns are visible.
  40  */
  41 class AKONADI_NEXT_EXPORT KColumnFilterProxyModel : public QSortFilterProxyModel
  42 {
  43 public:
  44   explicit KColumnFilterProxyModel( QObject* parent = 0 );
  45   virtual ~KColumnFilterProxyModel();
  46
  47   /**
  48     Returns a vector containing the visible columns. If the vector is empy, all
  49     columns are visible.
  50   */
  51   QVector<int> visbileColumns() const;
  52
  53   /**
  54     Convenience function. Has the same effect as:
  55
  56     @code
  57     setVisibleColumns( QVector<int>() << column );
  58     @endcode
  59
  60     @see setVisbileColumns
  61    */
  62   void setVisibleColumn( int column );
  63
  64   /**
  65     Change the visible columns. Pass an empty vector to make all columns visible.
  66    */
  67   void setVisibleColumns( const QVector<int> &visibleColumns );
  68
  69 protected:
  70   virtual bool filterAcceptsColumn( int column, const QModelIndex& parent ) const;
  71
  72 private:
  73   KColumnFilterProxyModelPrivate * const d_ptr;
  74   Q_DECLARE_PRIVATE( KColumnFilterProxyModel )
  75 };
  76
  77 }
  78
  79 #endif // KCOLUMNFILTERPROXYMODEL_H