Akonadi Contacts

contactsearchjob.h
1 /*
2  This file is part of Akonadi Contact.
3 
4  Copyright (c) 2009 Tobias Koenig <[email protected]>
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 <itemsearchjob.h>
28 #include <kcontacts/addressee.h>
29 
30 namespace Akonadi {
77 class AKONADI_CONTACT_EXPORT ContactSearchJob : public ItemSearchJob
78 {
79  Q_OBJECT
80 
81 public:
87  explicit ContactSearchJob(QObject *parent = nullptr);
88 
93 
97  enum Criterion {
98  Name,
102  ContactUid
103  };
104 
110  enum Match {
114  ContainsWordBoundaryMatch
115  };
116 
124  void setQuery(Criterion criterion, const QString &value, Match match = ExactMatch);
125 
136  void setLimit(int limit);
137 
141  Q_REQUIRED_RESULT KContacts::Addressee::List contacts() const;
142 
143 private:
144  //@cond PRIVATE
145  class Private;
146  Private *const d;
147  //@endcond
148 };
149 }
150 
151 #endif
Match
Describes the type of pattern matching that shall be used.
The result must contain the pattern (case insensitive).
The nickname of the contact.
The name or email address of the contact.
The result must start with the pattern (case insensitive).
Job that searches for contacts in the Akonadi storage.
The email address of the contact.
AddresseeList List
Criterion
Describes the criteria that can be searched for.
The name of the contact.
The result must match exactly the pattern (case sensitive).
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Aug 5 2020 23:05:57 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.