• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • akonadi
searchcreatejob.h
1/*
2 Copyright (c) 2007 Volker Krause <vkrause@kde.org>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef AKONADI_SEARCHCREATEJOB_H
21#define AKONADI_SEARCHCREATEJOB_H
22
23#include <akonadi/job.h>
24#include "collection.h"
25
26namespace Akonadi {
27
28class Collection;
29class SearchQuery;
30class SearchCreateJobPrivate;
31
62class AKONADI_EXPORT SearchCreateJob : public Job
63{
64 Q_OBJECT
65
66public:
75 AKONADI_DEPRECATED SearchCreateJob(const QString &name, const QString &query, QObject *parent = 0);
76
85 SearchCreateJob(const QString &name, const SearchQuery &searchQuery, QObject *parent = 0);
86
94 AKONADI_DEPRECATED void setQueryLanguage(const QString &queryLanguage);
95
102 void setSearchMimeTypes(const QStringList &mimeTypes);
103
109 QStringList searchMimeTypes() const;
110
120 void setSearchCollections(const Collection::List &collections);
121
127 Collection::List searchCollections() const;
128
149 void setRemoteSearchEnabled(bool enabled);
150
156 bool isRemoteSearchEnabled() const;
157
167 void setRecursive(bool recursive);
168
174 bool isRecursive() const;
175
179 ~SearchCreateJob();
180
187 Collection createdCollection() const;
188
189protected:
193 void doStart();
194
198 void doHandleResponse(const QByteArray &tag, const QByteArray &data);
199
200private:
201 Q_DECLARE_PRIVATE(SearchCreateJob)
202};
203
204}
205
206#endif
Akonadi::Collection
Represents a collection of PIM items.
Definition collection.h:76
Akonadi::Collection::List
QList< Collection > List
Describes a list of collections.
Definition collection.h:81
Akonadi::Job::Job
Job(QObject *parent=0)
Creates a new job.
Definition job.cpp:259
Akonadi::SearchCreateJob::SearchCreateJob
AKONADI_DEPRECATED SearchCreateJob(const QString &name, const QString &query, QObject *parent=0)
Creates a search create job.
Definition searchcreatejob.cpp:54
Akonadi::SearchCreateJob::doHandleResponse
void doHandleResponse(const QByteArray &tag, const QByteArray &data)
Reimplemented from Akonadi::Job.
Definition searchcreatejob.cpp:159
Akonadi::SearchCreateJob::createdCollection
Collection createdCollection() const
Returns the newly created search collection once the job finished successfully.
Definition searchcreatejob.cpp:153
Akonadi::SearchCreateJob::setSearchMimeTypes
void setSearchMimeTypes(const QStringList &mimeTypes)
Sets list of mime types of items that search results can contain.
Definition searchcreatejob.cpp:85
Akonadi::SearchCreateJob::searchMimeTypes
QStringList searchMimeTypes() const
Returns list of mime types that search results can contain.
Definition searchcreatejob.cpp:92
Akonadi::SearchCreateJob::setQueryLanguage
AKONADI_DEPRECATED void setQueryLanguage(const QString &queryLanguage)
Sets the query language.
Definition searchcreatejob.cpp:68
Akonadi::SearchCreateJob::searchCollections
Collection::List searchCollections() const
Returns list of collections to search in.
Definition searchcreatejob.cpp:80
Akonadi::SearchCreateJob::isRecursive
bool isRecursive() const
Returns whether the search is recursive.
Definition searchcreatejob.cpp:104
Akonadi::SearchCreateJob::doStart
void doStart()
Reimplemented from Akonadi::Job.
Definition searchcreatejob.cpp:121
Akonadi::SearchCreateJob::setRemoteSearchEnabled
void setRemoteSearchEnabled(bool enabled)
Sets whether resources should be queried too.
Definition searchcreatejob.cpp:109
Akonadi::SearchCreateJob::setRecursive
void setRecursive(bool recursive)
Sets whether the search should recurse into collections.
Definition searchcreatejob.cpp:97
Akonadi::SearchCreateJob::isRemoteSearchEnabled
bool isRemoteSearchEnabled() const
Returns whether remote search is enabled.
Definition searchcreatejob.cpp:116
Akonadi::SearchCreateJob::setSearchCollections
void setSearchCollections(const Collection::List &collections)
Sets list of collections to search in.
Definition searchcreatejob.cpp:73
Akonadi::SearchQuery
A query that can be passed to ItemSearchJob or others.
Definition searchquery.h:129
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

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

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal