#include <specialcollections.h>

Inheritance diagram for Akonadi::SpecialCollections:

Signals
void	collectionsChanged (const Akonadi::AgentInstance &instance)

void	defaultCollectionsChanged ()

Public Member Functions
	~SpecialCollections ()

Akonadi::Collection	collection (const QByteArray &type, const AgentInstance &instance) const

Akonadi::Collection	defaultCollection (const QByteArray &type) const

bool	hasCollection (const QByteArray &type, const AgentInstance &instance) const

bool	hasDefaultCollection (const QByteArray &type) const

bool	registerCollection (const QByteArray &type, const Akonadi::Collection &collection)

bool	unregisterCollection (const Collection &collection)

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

	QObject (QObject parent, const char name)

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Static Public Member Functions
static void	setSpecialCollectionType (const QByteArray &type, const Akonadi::Collection &collection)

static void	unsetSpecialCollection (const Akonadi::Collection &collection)

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

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)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions
	SpecialCollections (KCoreConfigSkeleton config, QObject parent=0)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

An interface to special collections.

This class is the central interface to special collections like inbox or outbox in a mail resource or recent contacts in a contacts resource. The class is not meant to be used directly, but to inherit the a type specific special collections class from it (e.g. SpecialMailCollections).

To check whether a special collection is available, simply use the hasCollection() and hasDefaultCollection() methods. Available special collections are accessible through the collection() and defaultCollection() methods.

To create a special collection, use a SpecialCollectionsRequestJob. This will create the special collections you request and automatically register them with SpecialCollections, so that it now knows they are available.

This class monitors all special collections known to it, and removes it from the known list if they are deleted. Note that this class does not automatically rebuild the collections that disappeared.

The defaultCollectionsChanged() and collectionsChanged() signals are emitted when the special collections for a resource change (i.e. some became available or some become unavailable).

Author: Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com

Since: 4.4

Definition at line 65 of file specialcollections.h.

Constructor & Destructor Documentation

SpecialCollections::~SpecialCollections ( )

Destroys the special collections object.

Definition at line 189 of file specialcollections.cpp.

SpecialCollections::SpecialCollections	(	KCoreConfigSkeleton *	config,
		QObject *	parent = `0`
	)

explicitprotected

Creates a new special collections object.

Parameters

config	The configuration skeleton that provides the default resource id.
parent	The parent object.

Definition at line 183 of file specialcollections.cpp.

Member Function Documentation

Akonadi::Collection SpecialCollections::collection	(	const QByteArray &	type,
		const AgentInstance &	instance
	)		const

Returns the special collection of the given type in the given agent instance, or an invalid collection if such a collection is unknown.

Definition at line 199 of file specialcollections.cpp.

void Akonadi::SpecialCollections::collectionsChanged ( const Akonadi::AgentInstance & instance )

signal

Emitted when the special collections for a resource have been changed (for example, some become available, or some become unavailable).

Parameters

instance The instance of the resource the collection belongs to.

Akonadi::Collection SpecialCollections::defaultCollection ( const QByteArray & type ) const

Returns the special collection of given type in the default resource, or an invalid collection if such a collection is unknown.

Definition at line 277 of file specialcollections.cpp.

void Akonadi::SpecialCollections::defaultCollectionsChanged ( )

signal

Emitted when the special collections for the default resource have been changed (for example, some become available, or some become unavailable).

bool SpecialCollections::hasCollection	(	const QByteArray &	type,
		const AgentInstance &	instance
	)		const

Returns whether the given agent instance has a special collection of the given type.

Definition at line 194 of file specialcollections.cpp.

bool SpecialCollections::hasDefaultCollection ( const QByteArray & type ) const

Returns whether the default resource has a special collection of the given type.

Definition at line 272 of file specialcollections.cpp.

bool SpecialCollections::registerCollection	(	const QByteArray &	type,
		const Akonadi::Collection &	collection
	)

Registers the given collection as a special collection with the given type.

Parameters

type	the special type of `collection`
collection	the given collection to register The collection must be owned by a valid resource. Registering a new collection of a previously registered type forgets the old collection.

Definition at line 244 of file specialcollections.cpp.

void SpecialCollections::setSpecialCollectionType	(	const QByteArray &	type,
		const Akonadi::Collection &	collection
	)

static

Sets the special collection attribute which marks collection as being a special collection of type type.

This is typically used by configuration dialog for resources, when the user can choose a specific special collection (ex: IMAP trash).

Since: 4.11

Definition at line 204 of file specialcollections.cpp.

bool SpecialCollections::unregisterCollection ( const Collection & collection )

Unregisters the given collection as a spec ial collection.

Parameters

type	the special type of `collection`

Since: 4.12

Definition at line 223 of file specialcollections.cpp.

void SpecialCollections::unsetSpecialCollection ( const Akonadi::Collection & collection )

static

unsets the special collection attribute which marks collection as being a special collection.

Since: 4.12

Definition at line 214 of file specialcollections.cpp.

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

akonadi

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

akonadi

kdepimlibs API Reference

Search