KMail::AnnotationJobs Namespace Reference

Classes
class	GetAnnotationJob
class	MultiGetAnnotationJob
class	MultiUrlGetAnnotationJob
class	MultiSetAnnotationJob

Functions
TDEIO::SimpleJob *	setAnnotation (TDEIO::Slave *slave, const KURL &url, const TQString &entry, const TQMap< TQString, TQString > &attributes)
MultiSetAnnotationJob *	multiSetAnnotation (TDEIO::Slave *slave, const KURL &url, const AnnotationList &annotations)
GetAnnotationJob *	getAnnotation (TDEIO::Slave *slave, const KURL &url, const TQString &entry, const TQStringList &attributes)
MultiGetAnnotationJob *	multiGetAnnotation (TDEIO::Slave *slave, const KURL &url, const TQStringList &entries)
MultiUrlGetAnnotationJob *	multiUrlGetAnnotation (TDEIO::Slave *slave, const KURL &baseUrl, const TQStringList &paths, const TQString &annotation)

Detailed Description

This namespace contains functions that return jobs for annotation operations.

The current implementation is tied to IMAP. If someone wants to extend this to other protocols, turn the namespace into a class and use virtual methods.

Function Documentation

getAnnotation()

AnnotationJobs::GetAnnotationJob * KMail::AnnotationJobs::getAnnotation	(	TDEIO::Slave *	slave,
		const KURL &	url,
		const TQString &	entry,
		const TQStringList &	attributes
	)

Get an annotation entry.

Parameters

slave	Slave object the job should be assigned to
url	URL for the annotation
entry	the name of the annotation entry
attributes	attribute names

Definition at line 50 of file annotationjobs.cpp.

multiGetAnnotation()

AnnotationJobs::MultiGetAnnotationJob * KMail::AnnotationJobs::multiGetAnnotation	(	TDEIO::Slave *	slave,
		const KURL &	url,
		const TQStringList &	entries
	)

Get multiple annotation entries Currently we assume we want to get the "value" for each, to simplify the data structure.

Definition at line 133 of file annotationjobs.cpp.

multiSetAnnotation()

AnnotationJobs::MultiSetAnnotationJob * KMail::AnnotationJobs::multiSetAnnotation	(	TDEIO::Slave *	slave,
		const KURL &	url,
		const AnnotationList &	annotations
	)

Set multiple annotation entries.

Definition at line 181 of file annotationjobs.cpp.

multiUrlGetAnnotation()

AnnotationJobs::MultiUrlGetAnnotationJob * KMail::AnnotationJobs::multiUrlGetAnnotation	(	TDEIO::Slave *	slave,
		const KURL &	baseUrl,
		const TQStringList &	paths,
		const TQString &	annotation
	)

Get annotation entries for multiple folders.

Parameters

paths	The paths to get the annotation for
annotation	The annotation to get

Definition at line 244 of file annotationjobs.cpp.

setAnnotation()

TDEIO::SimpleJob * KMail::AnnotationJobs::setAnnotation	(	TDEIO::Slave *	slave,
		const KURL &	url,
		const TQString &	entry,
		const TQMap< TQString, TQString > &	attributes
	)

Set an annotation entry (note that it can have multiple attributes)

Parameters

slave	Slave object the job should be assigned to
url	URL for the annotation
entry	the name of the annotation entry
attributes	attribute name+value pairs

Definition at line 37 of file annotationjobs.cpp.