akonadi
#include <searchcreatejob.h>

Public Member Functions | |
SearchCreateJob (const QString &name, const QString &query, QObject *parent=0) | |
~SearchCreateJob () | |
Collection | createdCollection () const |
void | setQueryLanguage (const QString &queryLanguage) |
Protected Member Functions | |
void | doHandleResponse (const QByteArray &tag, const QByteArray &data) |
void | doStart () |
Detailed Description
Job that creates a virtual/search collection in the Akonadi storage.
This job creates so called virtual or search collections, which don't contain real data, but references to items that match a given search query.
const QString name = "My search folder"; const QString query = "..."; Akonadi::SearchCreateJob *job = new Akonadi::SearchCreateJob( name, query ); connect( job, SIGNAL( result( KJob* ) ), SLOT( jobFinished( KJob* ) ) ); MyClass::jobFinished( KJob *job ) { if ( job->error() ) { qDebug() << "Error occurred"; return; } qDebug() << "Created search folder successfully"; const Collection searchCollection = job->createdCollection(); ... }
Constructor & Destructor Documentation
SearchCreateJob::SearchCreateJob | ( | const QString & | name, |
const QString & | query, | ||
QObject * | parent = 0 |
||
) |
Creates a search create job.
- Parameters:
-
name The name of the search collection. query The search query (format not defined yet). parent The parent object.
Definition at line 45 of file searchcreatejob.cpp.
SearchCreateJob::~SearchCreateJob | ( | ) |
Destroys the search create job.
Definition at line 54 of file searchcreatejob.cpp.
Member Function Documentation
Akonadi::Collection SearchCreateJob::createdCollection | ( | ) | const |
Returns the newly created search collection once the job finished successfully.
Returns an invalid collection if the job has not yet finished or failed.
- Since:
- 4.4
Definition at line 81 of file searchcreatejob.cpp.
void Akonadi::SearchCreateJob::doHandleResponse | ( | const QByteArray & | tag, |
const QByteArray & | data | ||
) | [protected, virtual] |
Reimplemented from Akonadi::Job.
Reimplemented from Akonadi::Job.
void Akonadi::SearchCreateJob::doStart | ( | ) | [protected, virtual] |
Reimplemented from Akonadi::Job.
Implements Akonadi::Job.
void SearchCreateJob::setQueryLanguage | ( | const QString & | queryLanguage | ) |
Sets the query language.
- Parameters:
-
queryLanguage The query language used.
- Since:
- 4.6
Definition at line 58 of file searchcreatejob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon May 14 2012 04:53:12 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.