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

akonadi

  • 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
28using namespace Akonadi;
29
30class ContactGroupSearchJob::Private
31{
32 public:
33 int mLimit;
34};
35
36ContactGroupSearchJob::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
50ContactGroupSearchJob::~ContactGroupSearchJob()
51{
52 delete d;
53}
54
55void 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
62static 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
74void 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
86void ContactGroupSearchJob::setLimit( int limit )
87{
88 d->mLimit = limit;
89}
90
91KABC::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::Match
Match
Describes the type of pattern matching that shall be used.
Definition contactgroupsearchjob.h:88
Akonadi::ContactGroupSearchJob::ExactMatch
@ ExactMatch
The result must match exactly the pattern (case sensitive).
Definition contactgroupsearchjob.h:89
Akonadi::ContactGroupSearchJob::ContainsMatch
@ ContainsMatch
The result must contain the pattern (case insensitive).
Definition contactgroupsearchjob.h:91
Akonadi::ContactGroupSearchJob::StartsWithMatch
@ StartsWithMatch
The result must start with the pattern (case insensitive).
Definition contactgroupsearchjob.h:90
Akonadi::ContactGroupSearchJob::contactGroups
KABC::ContactGroup::List contactGroups() const
Returns the contact groups that matched the search criteria.
Definition contactgroupsearchjob.cpp:91
Akonadi::ContactGroupSearchJob::~ContactGroupSearchJob
~ContactGroupSearchJob()
Destroys the contact group search job.
Definition contactgroupsearchjob.cpp:50
Akonadi::ContactGroupSearchJob::setQuery
void setQuery(Criterion criterion, const QString &value)
Sets the criterion and value for the search.
Definition contactgroupsearchjob.cpp:55
Akonadi::ContactGroupSearchJob::Criterion
Criterion
Describes the criteria that can be searched for.
Definition contactgroupsearchjob.h:79
Akonadi::ContactGroupSearchJob::Name
@ Name
The name of the contact group.
Definition contactgroupsearchjob.h:80
Akonadi::ContactGroupSearchJob::ContactGroupSearchJob
ContactGroupSearchJob(QObject *parent=0)
Creates a new contact group search job.
Definition contactgroupsearchjob.cpp:36
Akonadi::ContactSearchTerm
A search term for a contact field.
Definition searchquery.h:250
Akonadi::ItemFetchScope::fetchFullPayload
void fetchFullPayload(bool fetch=true)
Sets whether the full payload shall be fetched.
Definition itemfetchscope.cpp:70
Akonadi::ItemSearchJob
Job that searches for items in the Akonadi storage.
Definition itemsearchjob.h:68
Akonadi::ItemSearchJob::setQuery
void AKONADI_DEPRECATED setQuery(const QString &query)
Sets the search query in Akonadi search metalanguage format (JSON)
Definition itemsearchjob.cpp:138
Akonadi::ItemSearchJob::fetchScope
ItemFetchScope & fetchScope()
Returns the item fetch scope.
Definition itemsearchjob.cpp:159
Akonadi::ItemSearchJob::setMimeTypes
void setMimeTypes(const QStringList &mimeTypes)
Search only for items of given mime types.
Definition itemsearchjob.cpp:178
Akonadi::ItemSearchJob::items
Item::List items() const
Returns the items that matched the search query.
Definition itemsearchjob.cpp:271
Akonadi::SearchQuery
A query that can be passed to ItemSearchJob or others.
Definition searchquery.h:129
Akonadi::SearchQuery::addTerm
void addTerm(const QString &key, const QVariant &value, SearchTerm::Condition condition=SearchTerm::CondEqual)
Adds a new term.
Definition searchquery.cpp:255
Akonadi::SearchQuery::setLimit
void setLimit(int limit)
Sets the maximum number of results.
Definition searchquery.cpp:270
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
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

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • 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