kmail Library API Documentation

KMail::AnnotationJobs Namespace Reference

This namespace contains functions that return jobs for annotation operations. More...


Classes

class  GetAnnotationJob
 for getAnnotation() More...
class  MultiGetAnnotationJob
 for multiGetAnnotation More...
class  MultiUrlGetAnnotationJob
 for multiUrlGetAnnotation More...
class  MultiSetAnnotationJob
 for multiSetAnnotation More...

Functions

KIO::SimpleJob * setAnnotation (KIO::Slave *slave, const KURL &url, const QString &entry, const QMap< QString, QString > &attributes)
MultiSetAnnotationJobmultiSetAnnotation (KIO::Slave *slave, const KURL &url, const AnnotationList &annotations)
GetAnnotationJobgetAnnotation (KIO::Slave *slave, const KURL &url, const QString &entry, const QStringList &attributes)
MultiGetAnnotationJobmultiGetAnnotation (KIO::Slave *slave, const KURL &url, const QStringList &entries)
MultiUrlGetAnnotationJobmultiUrlGetAnnotation (KIO::Slave *slave, const KURL &baseUrl, const QStringList &paths, const QString &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

KIO::SimpleJob* KMail::AnnotationJobs::setAnnotation KIO::Slave *  slave,
const KURL &  url,
const QString entry,
const QMap< QString, QString > &  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

MultiSetAnnotationJob* KMail::AnnotationJobs::multiSetAnnotation KIO::Slave *  slave,
const KURL &  url,
const AnnotationList &  annotations
 

Set multiple annotation entries.

GetAnnotationJob* KMail::AnnotationJobs::getAnnotation KIO::Slave *  slave,
const KURL &  url,
const QString entry,
const QStringList 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

MultiGetAnnotationJob* KMail::AnnotationJobs::multiGetAnnotation KIO::Slave *  slave,
const KURL &  url,
const QStringList entries
 

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

MultiUrlGetAnnotationJob* KMail::AnnotationJobs::multiUrlGetAnnotation KIO::Slave *  slave,
const KURL &  baseUrl,
const QStringList paths,
const QString annotation
 

Get annotation entries for multiple folders.

Parameters:
paths The paths to get the annotation for
annotation The annotation to get

KDE Logo
This file is part of the documentation for kmail Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 23 18:22:02 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003