akonadi
#include <contactgroupsearchjob.h>

Public Types | |
enum | Criterion { Name } |
enum | Match { ExactMatch, StartsWithMatch, ContainsMatch } |
Public Member Functions | |
ContactGroupSearchJob (QObject *parent=0) | |
~ContactGroupSearchJob () | |
KABC::ContactGroup::List | contactGroups () const |
void | setLimit (int limit) |
void | setQuery (Criterion criterion, const QString &value) |
void | setQuery (Criterion criterion, const QString &value, Match match) |
Detailed Description
Job that searches for contact groups in the Akonadi storage.
This job searches for contact groups that match given search criteria and returns the list of contact groups.
Akonadi::ContactGroupSearchJob *job = new Akonadi::ContactGroupSearchJob(); job->setQuery( Akonadi::ContactGroupSearchJob::Name, "Family Members" ); connect( job, SIGNAL( result( KJob* ) ), this, SLOT( searchResult( KJob* ) ) ); ... MyClass::searchResult( KJob *job ) { Akonadi::ContactGroupSearchJob *searchJob = qobject_cast<Akonadi::ContactGroupSearchJob*>( job ); const KABC::ContactGroup::List contactGroups = searchJob->contactGroups(); // do something with the contact groups }
- Since:
- 4.4
Definition at line 59 of file contactgroupsearchjob.h.
Member Enumeration Documentation
enum Akonadi::ContactGroupSearchJob::Criterion |
Describes the criteria that can be searched for.
Definition at line 79 of file contactgroupsearchjob.h.
enum Akonadi::ContactGroupSearchJob::Match |
Describes the type of pattern matching that shall be used.
- Since:
- 4.5
- Enumerator:
Definition at line 89 of file contactgroupsearchjob.h.
Constructor & Destructor Documentation
Akonadi::ContactGroupSearchJob::ContactGroupSearchJob | ( | QObject * | parent = 0 | ) | [explicit] |
Creates a new contact group search job.
- Parameters:
-
parent The parent object.
Akonadi::ContactGroupSearchJob::~ContactGroupSearchJob | ( | ) |
Destroys the contact group search job.
Member Function Documentation
KABC::ContactGroup::List Akonadi::ContactGroupSearchJob::contactGroups | ( | ) | const |
Returns the contact groups that matched the search criteria.
void Akonadi::ContactGroupSearchJob::setLimit | ( | int | limit | ) |
Sets a limit
on how many results will be returned by this search job.
This is useful in situation where for example only the first search result is needed anyway, setting a limit of 1 here will greatly reduce the resource usage of Nepomuk during the search.
This needs to be called before calling setQuery() to have an effect. By default, the number of results is unlimited.
- Since:
- 4.4.3
void Akonadi::ContactGroupSearchJob::setQuery | ( | Criterion | criterion, |
const QString & | value | ||
) |
Sets the criterion
and value
for the search.
void Akonadi::ContactGroupSearchJob::setQuery | ( | Criterion | criterion, |
const QString & | value, | ||
Match | match | ||
) |
Sets the criterion
and value
for the search with match
.
- Since:
- 4.5
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu May 10 2012 22:18:39 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.