/usr/include/akonadi/searchcreatejob.h is in kdepimlibs5-dev 4:4.8.5-0ubuntu0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | /*
Copyright (c) 2007 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_SEARCHCREATEJOB_H
#define AKONADI_SEARCHCREATEJOB_H
#include <akonadi/job.h>
namespace Akonadi {
class Collection;
class SearchCreateJobPrivate;
/**
* @short 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.
*
* @code
*
* 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();
* ...
* }
*
* @endcode
*
* @author Volker Krause <vkrause@kde.org>
*/
class AKONADI_EXPORT SearchCreateJob : public Job
{
Q_OBJECT
public:
/**
* Creates a search create job.
*
* @param name The name of the search collection.
* @param query The search query (format not defined yet).
* @param parent The parent object.
*/
SearchCreateJob( const QString &name, const QString &query, QObject *parent = 0 );
/**
* Sets the query language.
* @param queryLanguage The query language used.
* @since 4.6
*/
void setQueryLanguage( const QString &queryLanguage );
/**
* Destroys the search create job.
*/
~SearchCreateJob();
/**
* 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
*/
Collection createdCollection() const;
protected:
/**
* Reimplemented from Akonadi::Job
*/
void doStart();
/**
* Reimplemented from Akonadi::Job
*/
void doHandleResponse( const QByteArray &tag, const QByteArray &data );
private:
Q_DECLARE_PRIVATE( SearchCreateJob )
};
}
#endif
|