Akonadi

abstractsearchengine.h
1/*
2 SPDX-FileCopyrightText: 2008 Tobias Koenig <tokoe@kde.org>
3 SPDX-FileCopyrightText: 2010 Volker Krause <vkrause@kde.org>
4
5 SPDX-License-Identifier: LGPL-2.0-or-later
6*/
7
8#pragma once
9
10#include <QtGlobal>
11
12namespace Akonadi
13{
14namespace Server
15{
16class Collection;
17
18/**
19 * Abstract interface for search engines.
20 * Executed in the main thread. Must not block.
21 */
23{
24public:
25 virtual ~AbstractSearchEngine() = default;
26
27 /**
28 * Adds the given @p collection to the search.
29 */
30 virtual void addSearch(const Collection &collection) = 0;
31
32 /**
33 * Removes the collection with the given @p id from the search.
34 */
35 virtual void removeSearch(qint64 id) = 0;
36
37protected:
38 explicit AbstractSearchEngine() = default;
39
40private:
41 Q_DISABLE_COPY_MOVE(AbstractSearchEngine)
42};
43
44} // namespace Server
45} // namespace Akonadi
Represents a collection of PIM items.
Definition collection.h:62
Abstract interface for search engines.
virtual void addSearch(const Collection &collection)=0
Adds the given collection to the search.
virtual void removeSearch(qint64 id)=0
Removes the collection with the given id from the search.
Helper integration between Akonadi and Qt.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 7 2024 11:56:45 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.