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

akonadi

  • akonadi
agentsearchinterface.h
1/*
2 Copyright (c) 2009 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_AGENTSEARCHINTERFACE_H
21#define AKONADI_AGENTSEARCHINTERFACE_H
22
23#include "akonadi_export.h"
24#include <QString>
25
26namespace Akonadi {
27
28class Collection;
29class AgentSearchInterfacePrivate;
30class ImapSet;
31
42class AKONADI_EXPORT AgentSearchInterface
43{
44public:
45 enum ResultScope {
46 Uid,
47 Rid
48 };
49
53 AgentSearchInterface();
54
58 virtual ~AgentSearchInterface();
59
68 virtual void addSearch(const QString &query, const QString &queryLanguage, const Akonadi::Collection &resultCollection) = 0;
69
76 virtual void removeSearch(const Akonadi::Collection &resultCollection) = 0;
77
83 virtual void search(const QString &query, const Collection &collection) = 0;
84
85 void searchFinished(const QVector<qint64> result, ResultScope scope);
86 void searchFinished(const ImapSet &result, ResultScope scope);
87 void searchFinished(const QVector<QByteArray> &result);
88private:
89 //@cond PRIVATE
90 AgentSearchInterfacePrivate *const d;
91 //@endcond
92};
93
94}
95
96#endif
Akonadi::AgentSearchInterface
An interface for agents (or resources) that support searching in their backend.
Definition: agentsearchinterface.h:43
Akonadi::AgentSearchInterface::addSearch
virtual void addSearch(const QString &query, const QString &queryLanguage, const Akonadi::Collection &resultCollection)=0
Adds a new search.
Akonadi::AgentSearchInterface::removeSearch
virtual void removeSearch(const Akonadi::Collection &resultCollection)=0
Removes a previously added search.
Akonadi::AgentSearchInterface::search
virtual void search(const QString &query, const Collection &collection)=0
Perform a search on remote storage and return results using SearchResultJob.
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:76
Akonadi
FreeBusyManager::Singleton.
Definition: actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 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
  • Modules
  • 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