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

akonadi/contact

  • sources
  • kde-4.14
  • kdepimlibs
  • akonadi
  • contact
contactgroupsearchjob.cpp
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 #include "contactgroupsearchjob.h"
23 
24 #include <searchquery.h>
25 #include <akonadi/itemfetchscope.h>
26 #include <QStringList>
27 
28 using namespace Akonadi;
29 
30 class ContactGroupSearchJob::Private
31 {
32  public:
33  int mLimit;
34 };
35 
36 ContactGroupSearchJob::ContactGroupSearchJob( QObject * parent )
37  : ItemSearchJob( QString(), parent ), d( new Private )
38 {
39  fetchScope().fetchFullPayload();
40  d->mLimit = -1;
41 
42  setMimeTypes( QStringList() << KABC::ContactGroup::mimeType() );
43 
44  // by default search for all contact groups
45  Akonadi::SearchQuery query;
46  query.addTerm( ContactSearchTerm(ContactSearchTerm::All, QVariant(), SearchTerm::CondEqual) );
47  ItemSearchJob::setQuery( query );
48 }
49 
50 ContactGroupSearchJob::~ContactGroupSearchJob()
51 {
52  delete d;
53 }
54 
55 void ContactGroupSearchJob::setQuery( Criterion criterion, const QString &value )
56 {
57  // Exact match was the default in 4.4, so we have to keep it and ContactSearchJob has something
58  // else as default
59  setQuery( criterion, value, ExactMatch );
60 }
61 
62 static Akonadi::SearchTerm::Condition matchType( ContactGroupSearchJob::Match match )
63 {
64  switch( match ) {
65  case ContactGroupSearchJob::ExactMatch:
66  return Akonadi::SearchTerm::CondEqual;
67  case ContactGroupSearchJob::StartsWithMatch:
68  case ContactGroupSearchJob::ContainsMatch:
69  return Akonadi::SearchTerm::CondContains;
70  }
71  return Akonadi::SearchTerm::CondEqual;
72 }
73 
74 void ContactGroupSearchJob::setQuery( Criterion criterion, const QString &value, Match match )
75 {
76  Akonadi::SearchQuery query;
77  if ( criterion == Name ) {
78  query.addTerm(ContactSearchTerm(ContactSearchTerm::Name, value, matchType(match)));
79  }
80 
81  query.setLimit( d->mLimit );
82 
83  ItemSearchJob::setQuery( query );
84 }
85 
86 void ContactGroupSearchJob::setLimit( int limit )
87 {
88  d->mLimit = limit;
89 }
90 
91 KABC::ContactGroup::List ContactGroupSearchJob::contactGroups() const
92 {
93  KABC::ContactGroup::List contactGroups;
94 
95  foreach ( const Item &item, items() ) {
96  if ( item.hasPayload<KABC::ContactGroup>() ) {
97  contactGroups.append( item.payload<KABC::ContactGroup>() );
98  }
99  }
100 
101  return contactGroups;
102 }
103 
Akonadi::ContactGroupSearchJob::setLimit
void setLimit(int limit)
Sets a limit on how many results will be returned by this search job.
Definition: contactgroupsearchjob.cpp:86
Akonadi::ContactGroupSearchJob::Criterion
Criterion
Describes the criteria that can be searched for.
Definition: contactgroupsearchjob.h:79
Akonadi::ContactGroupSearchJob::setQuery
void setQuery(Criterion criterion, const QString &value)
Sets the criterion and value for the search.
Definition: contactgroupsearchjob.cpp:55
Akonadi::ContactGroupSearchJob::StartsWithMatch
The result must start with the pattern (case insensitive).
Definition: contactgroupsearchjob.h:90
Akonadi::ContactGroupSearchJob::ContactGroupSearchJob
ContactGroupSearchJob(QObject *parent=0)
Creates a new contact group search job.
Definition: contactgroupsearchjob.cpp:36
Akonadi::ContactGroupSearchJob::Match
Match
Describes the type of pattern matching that shall be used.
Definition: contactgroupsearchjob.h:88
QObject
QString
Akonadi::ContactGroupSearchJob::ExactMatch
The result must match exactly the pattern (case sensitive).
Definition: contactgroupsearchjob.h:89
QStringList
Akonadi::ContactGroupSearchJob::~ContactGroupSearchJob
~ContactGroupSearchJob()
Destroys the contact group search job.
Definition: contactgroupsearchjob.cpp:50
Akonadi::ContactGroupSearchJob::ContainsMatch
The result must contain the pattern (case insensitive).
Definition: contactgroupsearchjob.h:91
Akonadi::ContactGroupSearchJob::Name
The name of the contact group.
Definition: contactgroupsearchjob.h:80
Akonadi::ContactGroupSearchJob::contactGroups
KABC::ContactGroup::List contactGroups() const
Returns the contact groups that matched the search criteria.
Definition: contactgroupsearchjob.cpp:91
QVariant
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:19 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs 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

Search



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