Akonadi::SpecialCollections

#include <specialcollections.h>

Inheritance diagram for Akonadi::SpecialCollections:

[legend]

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

void	defaultCollectionsChanged ()

Public Member Functions
	~SpecialCollections () override

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)

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

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
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)

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

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 QObject
typedef	QObjectList

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 51 of file specialcollections.h.

Constructor & Destructor Documentation

◆ ~SpecialCollections()

SpecialCollections::~SpecialCollections ( )

overridedefault

Destroys the special collections object.

◆ SpecialCollections()

SpecialCollections::SpecialCollections	(	KCoreConfigSkeleton *	config,
		QObject *	parent = nullptr )

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 170 of file specialcollections.cpp.

Member Function Documentation

◆ collection()

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

nodiscard

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 183 of file specialcollections.cpp.

◆ collectionsChanged

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.

◆ defaultCollection()

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

nodiscard

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

Definition at line 261 of file specialcollections.cpp.

◆ defaultCollectionsChanged

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).

◆ hasCollection()

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

nodiscard

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

Definition at line 178 of file specialcollections.cpp.

◆ hasDefaultCollection()

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

nodiscard

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

Definition at line 256 of file specialcollections.cpp.

◆ registerCollection()

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 228 of file specialcollections.cpp.

◆ setSpecialCollectionType()

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 188 of file specialcollections.cpp.

◆ unregisterCollection()

bool SpecialCollections::unregisterCollection ( const Collection & collection )

Unregisters the given collection as a special collection.

Parameters

type	the special type of `collection`

Since: 4.12

Definition at line 207 of file specialcollections.cpp.

◆ unsetSpecialCollection()

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 198 of file specialcollections.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::SpecialCollections

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SpecialCollections()

◆ SpecialCollections()

Member Function Documentation

◆ collection()

◆ collectionsChanged

◆ defaultCollection()

◆ defaultCollectionsChanged

◆ hasCollection()

◆ hasDefaultCollection()

◆ registerCollection()

◆ setSpecialCollectionType()

◆ unregisterCollection()

◆ unsetSpecialCollection()