mailcommon/foldertreeview.h

   1 /* -*- mode: C++; c-file-style: "gnu" -*-
   2
   3   Copyright (c) 2009, 2010 Montel Laurent <montel@kde.org>
   4
   5   This program 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   This program 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 MAILCOMMON_FOLDERTREEVIEW_H
  20 #define MAILCOMMON_FOLDERTREEVIEW_H
  21
  22 #include "mailcommon_export.h"
  23 #include "foldertreewidget.h"
  24 #include "mailutil.h"
  25
  26 #include <Akonadi/EntityTreeView>
  27 #include <Akonadi/Collection>
  28
  29 class QMouseEvent;
  30
  31 namespace Akonadi {
  32   class CollectionStatisticsDelegate;
  33 }
  34
  35 namespace MailCommon {
  36
  37 /**
  38  * This is an enhanced EntityTreeView specially suited for the folders in KMail's
  39  * main folder widget.
  40  */
  41 class MAILCOMMON_EXPORT FolderTreeView : public Akonadi::EntityTreeView
  42 {
  43   Q_OBJECT
  44
  45   public:
  46     explicit FolderTreeView( QWidget *parent = 0, bool showUnreadCount = true );
  47
  48     explicit FolderTreeView( KXMLGUIClient *xmlGuiClient, QWidget *parent = 0,
  49                              bool showUnreadCount = true );
  50
  51     virtual ~FolderTreeView();
  52
  53     void selectNextUnreadFolder( bool confirm = false );
  54     void selectPrevUnreadFolder( bool confirm = false );
  55
  56     void showStatisticAnimation( bool anim );
  57
  58     void disableContextMenuAndExtraColumn();
  59
  60     void setTooltipsPolicy( FolderTreeWidget::ToolTipDisplayPolicy );
  61
  62     void restoreHeaderState( const QByteArray &data );
  63
  64     Akonadi::Collection currentFolder() const;
  65
  66     void disableSaveConfig();
  67     void readConfig();
  68
  69   protected:
  70     enum Move {
  71       Next = 0,
  72       Previous = 1
  73     };
  74
  75     void init( bool showUnreadCount );
  76     void selectModelIndex( const QModelIndex & );
  77     void setCurrentModelIndex( const QModelIndex & );
  78     QModelIndex selectNextFolder( const QModelIndex &current );
  79     bool isUnreadFolder( const QModelIndex &current, QModelIndex &nextIndex,
  80                          FolderTreeView::Move move, bool confirm );
  81     void writeConfig();
  82
  83     void setSortingPolicy( FolderTreeWidget::SortingPolicy policy,
  84                            bool writeInConfig = false );
  85
  86     virtual void mousePressEvent( QMouseEvent *e );
  87
  88   public slots:
  89     void slotFocusNextFolder();
  90     void slotFocusPrevFolder();
  91     void slotSelectFocusFolder();
  92
  93   protected slots:
  94     void slotHeaderContextMenuRequested( const QPoint & );
  95     void slotHeaderContextMenuChangeIconSize( bool );
  96     void slotHeaderContextMenuChangeHeader( bool );
  97     void slotHeaderContextMenuChangeToolTipDisplayPolicy( bool );
  98     void slotHeaderContextMenuChangeSortingPolicy( bool );
  99
 100   signals:
 101     void changeTooltipsPolicy( FolderTreeWidget::ToolTipDisplayPolicy );
 102     void manualSortingChanged( bool actif );
 103     void prefereCreateNewTab( bool );
 104
 105   private:
 106     bool ignoreUnreadFolder( const Akonadi::Collection &, bool ) const;
 107     bool allowedToEnterFolder( const Akonadi::Collection &, bool ) const;
 108     bool trySelectNextUnreadFolder( const QModelIndex &, MailCommon::Util::SearchDirection, bool );
 109
 110     FolderTreeWidget::ToolTipDisplayPolicy mToolTipDisplayPolicy;
 111     FolderTreeWidget::SortingPolicy mSortingPolicy;
 112     Akonadi::CollectionStatisticsDelegate *mCollectionStatisticsDelegate;
 113     bool mbDisableContextMenuAndExtraColumn;
 114     bool mbDisableSaveConfig;
 115 };
 116
 117 }
 118
 119 #endif