summaryrefslogtreecommitdiff
path: root/TelepathyQt/generic-capability-filter.dox
blob: 53d70ae7c014cb3e76b454f6c8e20fe64c9ef2d1 (plain)
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
/*
 * This file is part of TelepathyQt
 *
 * @copyright Copyright (C) 2011 Collabora Ltd. <http://www.collabora.co.uk/>
 * @copyright Copyright (C) 2011 Nokia Corporation
 * @license LGPL 2.1
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

/**
 * \class Tp::GenericCapabilityFilter
 * \ingroup utils
 * \headerfile TelepathyQt/generic-capability-filter.h <TelepathyQt/GenericCapabilityFilter>
 *
 * \brief The GenericCapabilityFilter class provides a generic filter object to
 * be used to filter objects by capabilities.
 *
 * The objects used in conjunction with this filter must implement a method
 * called capabilities() returning a CapabilitiesBase (or a subclass of it)
 * instance.
 * Specialized classes such as AccountCapabilityFilter are also provided and
 * should be used where appropriate.
 */