akonadi/contact
#include <contactgroupsearchjob.h>
Inherits ItemSearchJob.
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.
- Since
- 4.4
Definition at line 59 of file contactgroupsearchjob.h.
Member Enumeration Documentation
◆ Criterion
Describes the criteria that can be searched for.
Enumerator | |
---|---|
Name | The name of the contact group. |
Definition at line 79 of file contactgroupsearchjob.h.
◆ Match
Describes the type of pattern matching that shall be used.
- Since
- 4.5
Definition at line 88 of file contactgroupsearchjob.h.
Constructor & Destructor Documentation
◆ ContactGroupSearchJob()
|
explicit |
Creates a new contact group search job.
- Parameters
-
parent The parent object.
Definition at line 36 of file contactgroupsearchjob.cpp.
◆ ~ContactGroupSearchJob()
ContactGroupSearchJob::~ContactGroupSearchJob | ( | ) |
Destroys the contact group search job.
Definition at line 50 of file contactgroupsearchjob.cpp.
Member Function Documentation
◆ contactGroups()
KABC::ContactGroup::List ContactGroupSearchJob::contactGroups | ( | ) | const |
Returns the contact groups that matched the search criteria.
Definition at line 91 of file contactgroupsearchjob.cpp.
◆ setLimit()
void 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 during the search.
- Parameters
-
limit the limit to set
- Note
- this needs to be called before calling setQuery() to have an effect. By default, the number of results is unlimited.
- Since
- 4.4.3
Definition at line 86 of file contactgroupsearchjob.cpp.
◆ setQuery() [1/2]
void ContactGroupSearchJob::setQuery | ( | Criterion | criterion, |
const QString & | value | ||
) |
Sets the criterion
and value
for the search.
Definition at line 55 of file contactgroupsearchjob.cpp.
◆ setQuery() [2/2]
Sets the criterion
and value
for the search with match
.
- Parameters
-
criterion the query criterion to compare with value the value to match against match how to match the given value
- Since
- 4.5
Definition at line 74 of file contactgroupsearchjob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.