Akonadi Contacts

contactgroupsearchjob.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_CONTACTGROUPSEARCHJOB_H
23 #define AKONADI_CONTACTGROUPSEARCHJOB_H
24 
25 #include "akonadi-contact_export.h"
26 
27 #include <item.h>
28 #include <itemsearchjob.h>
29 #include <kcontacts/contactgroup.h>
30 
31 namespace Akonadi {
58 class AKONADI_CONTACT_EXPORT ContactGroupSearchJob : public ItemSearchJob
59 {
60  Q_OBJECT
61 
62 public:
68  explicit ContactGroupSearchJob(QObject *parent = nullptr);
69 
74 
78  enum Criterion {
79  Name
80  };
81 
87  enum Match {
90  ContainsMatch
91  };
92 
96  void setQuery(Criterion criterion, const QString &value);
97 
105  void setQuery(Criterion criterion, const QString &value, Match match);
106 
118  void setLimit(int limit);
119 
123  Q_REQUIRED_RESULT KContacts::ContactGroup::List contactGroups() const;
124 
125 private:
126  //@cond PRIVATE
127  class Private;
128  Private *const d;
129  //@endcond
130 };
131 }
132 
133 #endif
Criterion
Describes the criteria that can be searched for.
The result must start with the pattern (case insensitive).
Match
Describes the type of pattern matching that shall be used.
Job that searches for contact groups in the Akonadi storage.
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.