• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • AgentSearchInterface
Public Member Functions
Akonadi::AgentSearchInterface Class Reference

An interface for agents (or resources) that support searching in their backend. More...

#include <agentsearchinterface.h>

List of all members.

Public Member Functions

 AgentSearchInterface ()
virtual ~AgentSearchInterface ()
virtual void addSearch (const QString &query, const QString &queryLanguage, const Akonadi::Collection &resultCollection)=0
virtual void removeSearch (const Akonadi::Collection &resultCollection)=0

Detailed Description

An interface for agents (or resources) that support searching in their backend.

Inherit from this additionally to Akonadi::AgentBase (or Akonadi::ResourceBase) and implement its two pure virtual methods.

Make sure to add the Search capability to the agent desktop file.

Since:
4.5

Definition at line 40 of file agentsearchinterface.h.


Constructor & Destructor Documentation

AgentSearchInterface::AgentSearchInterface ( )

Creates a new agent search interface.

Definition at line 46 of file agentsearchinterface.cpp.

AgentSearchInterface::~AgentSearchInterface ( ) [virtual]

Destroys the agent search interface.

Definition at line 51 of file agentsearchinterface.cpp.


Member Function Documentation

virtual void Akonadi::AgentSearchInterface::addSearch ( const QString &  query,
const QString &  queryLanguage,
const Akonadi::Collection &  resultCollection 
) [pure virtual]

Adds a new search.

Parameters:
queryThe query string, using the language specified in queryLanguage
queryLanguageThe query language used for query
resultCollectionThe destination collection for the search results. It's a virtual collection, results can be added/removed using Akonadi::LinkJob and Akonadi::UnlinkJob respectively.
virtual void Akonadi::AgentSearchInterface::removeSearch ( const Akonadi::Collection &  resultCollection) [pure virtual]

Removes a previously added search.

Parameters:
resultCollectionThe result collection given in an previous addSearch() call. You do not need to take care of deleting results in there, the collection is just provided as a way to identify the search.

The documentation for this class was generated from the following files:
  • agentsearchinterface.h
  • agentsearchinterface.cpp

akonadi

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal