MailCommon::FolderTreeWidget Class Reference

#include <foldertreewidget.h>

Inheritance diagram for MailCommon::FolderTreeWidget:

Public Types
enum	SortingPolicy { SortByCurrentColumn, SortByDragAndDropKey }
enum	ToolTipDisplayPolicy { DisplayAlways, DisplayWhenTextElided, DisplayNever }
enum	TreeViewOption {   None = 0, ShowUnreadCount = 1, UseLineEditForFiltering = 2, UseDistinctSelectionModel = 4,   ShowCollectionStatisticAnimation = 8, DontKeyFilter = 16 }

Public Member Functions
	FolderTreeWidget (QWidget *parent=0, KXMLGUIClient *xmlGuiClient=0, TreeViewOptions options=(TreeViewOptions)(ShowUnreadCount|ShowCollectionStatisticAnimation), FolderTreeWidgetProxyModel::FolderTreeWidgetProxyModelOptions optReadableProxy=FolderTreeWidgetProxyModel::None)
	~FolderTreeWidget ()
void	applyFilter (const QString &)
void	clearFilter ()
QModelIndex	currentIndex () const
void	disableContextMenuAndExtraColumn ()
EntityCollectionOrderProxyModel *	entityOrderProxy () const
KLineEdit *	filterFolderLineEdit () const
FolderTreeView *	folderTreeView () const
FolderTreeWidgetProxyModel *	folderTreeWidgetProxyModel () const
void	quotaWarningParameters (const QColor &color, qreal threshold)
void	readConfig ()
void	readQuotaConfig ()
void	restoreHeaderState (const QByteArray &data)
void	selectCollectionFolder (const Akonadi::Collection &col)
Akonadi::Collection	selectedCollection () const
Akonadi::Collection::List	selectedCollections () const
QAbstractItemView::SelectionMode	selectionMode () const
QItemSelectionModel *	selectionModel () const
void	setSelectionMode (QAbstractItemView::SelectionMode mode)
KPIM::StatisticsProxyModel *	statisticsProxyModel () const

Protected Slots
void	slotChangeTooltipsPolicy (FolderTreeWidget::ToolTipDisplayPolicy)
void	slotFilterFixedString (const QString &)
void	slotGeneralFontChanged ()
void	slotGeneralPaletteChanged ()
void	slotManualSortingChanged (bool)

Protected Member Functions
void	changeToolTipsPolicyConfig (ToolTipDisplayPolicy)

Detailed Description

This is the widget that shows the main folder tree.

It consists of the view (FolderTreeView) and a search line. Internally, several proxy models are used on top of a entity tree model.

Definition at line 50 of file foldertreewidget.h.

Member Enumeration Documentation

enum MailCommon::FolderTreeWidget::SortingPolicy

The available sorting policies.

Enumerator
SortByCurrentColumn	Columns are clickable, sorting is by the current column.
SortByDragAndDropKey	Columns are NOT clickable, sorting is done by drag and drop.

Definition at line 85 of file foldertreewidget.h.

enum MailCommon::FolderTreeWidget::ToolTipDisplayPolicy

The possible tooltip display policies.

Enumerator
DisplayAlways	Always display a tooltip when hovering over an item.
DisplayWhenTextElided	Display the tooltip if the item text is actually elided.
DisplayNever	Nevery display tooltips.

Definition at line 76 of file foldertreewidget.h.

enum MailCommon::FolderTreeWidget::TreeViewOption

Enumerator
None
ShowUnreadCount
UseLineEditForFiltering
UseDistinctSelectionModel
ShowCollectionStatisticAnimation
DontKeyFilter

Definition at line 55 of file foldertreewidget.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 85 of file foldertreewidget.cpp.

MailCommon::FolderTreeWidget::~FolderTreeWidget

(

)

Definition at line 159 of file foldertreewidget.cpp.

Member Function Documentation

void MailCommon::FolderTreeWidget::applyFilter

(

const QString &

filter

)

Definition at line 360 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::changeToolTipsPolicyConfig ( ToolTipDisplayPolicy  policy )

protected

Definition at line 309 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::clearFilter

(

)

Definition at line 381 of file foldertreewidget.cpp.

QModelIndex MailCommon::FolderTreeWidget::currentIndex

(

)

const

Definition at line 221 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::disableContextMenuAndExtraColumn

(

)

Definition at line 191 of file foldertreewidget.cpp.

EntityCollectionOrderProxyModel * MailCommon::FolderTreeWidget::entityOrderProxy

(

)

const

Definition at line 350 of file foldertreewidget.cpp.

KLineEdit * MailCommon::FolderTreeWidget::filterFolderLineEdit

(

)

const

Definition at line 355 of file foldertreewidget.cpp.

FolderTreeView * MailCommon::FolderTreeWidget::folderTreeView

(

)

const

Definition at line 259 of file foldertreewidget.cpp.

FolderTreeWidgetProxyModel * MailCommon::FolderTreeWidget::folderTreeWidgetProxyModel

(

)

const

Definition at line 345 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::quotaWarningParameters	(	const QColor &	color,
		qreal	threshold
	)

Definition at line 322 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::readConfig

(

)

Definition at line 278 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::readQuotaConfig

(

)

Definition at line 328 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::restoreHeaderState

(

const QByteArray &

data

)

Definition at line 299 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::selectCollectionFolder

(

const Akonadi::Collection &

col

)

Definition at line 196 of file foldertreewidget.cpp.

Akonadi::Collection MailCommon::FolderTreeWidget::selectedCollection

(

)

const

Definition at line 226 of file foldertreewidget.cpp.

Akonadi::Collection::List MailCommon::FolderTreeWidget::selectedCollections

(

)

const

Definition at line 240 of file foldertreewidget.cpp.

QAbstractItemView::SelectionMode MailCommon::FolderTreeWidget::selectionMode

(

)

const

Definition at line 211 of file foldertreewidget.cpp.

QItemSelectionModel * MailCommon::FolderTreeWidget::selectionModel

(

)

const

Definition at line 216 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::setSelectionMode

(

QAbstractItemView::SelectionMode

mode

)

Definition at line 206 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::slotChangeTooltipsPolicy ( FolderTreeWidget::ToolTipDisplayPolicy  policy )

protectedslot

Definition at line 304 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::slotFilterFixedString ( const QString &  text )

protectedslot

Definition at line 164 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::slotGeneralFontChanged ( )

protectedslot

Definition at line 264 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::slotGeneralPaletteChanged ( )

protectedslot

Definition at line 272 of file foldertreewidget.cpp.

void MailCommon::FolderTreeWidget::slotManualSortingChanged ( bool  active )

protectedslot

Definition at line 391 of file foldertreewidget.cpp.

KPIM::StatisticsProxyModel * MailCommon::FolderTreeWidget::statisticsProxyModel

(

)

const

Definition at line 340 of file foldertreewidget.cpp.

---

The documentation for this class was generated from the following files:

• foldertreewidget.h
• foldertreewidget.cpp