Akonadi

searchcreatejob.h
1 /*
2  Copyright (c) 2007 Volker Krause <[email protected]>
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 "akonadicore_export.h"
24 #include "job.h"
25 #include "collection.h"
26 
27 namespace Akonadi
28 {
29 
30 class Collection;
31 class SearchQuery;
32 class SearchCreateJobPrivate;
33 
64 class AKONADICORE_EXPORT SearchCreateJob : public Job
65 {
66  Q_OBJECT
67 
68 public:
77  SearchCreateJob(const QString &name, const SearchQuery &searchQuery, QObject *parent = nullptr);
78 
85  void setSearchMimeTypes(const QStringList &mimeTypes);
86 
92  Q_REQUIRED_RESULT QStringList searchMimeTypes() const;
93 
103  void setSearchCollections(const QVector<Collection> &collections);
104 
110  Q_REQUIRED_RESULT QVector<Collection> searchCollections() const;
111 
132  void setRemoteSearchEnabled(bool enabled);
133 
139  Q_REQUIRED_RESULT bool isRemoteSearchEnabled() const;
140 
150  void setRecursive(bool recursive);
151 
157  Q_REQUIRED_RESULT bool isRecursive() const;
158 
162  ~SearchCreateJob() override;
163 
170  Q_REQUIRED_RESULT Collection createdCollection() const;
171 
172 protected:
176  void doStart() override;
177 
181  bool doHandleResponse(qint64 tag, const Protocol::CommandPtr &response) override;
182 
183 private:
184  Q_DECLARE_PRIVATE(SearchCreateJob)
185 };
186 
187 }
188 
189 #endif
Job that creates a virtual/search collection in the Akonadi storage.
Represents a collection of PIM items.
Definition: collection.h:76
Base class for all actions in the Akonadi storage.
Definition: job.h:93
A query that can be passed to ItemSearchJob or others.
Definition: searchquery.h:128
Helper integration between Akonadi and Qt.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed May 27 2020 22:43:40 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.