Akonadi::FavoriteCollectionsModel

#include <favoritecollectionsmodel.h>

Inheritance diagram for Akonadi::FavoriteCollectionsModel:

[legend]

Public Slots
void	addCollection (const Akonadi::Collection &collection)

void	removeCollection (const Akonadi::Collection &collection)

void	setCollections (const Akonadi::Collection::List &collections)

void	setFavoriteLabel (const Akonadi::Collection &collection, const QString &label)

Public Member Functions
	FavoriteCollectionsModel (QAbstractItemModel model, const KConfigGroup &group, QObject parent=nullptr)

	~FavoriteCollectionsModel () override

QList< Collection::Id >	collectionIds () const

AKONADICORE_DEPRECATED Collection::List	collections () const

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

QString	defaultFavoriteLabel (const Akonadi::Collection &col)

bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

QString	favoriteLabel (const Akonadi::Collection &col)

Qt::ItemFlags	flags (const QModelIndex &index) const override

QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override

QStringList	mimeTypes () const override

bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

Public Member Functions inherited from KSelectionProxyModel
	KSelectionProxyModel (QItemSelectionModel selectionModel, QObject parent=nullptr)

void	setFilterBehavior (FilterBehavior behavior)

void	setSourceModel (QAbstractItemModel *sourceModel) override

Public Member Functions inherited from QAbstractProxyModel
	QAbstractProxyModel (QObject *parent)

QBindable< QAbstractItemModel * >	bindableSourceModel ()

virtual QModelIndex	buddy (const QModelIndex &index) const const override

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const override

virtual bool	canFetchMore (const QModelIndex &parent) const const override

virtual bool	clearItemData (const QModelIndex &index) override

virtual void	fetchMore (const QModelIndex &parent) override

virtual bool	hasChildren (const QModelIndex &parent) const const override

virtual QMap< int, QVariant >	itemData (const QModelIndex &proxyIndex) const const override

virtual QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const const=0

virtual QItemSelection	mapSelectionFromSource (const QItemSelection &sourceSelection) const const

virtual QItemSelection	mapSelectionToSource (const QItemSelection &proxySelection) const const

virtual QModelIndex	mapToSource (const QModelIndex &proxyIndex) const const=0

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const const override

virtual void	revert () override

virtual QHash< int, QByteArray >	roleNames () const const override

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role) override

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override

virtual QModelIndex	sibling (int row, int column, const QModelIndex &idx) const const override

virtual void	sort (int column, Qt::SortOrder order) override

QAbstractItemModel *	sourceModel () const const

void	sourceModelChanged ()

virtual QSize	span (const QModelIndex &index) const const override

virtual bool	submit () override

virtual Qt::DropActions	supportedDragActions () const const override

virtual Qt::DropActions	supportedDropActions () const const override

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options) const const

virtual int	columnCount (const QModelIndex &parent) const const=0

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const const=0

bool	insertColumn (int column, const QModelIndex &parent)

virtual bool	insertColumns (int column, int count, const QModelIndex &parent)

bool	insertRow (int row, const QModelIndex &parent)

virtual bool	insertRows (int row, int count, const QModelIndex &parent)

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const

void	modelAboutToBeReset ()

void	modelReset ()

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const

virtual QModelIndex	parent (const QModelIndex &index) const const=0

bool	removeColumn (int column, const QModelIndex &parent)

virtual bool	removeColumns (int column, int count, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

virtual bool	removeRows (int row, int count, const QModelIndex &parent)

virtual int	rowCount (const QModelIndex &parent) const const=0

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

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)

virtual bool	eventFilter (QObject watched, QEvent event)

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

Additional Inherited Members
Public Types inherited from QAbstractItemModel
enum	CheckIndexOption

typedef	CheckIndexOptions

enum	LayoutChangeHint

Public Types inherited from QObject
typedef	QObjectList

Properties inherited from QAbstractProxyModel
	sourceModel

Properties inherited from QObject
	objectName

Signals inherited from KSelectionProxyModel
void	rootIndexAboutToBeRemoved (const QModelIndex &removeRootIndex, QPrivateSignal)

void	rootIndexAdded (const QModelIndex &newIndex, QPrivateSignal)

void	rootSelectionAboutToBeRemoved (const QItemSelection &selection, QPrivateSignal)

void	rootSelectionAdded (const QItemSelection &selection, QPrivateSignal)

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 QAbstractItemModel
	DoNotUseParent

	HorizontalSortHint

	IndexIsValid

	NoLayoutChangeHint

	NoOption

	ParentIsInvalid

	VerticalSortHint

Protected Member Functions inherited from QAbstractProxyModel
QModelIndex	createSourceIndex (int row, int col, void *internalPtr) const const

Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	beginResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndex	createIndex (int row, int column, const void *ptr) const const

QModelIndex	createIndex (int row, int column, quintptr id) const const

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const const

virtual void	resetInternalData ()

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)

Detailed Description

A model that lists a set of favorite collections.

In some applications you want to provide fast access to a list of often used collections (e.g. Inboxes from different email accounts in a mail application). Therefore you can use the FavoriteCollectionsModel which stores the list of favorite collections in a given configuration file.

Example:

using namespace Akonadi;
 
EntityTreeModel *sourceModel = new EntityTreeModel( ... );
 
const KConfigGroup group = KGlobal::config()->group( "Favorite Collections" );
 
FavoriteCollectionsModel *model = new FavoriteCollectionsModel( sourceModel, group, this );
 
EntityListView *view = new EntityListView( this );
view->setModel( model );

Author: Kevin Ottens ervin.nosp@m.@kde.nosp@m..org

Since: 4.4

Definition at line 52 of file favoritecollectionsmodel.h.

Constructor & Destructor Documentation

◆ FavoriteCollectionsModel()

FavoriteCollectionsModel::FavoriteCollectionsModel	(	QAbstractItemModel *	model,
		const KConfigGroup &	group,
		QObject *	parent = nullptr )

Creates a new favorite collections model.

Parameters

model	The source model where the favorite collections come from.
group	The config group that shall be used to save the selection of favorite collections.
parent	The parent object.

Definition at line 262 of file favoritecollectionsmodel.cpp.

◆ ~FavoriteCollectionsModel()

FavoriteCollectionsModel::~FavoriteCollectionsModel ( )

overridedefault

Destroys the favorite collections model.

Member Function Documentation

◆ addCollection

void FavoriteCollectionsModel::addCollection ( const Akonadi::Collection & collection )

slot

Adds a collection to the list of favorite collections.

Definition at line 293 of file favoritecollectionsmodel.cpp.

◆ collectionIds()

QList< Collection::Id > FavoriteCollectionsModel::collectionIds ( ) const

nodiscard

Returns the list of ids of favorite collections set on the FavoriteCollectionsModel.

Note that if you want Collections with actual data you should use something like this instead:

FavoriteCollectionsModel* favs = getFavsModel();
Collection::List cols;
const int rowCount = favs->rowCount();
for (int row = 0; row < rowcount; ++row) {
  static const int column = 0;
  const QModelIndex index = favs->index(row, column);
  const Collection col = index.data(EntityTreeModel::CollectionRole).value<Collection>();
  cols << col;
}

Note that due to the asynchronous nature of the model, this method returns collection ids of collections which may not be in the model yet. If you want the ids of the collections that are actually in the model, use a loop similar to above with the CollectionIdRole.

Definition at line 317 of file favoritecollectionsmodel.cpp.

◆ collections()

Akonadi::Collection::List FavoriteCollectionsModel::collections ( ) const

nodiscard

Returns the list of favorite collections.

Deprecated: Use collectionIds instead.

Definition at line 305 of file favoritecollectionsmodel.cpp.

◆ data()

QVariant Akonadi::FavoriteCollectionsModel::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole ) const

nodiscardoverridevirtual

Reimplemented from QAbstractProxyModel.

Definition at line 338 of file favoritecollectionsmodel.cpp.

◆ defaultFavoriteLabel()

QString Akonadi::FavoriteCollectionsModel::defaultFavoriteLabel ( const Akonadi::Collection & col )

nodiscard

Definition at line 373 of file favoritecollectionsmodel.cpp.

◆ dropMimeData()

bool FavoriteCollectionsModel::dropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent )

nodiscardoverridevirtual

Reimplemented from QAbstractProxyModel.

Definition at line 404 of file favoritecollectionsmodel.cpp.

◆ favoriteLabel()

QString Akonadi::FavoriteCollectionsModel::favoriteLabel ( const Akonadi::Collection & col )

nodiscard

Return associate label for collection.

Definition at line 365 of file favoritecollectionsmodel.cpp.

◆ flags()

Qt::ItemFlags FavoriteCollectionsModel::flags ( const QModelIndex & index ) const

nodiscardoverridevirtual

Reimplemented from QAbstractProxyModel.

Definition at line 459 of file favoritecollectionsmodel.cpp.

◆ headerData()

QVariant FavoriteCollectionsModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = Qt::DisplayRole ) const

nodiscardoverridevirtual

Reimplemented from QAbstractProxyModel.

Definition at line 395 of file favoritecollectionsmodel.cpp.

◆ mimeTypes()

QStringList FavoriteCollectionsModel::mimeTypes ( ) const

nodiscardoverridevirtual

Reimplemented from QAbstractProxyModel.

Definition at line 450 of file favoritecollectionsmodel.cpp.

◆ removeCollection

void FavoriteCollectionsModel::removeCollection ( const Akonadi::Collection & collection )

slot

Removes a collection from the list of favorite collections.

Definition at line 299 of file favoritecollectionsmodel.cpp.

◆ setCollections

void FavoriteCollectionsModel::setCollections ( const Akonadi::Collection::List & collections )

slot

Sets the collections as favorite collections.

Definition at line 287 of file favoritecollectionsmodel.cpp.

◆ setData()

bool FavoriteCollectionsModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role = Qt::EditRole )

nodiscardoverridevirtual

Reimplemented from QAbstractProxyModel.

Definition at line 350 of file favoritecollectionsmodel.cpp.

◆ setFavoriteLabel

void Akonadi::FavoriteCollectionsModel::setFavoriteLabel	(	const Akonadi::Collection &	collection,
		const QString &	label )

slot

Sets a custom label that will be used when showing the favorite collection.

Definition at line 322 of file favoritecollectionsmodel.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Akonadi

Akonadi::FavoriteCollectionsModel

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FavoriteCollectionsModel()

◆ ~FavoriteCollectionsModel()

Member Function Documentation

◆ addCollection

◆ collectionIds()

◆ collections()

◆ data()

◆ defaultFavoriteLabel()

◆ dropMimeData()

◆ favoriteLabel()

◆ flags()

◆ headerData()

◆ mimeTypes()

◆ removeCollection

◆ setCollections

◆ setData()

◆ setFavoriteLabel