Akonadi::CollectionStatisticsDelegate Class Reference

#include <collectionstatisticsdelegate.h>

Inherits QStyledItemDelegate.

Public Slots
bool	progressAnimationEnabled () const
void	setProgressAnimationEnabled (bool enable)
void	setUnreadCountShown (bool enable)
bool	unreadCountShown () const

Public Member Functions
	CollectionStatisticsDelegate (QAbstractItemView *parent)
	CollectionStatisticsDelegate (QTreeView *parent)
	~CollectionStatisticsDelegate ()
void	updatePalette ()

Protected Member Functions
virtual void	initStyleOption (QStyleOptionViewItem *option, const QModelIndex &index) const
virtual void	paint (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const

Detailed Description

A delegate that draws unread and total count for CollectionStatisticsModel.

The delegate provides the following features:

• Collections with unread items will have the foldername and the unread column marked in bold.
• If a folder is collapsed, the unread and the total column will contain the total sum of all child folders
• It has the possibility to draw the unread count directly after the foldername, see toggleUnreadAfterFolderName().

Example:

Akonadi::EntityTreeView *view = new Akonadi::EntityTreeView( this );

Akonadi::StatisticsProxyModel *statisticsProxy = new Akonadi::StatisticsProxyModel( view );
view->setModel( statisticsProxy );

Akonadi::CollectionStatisticsDelegate *delegate = new Akonadi::CollectionStatisticsDelegate( view );
view->setItemDelegate( delegate );

Note

This proxy model is intended to be used on top of the EntityTreeModel. One of the proxies between the EntityTreeModel (the root model) and the view must be a StatisticsProxyModel. That proxy model may appear anywhere in the chain.

Author

Thomas McGuire thoma.nosp@m.s.mc.nosp@m.guire.nosp@m.@gmx.nosp@m..net

Definition at line 64 of file collectionstatisticsdelegate.h.

Constructor & Destructor Documentation

CollectionStatisticsDelegate::CollectionStatisticsDelegate ( QAbstractItemView *  parent )

explicit

Creates a new collection statistics delegate.

Parameters

parent

The parent item view, which will also take ownership.

Since

4.6

Definition at line 98 of file collectionstatisticsdelegate.cpp.

CollectionStatisticsDelegate::CollectionStatisticsDelegate ( QTreeView *  parent )

explicit

Creates a new collection statistics delegate.

Parameters

parent

The parent tree view, which will also take ownership.

Definition at line 105 of file collectionstatisticsdelegate.cpp.

CollectionStatisticsDelegate::~CollectionStatisticsDelegate

(

)

Destroys the collection statistics delegate.

Definition at line 112 of file collectionstatisticsdelegate.cpp.

Member Function Documentation

void CollectionStatisticsDelegate::initStyleOption ( QStyleOptionViewItem *  option, const QModelIndex &  index  ) const

protectedvirtual

Parameters

option	style option view item
index	model index (QModelIndex)

Definition at line 151 of file collectionstatisticsdelegate.cpp.

void CollectionStatisticsDelegate::paint ( QPainter *  painter, const QStyleOptionViewItem &  option, const QModelIndex &  index  ) const

protectedvirtual

Parameters

painter	pointer for QPainter to use in method
option	style options
index	model index (QModelIndex)

Definition at line 197 of file collectionstatisticsdelegate.cpp.

void CollectionStatisticsDelegate::setProgressAnimationEnabled ( bool  enable )

slot

Parameters

enable

new mode of progress animation

Definition at line 129 of file collectionstatisticsdelegate.cpp.

void CollectionStatisticsDelegate::setUnreadCountShown ( bool  enable )

slot

Sets whether the unread count is drawn next to the folder name.

You probably want to enable this when the unread count is hidden only. This is disabled by default.

Parameters

enable

If true, the unread count is drawn next to the folder name, if false, the folder name will be drawn normally.

Definition at line 117 of file collectionstatisticsdelegate.cpp.

bool CollectionStatisticsDelegate::unreadCountShown ( ) const

slot

Returns whether the unread count is drawn next to the folder name.

Definition at line 123 of file collectionstatisticsdelegate.cpp.

void CollectionStatisticsDelegate::updatePalette

(

)

Since

4.9.1

Definition at line 360 of file collectionstatisticsdelegate.cpp.

---

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

• collectionstatisticsdelegate.h
• collectionstatisticsdelegate.cpp