kmail

KMail::AnnotationJobs Namespace Reference


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.


Classes

class  GetAnnotationJob
 for getAnnotation() More...
class  MultiGetAnnotationJob
 for multiGetAnnotation 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)

Function Documentation

AnnotationJobs::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

Definition at line 50 of file annotationjobs.cpp.

AnnotationJobs::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.

Definition at line 133 of file annotationjobs.cpp.

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

Set multiple annotation entries.

Definition at line 181 of file annotationjobs.cpp.

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

Definition at line 37 of file annotationjobs.cpp.

KDE Home | KDE Accessibility Home | Description of Access Keys