mailcommon/foldertreeview.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 MAILCOMMON_FOLDERTREEVIEW_H
  20 #define MAILCOMMON_FOLDERTREEVIEW_H
  21
  22 #include "mailcommon_export.h"
  23
  24 #include "foldertreewidget.h"
  25 #include "mailutil.h"
  26
  27 #include <akonadi/entitytreeview.h>
  28 #include <akonadi/collection.h>
  29
  30 class QMouseEvent;
  31
  32 namespace Akonadi
  33 {
  34 class CollectionStatisticsDelegate;
  35 }
  36
  37 namespace MailCommon {
  38
  39 /**
  40  * This is an enhanced EntityTreeView specially suited for the folders in KMail's
  41  * main folder widget.
  42  */
  43 class MAILCOMMON_EXPORT FolderTreeView : public Akonadi::EntityTreeView
  44 {
  45   Q_OBJECT
  46 public:
  47   explicit FolderTreeView( QWidget *parent = 0, bool showUnreadCount = true );
  48
  49   explicit FolderTreeView( KXMLGUIClient *xmlGuiClient, QWidget *parent = 0, 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 protected:
  67   enum Move { Next = 0, Previous = 1};
  68   void init( bool showUnreadCount );
  69   void selectModelIndex( const QModelIndex & );
  70   void setCurrentModelIndex( const QModelIndex & );
  71   QModelIndex selectNextFolder( const QModelIndex & current );
  72   bool isUnreadFolder( const QModelIndex & current, QModelIndex &nextIndex,FolderTreeView::Move move, bool confirm);
  73   void readConfig();
  74   void writeConfig();
  75
  76   void setSortingPolicy( FolderTreeWidget::SortingPolicy policy );
  77
  78   virtual void mousePressEvent( QMouseEvent *e );
  79
  80
  81 public slots:
  82   void slotFocusNextFolder();
  83   void slotFocusPrevFolder();
  84   void slotSelectFocusFolder();
  85
  86 protected slots:
  87   void slotHeaderContextMenuRequested( const QPoint& );
  88   void slotHeaderContextMenuChangeIconSize( bool );
  89   void slotHeaderContextMenuChangeHeader( bool );
  90   void slotHeaderContextMenuChangeToolTipDisplayPolicy( bool );
  91   void slotHeaderContextMenuChangeSortingPolicy( bool );
  92
  93 signals:
  94   void changeTooltipsPolicy( FolderTreeWidget::ToolTipDisplayPolicy );
  95   void manualSortingChanged( bool actif );
  96   void prefereCreateNewTab( bool );
  97 private:
  98   bool ignoreUnreadFolder( const Akonadi::Collection&, bool ) const;
  99   bool allowedToEnterFolder( const Akonadi::Collection&, bool ) const;
 100   bool trySelectNextUnreadFolder( const QModelIndex&, MailCommon::Util::SearchDirection, bool );
 101
 102   FolderTreeWidget::ToolTipDisplayPolicy mToolTipDisplayPolicy;
 103   FolderTreeWidget::SortingPolicy mSortingPolicy;
 104   Akonadi::CollectionStatisticsDelegate *mCollectionStatisticsDelegate;
 105   bool mbDisableContextMenuAndExtraColumn;
 106   bool mLastButtonPressedWasMiddle;
 107 };
 108
 109 }
 110
 111 #endif