/usr/include/KF5/akonadi/contact/contactgroupsearchjob.h is in libkf5akonadicontact-dev 4:15.12.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | /*
This file is part of Akonadi Contact.
Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_CONTACTGROUPSEARCHJOB_H
#define AKONADI_CONTACTGROUPSEARCHJOB_H
#include "akonadi-contact_export.h"
#include <item.h>
#include <itemsearchjob.h>
#include <kcontacts/contactgroup.h>
namespace Akonadi
{
/**
* @short 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.
*
* @code
*
* 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 KContacts::ContactGroup::List contactGroups = searchJob->contactGroups();
* // do something with the contact groups
* }
*
* @endcode
*
* @author Tobias Koenig <tokoe@kde.org>
* @since 4.4
*/
class AKONADI_CONTACT_EXPORT ContactGroupSearchJob : public ItemSearchJob
{
Q_OBJECT
public:
/**
* Creates a new contact group search job.
*
* @param parent The parent object.
*/
explicit ContactGroupSearchJob(QObject *parent = Q_NULLPTR);
/**
* Destroys the contact group search job.
*/
~ContactGroupSearchJob();
/**
* Describes the criteria that can be searched for.
*/
enum Criterion {
Name ///< The name of the contact group.
};
/**
* Describes the type of pattern matching that shall be used.
*
* @since 4.5
*/
enum Match {
ExactMatch, ///< The result must match exactly the pattern (case sensitive).
StartsWithMatch, ///< The result must start with the pattern (case insensitive).
ContainsMatch ///< The result must contain the pattern (case insensitive).
};
/**
* Sets the @p criterion and @p value for the search.
*/
void setQuery(Criterion criterion, const QString &value);
/**
* Sets the @p criterion and @p value for the search with @p match.
* @param criterion the query criterion to compare with
* @param value the value to match against
* @param match how to match the given value
* @since 4.5
*/
void setQuery(Criterion criterion, const QString &value, Match match);
/**
* Sets a @p 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.
* @param 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
*/
void setLimit(int limit);
/**
* Returns the contact groups that matched the search criteria.
*/
KContacts::ContactGroup::List contactGroups() const;
private:
//@cond PRIVATE
class Private;
Private *const d;
//@endcond
};
}
#endif
|