akonadi
#include <collectionpathresolver_p.h>

Public Member Functions | |
CollectionPathResolver (const Collection &collection, QObject *parent=0) | |
CollectionPathResolver (const QString &path, const Collection &parentCollection, QObject *parent=0) | |
CollectionPathResolver (const QString &path, QObject *parent=0) | |
~CollectionPathResolver () | |
Collection::Id | collection () const |
QString | path () const |
![]() | |
Job (QObject *parent=0) | |
virtual | ~Job () |
virtual QString | errorString () const |
void | start () |
Static Public Member Functions | |
static QString | pathDelimiter () |
Protected Member Functions | |
void | doStart () |
![]() | |
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 | |
![]() | |
enum | Error { ConnectionFailed = UserDefinedError , ProtocolVersionMismatch , UserCanceled , Unknown , UserError = UserDefinedError + 42 } |
typedef QList< Job * > | List |
![]() | |
void | aboutToStart (Akonadi::Job *job) |
void | writeFinished (Akonadi::Job *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.
Definition at line 42 of file collectionpathresolver_p.h.
Constructor & Destructor Documentation
◆ CollectionPathResolver() [1/3]
|
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.
◆ CollectionPathResolver() [2/3]
|
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
◆ CollectionPathResolver() [3/3]
|
explicit |
Creates a new collection path resolver to determine the path of the given collection.
- Parameters
-
collection The collection. parent The parent object.
◆ ~CollectionPathResolver()
Akonadi::CollectionPathResolver::~CollectionPathResolver | ( | ) |
Destroys the collection path resolver.
Member Function Documentation
◆ collection()
Collection::Id Akonadi::CollectionPathResolver::collection | ( | ) | const |
Returns the collection id.
Only valid after the job succeeded.
◆ 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.
◆ path()
QString Akonadi::CollectionPathResolver::path | ( | ) | const |
Returns the collection path.
Only valid after the job succeeded.
◆ pathDelimiter()
|
static |
Returns the path delimiter for collections.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.