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

akonadi/contact

  • akonadi
  • contact
contactsearchjob.h
1/*
2 This file is part of Akonadi Contact.
3
4 Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>
5
6 This library is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Library General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or (at your
9 option) any later version.
10
11 This library is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
14 License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301, USA.
20*/
21
22#ifndef AKONADI_CONTACTSEARCHJOB_H
23#define AKONADI_CONTACTSEARCHJOB_H
24
25#include "akonadi-contact_export.h"
26
27#include <akonadi/item.h>
28#include <akonadi/itemsearchjob.h>
29#include <kabc/addressee.h>
30
31namespace Akonadi {
32
79class AKONADI_CONTACT_EXPORT ContactSearchJob : public ItemSearchJob
80{
81 Q_OBJECT
82
83 public:
89 explicit ContactSearchJob( QObject *parent = 0 );
90
94 ~ContactSearchJob();
95
99 enum Criterion {
100 Name,
101 Email,
102 NickName,
103 NameOrEmail,
104 ContactUid
105 };
106
112 enum Match {
113 ExactMatch,
114 StartsWithMatch,
115 ContainsMatch,
116 ContainsWordBoundaryMatch
117 };
118
126 void setQuery( Criterion criterion, const QString &value );
127
135 void setQuery( Criterion criterion, const QString &value, Match match );
136
147 void setLimit( int limit );
148
152 KABC::Addressee::List contacts() const;
153
154 private:
155 //@cond PRIVATE
156 class Private;
157 Private* const d;
158 //@endcond
159};
160
161}
162
163#endif
Akonadi::ContactSearchJob
Job that searches for contacts in the Akonadi storage.
Definition contactsearchjob.h:80
Akonadi::ContactSearchJob::Match
Match
Describes the type of pattern matching that shall be used.
Definition contactsearchjob.h:112
Akonadi::ContactSearchJob::ExactMatch
@ ExactMatch
The result must match exactly the pattern (case sensitive).
Definition contactsearchjob.h:113
Akonadi::ContactSearchJob::StartsWithMatch
@ StartsWithMatch
The result must start with the pattern (case insensitive).
Definition contactsearchjob.h:114
Akonadi::ContactSearchJob::ContainsMatch
@ ContainsMatch
The result must contain the pattern (case insensitive).
Definition contactsearchjob.h:115
Akonadi::ContactSearchJob::Criterion
Criterion
Describes the criteria that can be searched for.
Definition contactsearchjob.h:99
Akonadi::ContactSearchJob::Name
@ Name
The name of the contact.
Definition contactsearchjob.h:100
Akonadi::ContactSearchJob::NameOrEmail
@ NameOrEmail
The name or email address of the contact.
Definition contactsearchjob.h:103
Akonadi::ContactSearchJob::Email
@ Email
The email address of the contact.
Definition contactsearchjob.h:101
Akonadi::ContactSearchJob::NickName
@ NickName
The nickname of the contact.
Definition contactsearchjob.h:102
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi/contact

Skip menu "akonadi/contact"
  • Main Page
  • 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