foldertreewidget.h

Go to the documentation of this file.

/* -*- mode: C++; c-file-style: "gnu" -*-

  Copyright (c) 2009-2015 Montel Laurent <montel@kde.org>

  The program is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License, version 2, as
  published by the Free Software Foundation.

  This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License along
  with this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef MAILCOMMON_FOLDERTREEWIDGET_H
#define MAILCOMMON_FOLDERTREEWIDGET_H

#include "mailcommon_export.h"
#include "foldertreewidgetproxymodel.h"

#include <Akonadi/Collection>

#include <QAbstractItemView>
#include <QWidget>

namespace KPIM {
class StatisticsProxyModel;
}

class KLineEdit;
class KXMLGUIClient;

class QItemSelectionModel;

namespace MailCommon {

class EntityCollectionOrderProxyModel;
class FolderTreeView;

class MAILCOMMON_EXPORT FolderTreeWidget : public QWidget
{
    Q_OBJECT

public:
    enum TreeViewOption {
        None = 0,
        ShowUnreadCount = 1,
        UseLineEditForFiltering = 2,
        UseDistinctSelectionModel = 4,
        ShowCollectionStatisticAnimation = 8,
        DontKeyFilter = 16
    };
    Q_DECLARE_FLAGS( TreeViewOptions, TreeViewOption )

    explicit FolderTreeWidget(
            QWidget *parent = 0,
            KXMLGUIClient *xmlGuiClient = 0,
            TreeViewOptions options = (TreeViewOptions)( ShowUnreadCount |
                                                         ShowCollectionStatisticAnimation ),
            FolderTreeWidgetProxyModel::FolderTreeWidgetProxyModelOptions optReadableProxy = FolderTreeWidgetProxyModel::None );
    ~FolderTreeWidget();

    enum ToolTipDisplayPolicy {
        DisplayAlways,           
        DisplayWhenTextElided,   
        DisplayNever             
    };

    enum SortingPolicy {
        SortByCurrentColumn,      
        SortByDragAndDropKey      
    };

    void selectCollectionFolder( const Akonadi::Collection & col );

    void setSelectionMode( QAbstractItemView::SelectionMode mode );

    QAbstractItemView::SelectionMode selectionMode() const;

    QItemSelectionModel * selectionModel () const;

    QModelIndex currentIndex() const;

    Akonadi::Collection selectedCollection() const;

    Akonadi::Collection::List selectedCollections() const;

    FolderTreeView *folderTreeView() const;

    KPIM::StatisticsProxyModel * statisticsProxyModel() const;

    FolderTreeWidgetProxyModel *folderTreeWidgetProxyModel() const;

    EntityCollectionOrderProxyModel *entityOrderProxy() const;

    void quotaWarningParameters( const QColor &color, qreal threshold );
    void readQuotaConfig();

    KLineEdit *filterFolderLineEdit() const;
    void applyFilter( const QString & );
    void clearFilter();

    void disableContextMenuAndExtraColumn();

    void readConfig();

    void restoreHeaderState( const QByteArray &data );

protected:
    void changeToolTipsPolicyConfig( ToolTipDisplayPolicy );

protected slots:
    void slotChangeTooltipsPolicy( FolderTreeWidget::ToolTipDisplayPolicy );
    void slotManualSortingChanged( bool );
    void slotFilterFixedString( const QString & );
    void slotGeneralFontChanged();
    void slotGeneralPaletteChanged();

private:
    virtual bool eventFilter( QObject *o, QEvent *e );
    class FolderTreeWidgetPrivate;
    FolderTreeWidgetPrivate *const d;

};

}

#endif