kmail/foldertreewidget.h

   1 /* -*- mode: C++; c-file-style: "gnu" -*-
   2   This file is part of KMail, the KDE mail client.
   3   Copyright (c) 2009, 2010 Montel Laurent <montel@kde.org>
   4
   5   KMail is free software; you can redistribute it and/or modify it
   6   under the terms of the GNU General Public License, version 2, as
   7   published by the Free Software Foundation.
   8
   9   KMail is distributed in the hope that it will be useful, but
  10   WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12   General Public License for more details.
  13
  14   You should have received a copy of the GNU General Public License along
  15   with this program; if not, write to the Free Software Foundation, Inc.,
  16   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  17 */
  18
  19 #ifndef FOLDERTREEWIDGET_H
  20 #define FOLDERTREEWIDGET_H
  21
  22 #include "kmail_export.h"
  23 #include "readablecollectionproxymodel.h"
  24 #include <QWidget>
  25
  26 #include <QAbstractItemView>
  27 #include <akonadi/collection.h>
  28
  29 class KXMLGUIClient;
  30 class QItemSelectionModel;
  31 class FolderTreeView;
  32 class KLineEdit;
  33 class EntityCollectionOrderProxyModel;
  34
  35 namespace Akonadi {
  36   class StatisticsProxyModel;
  37 }
  38
  39 /**
  40  * This is the widget that shows the main folder tree in KMail.
  41  *
  42  * It consists of the view (FolderTreeView) and a search line.
  43  * Internally, several proxy models are used on top of a entity tree model.
  44  */
  45 class KMAIL_EXPORT FolderTreeWidget : public QWidget
  46 {
  47   Q_OBJECT
  48 public:
  49   enum TreeViewOption
  50   {
  51     None = 0,
  52     ShowUnreadCount = 1,
  53     UseLineEditForFiltering = 2,
  54     UseDistinctSelectionModel = 4,
  55     ShowCollectionStatisticAnimation = 8
  56   };
  57   Q_DECLARE_FLAGS( TreeViewOptions, TreeViewOption )
  58
  59   FolderTreeWidget( QWidget *parent = 0, KXMLGUIClient *xmlGuiClient = 0,
  60                     TreeViewOptions option = (TreeViewOptions) (ShowUnreadCount|ShowCollectionStatisticAnimation),
  61                     ReadableCollectionProxyModel::ReadableCollectionOptions optReadableProxy = ReadableCollectionProxyModel::None );
  62   ~FolderTreeWidget();
  63
  64   /**
  65    * The possible tooltip display policies.
  66    */
  67   enum ToolTipDisplayPolicy
  68   {
  69     DisplayAlways,           ///< Always display a tooltip when hovering over an item
  70     DisplayWhenTextElided,   ///< Display the tooltip if the item text is actually elided
  71     DisplayNever             ///< Nevery display tooltips
  72   };
  73
  74   /**
  75    * The available sorting policies.
  76    */
  77   enum SortingPolicy
  78   {
  79     SortByCurrentColumn,      ///< Columns are clickable, sorting is by the current column
  80     SortByDragAndDropKey      ///< Columns are NOT clickable, sorting is done by drag and drop
  81   };
  82
  83
  84
  85   void selectCollectionFolder( const Akonadi::Collection & col );
  86
  87   void setSelectionMode( QAbstractItemView::SelectionMode mode );
  88
  89   QAbstractItemView::SelectionMode selectionMode() const;
  90
  91   QItemSelectionModel * selectionModel () const;
  92
  93   QModelIndex currentIndex() const;
  94
  95   Akonadi::Collection selectedCollection() const;
  96
  97   Akonadi::Collection::List selectedCollections() const;
  98
  99   FolderTreeView *folderTreeView() const;
 100
 101   Akonadi::StatisticsProxyModel * statisticsProxyModel() const;
 102
 103   ReadableCollectionProxyModel *readableCollectionProxyModel() const;
 104
 105   EntityCollectionOrderProxyModel *entityOrderProxy() const;
 106
 107   void quotaWarningParameters( const QColor &color, qreal threshold );
 108   void readQuotaConfig();
 109
 110   KLineEdit *filterFolderLineEdit() const;
 111   void applyFilter( const QString& );
 112
 113   void disableContextMenuAndExtraColumn();
 114
 115   void readConfig();
 116
 117 protected:
 118   void changeToolTipsPolicyConfig( ToolTipDisplayPolicy );
 119
 120 protected slots:
 121   void slotChangeTooltipsPolicy( FolderTreeWidget::ToolTipDisplayPolicy );
 122   void slotManualSortingChanged( bool );
 123
 124 private:
 125   class FolderTreeWidgetPrivate;
 126   FolderTreeWidgetPrivate * const d;
 127 };
 128
 129 #endif
 130