• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • CollectionPathResolver
Public Member Functions | Static Public Member Functions | Protected Member Functions
Akonadi::CollectionPathResolver Class Reference

#include <collectionpathresolver_p.h>

Inheritance diagram for Akonadi::CollectionPathResolver:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CollectionPathResolver (const QString &path, QObject *parent=0)
 CollectionPathResolver (const Collection &collection, QObject *parent=0)
 ~CollectionPathResolver ()
Collection::Id collection () const
QString path () const

Static Public Member Functions

static QString pathDelimiter ()

Protected Member Functions

void doStart ()

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 <vkrause@kde.org>

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.

Parameters:
pathThe collection path.
parentThe parent object.
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:
collectionThe collection.
parentThe 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 ( ) [protected, virtual]

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

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal