Akonadi::CollectionPathResolver Class Reference

#include <collectionpathresolver_p.h>

Inheritance diagram for Akonadi::CollectionPathResolver:

Public Member Functions
	CollectionPathResolver (const QString &path, QObject *parent=0)
	CollectionPathResolver (const QString &path, const Collection &parentCollection, QObject *parent=0)
	CollectionPathResolver (const Collection &collection, QObject *parent=0)
	~CollectionPathResolver ()
Collection::Id	collection () const
QString	path () const
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Static Public Member Functions
static QString	pathDelimiter ()

Protected Member Functions
void	doStart ()
Protected Member Functions inherited from Akonadi::Job
virtual bool	addSubjob (KJob *job)
virtual void	doHandleResponse (const QByteArray &tag, const QByteArray &data)
virtual bool	doKill ()
void	emitWriteFinished ()
virtual bool	removeSubjob (KJob *job)

Additional Inherited Members
Public Types inherited from Akonadi::Job
enum	Error {   ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,   UserError = UserDefinedError + 42 }
typedef QList< Job * >	List
Signals inherited from Akonadi::Job
void	aboutToStart (Akonadi::Job *job)
void	writeFinished (Akonadi::Job *job)
Protected Slots inherited from Akonadi::Job
virtual void	slotResult (KJob *job)

Detailed Description

Converts between collection id and collection path.

While it is generally recommended to use collection ids, it can be necessary in some cases (eg. a command line client) to use the collection path instead. Use this class to get a collection id from a collection path.

Author

Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 42 of file collectionpathresolver_p.h.

Constructor & Destructor Documentation

Akonadi::CollectionPathResolver::CollectionPathResolver ( const QString &  path, QObject *  parent = 0  )

explicit

Creates a new collection path resolver to convert a path into a id.

Equivalent to calling CollectionPathResolver(path, Collection:root(), parent)

Parameters

path	The collection path.
parent	The parent object.

Akonadi::CollectionPathResolver::CollectionPathResolver ( const QString &  path, const Collection &  parentCollection, QObject *  parent = 0  )

explicit

Create a new collection path resolver to convert a path into an id.

The path is resolved relatively to parentCollection. This can be useful for resource, which now the root collection.

Parameters

path	The collection path.
parentCollection	Collection relatively to which the path will be resolved.
parent	The parent object.

Since

4.14

Akonadi::CollectionPathResolver::CollectionPathResolver ( const Collection &  collection, QObject *  parent = 0  )

explicit

Creates a new collection path resolver to determine the path of the given collection.

Parameters

collection	The collection.
parent	The parent object.

Akonadi::CollectionPathResolver::~CollectionPathResolver

(

)

Destroys the collection path resolver.

Member Function Documentation

Collection::Id Akonadi::CollectionPathResolver::collection

(

)

const

Returns the collection id.

Only valid after the job succeeded.

void Akonadi::CollectionPathResolver::doStart ( )

protectedvirtual

This method must be reimplemented in the concrete jobs.

It will be called after the job has been started and a connection to the Akonadi backend has been established.

Implements Akonadi::Job.

QString Akonadi::CollectionPathResolver::path

(

)

const

Returns the collection path.

Only valid after the job succeeded.

static QString Akonadi::CollectionPathResolver::pathDelimiter ( )

static

Returns the path delimiter for collections.

---

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

• collectionpathresolver_p.h