Akonadi::CollectionStatisticsDelegate Class Reference

#include <collectionstatisticsdelegate.h>

Inheritance diagram for Akonadi::CollectionStatisticsDelegate:

Public Member Functions
	CollectionStatisticsDelegate (QAbstractItemView *parent)
	CollectionStatisticsDelegate (QTreeView *parent)
	~CollectionStatisticsDelegate () override
bool	progressAnimationEnabled () const
void	setProgressAnimationEnabled (bool enable)
void	setUnreadCountShown (bool enable)
bool	unreadCountShown () const
void	updatePalette ()
Public Member Functions inherited from QStyledItemDelegate
	QStyledItemDelegate (QObject *parent)
virtual QWidget *	createEditor (QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const const override
virtual QString	displayText (const QVariant &value, const QLocale &locale) const const
QItemEditorFactory *	itemEditorFactory () const const
virtual void	setEditorData (QWidget *editor, const QModelIndex &index) const const override
void	setItemEditorFactory (QItemEditorFactory *factory)
virtual void	setModelData (QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const const override
virtual QSize	sizeHint (const QStyleOptionViewItem &option, const QModelIndex &index) const const override
virtual void	updateEditorGeometry (QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const const override
Public Member Functions inherited from QAbstractItemDelegate
	QAbstractItemDelegate (QObject *parent)
void	closeEditor (QWidget *editor, QAbstractItemDelegate::EndEditHint hint)
void	commitData (QWidget *editor)
virtual void	destroyEditor (QWidget *editor, const QModelIndex &index) const const
virtual bool	helpEvent (QHelpEvent *event, QAbstractItemView *view, const QStyleOptionViewItem &option, const QModelIndex &index)
void	sizeHintChanged (const QModelIndex &index)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
void	initStyleOption (QStyleOptionViewItem *option, const QModelIndex &index) const override
void	paint (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
Protected Member Functions inherited from QStyledItemDelegate
virtual bool	editorEvent (QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index) override
virtual bool	eventFilter (QObject *editor, QEvent *event) override
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QAbstractItemDelegate
enum	EndEditHint
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QAbstractItemDelegate
	EditNextItem
	EditPreviousItem
	NoHint
	RevertModelCache
	SubmitModelCache

Detailed Description

A delegate that draws unread and total count for StatisticsProxyModel.

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 52 of file collectionstatisticsdelegate.h.

Constructor & Destructor Documentation

CollectionStatisticsDelegate() [1/2]

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 79 of file collectionstatisticsdelegate.cpp.

CollectionStatisticsDelegate() [2/2]

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 85 of file collectionstatisticsdelegate.cpp.

~CollectionStatisticsDelegate()

CollectionStatisticsDelegate::~CollectionStatisticsDelegate ( )

overridedefault

Destroys the collection statistics delegate.

Member Function Documentation

initStyleOption()

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

overrideprotectedvirtual

Parameters

option	style option view item
index	model index (QModelIndex)

Reimplemented from QStyledItemDelegate.

Definition at line 127 of file collectionstatisticsdelegate.cpp.

paint()

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

overrideprotectedvirtual

Parameters

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

Reimplemented from QStyledItemDelegate.

Definition at line 173 of file collectionstatisticsdelegate.cpp.

progressAnimationEnabled()

bool CollectionStatisticsDelegate::progressAnimationEnabled ( ) const

nodiscard

Definition at line 121 of file collectionstatisticsdelegate.cpp.

setProgressAnimationEnabled()

void CollectionStatisticsDelegate::setProgressAnimationEnabled

(

bool

enable

)

Parameters

enable

new mode of progress animation

Definition at line 105 of file collectionstatisticsdelegate.cpp.

setUnreadCountShown()

void CollectionStatisticsDelegate::setUnreadCountShown

(

bool

enable

)

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 93 of file collectionstatisticsdelegate.cpp.

unreadCountShown()

bool CollectionStatisticsDelegate::unreadCountShown ( ) const

nodiscard

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

Definition at line 99 of file collectionstatisticsdelegate.cpp.

updatePalette()

void CollectionStatisticsDelegate::updatePalette

(

)

Since

4.9.1

Definition at line 326 of file collectionstatisticsdelegate.cpp.

---

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

• collectionstatisticsdelegate.h
• collectionstatisticsdelegate.cpp