|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #include "qcontactfetchrequest.h" |
|
43 #include "qcontactrequests_p.h" |
|
44 |
|
45 QTM_BEGIN_NAMESPACE |
|
46 |
|
47 /*! |
|
48 \class QContactFetchRequest |
|
49 \brief The QContactFetchRequest class allows a client to asynchronously |
|
50 request contacts from a contacts store manager. |
|
51 |
|
52 |
|
53 For a QContactFetchRequest, the resultsAvailable() signal will be emitted when the resultant |
|
54 contacts (which may be retrieved by calling contacts()), are updated, as well as if |
|
55 the overall operation error (which may be retrieved by calling error()) is updated. |
|
56 |
|
57 \ingroup contacts-requests |
|
58 */ |
|
59 |
|
60 /*! Constructs a new contact fetch request */ |
|
61 QContactFetchRequest::QContactFetchRequest() |
|
62 : QContactAbstractRequest(new QContactFetchRequestPrivate) |
|
63 { |
|
64 } |
|
65 |
|
66 /*! Cleans up the memory in use by this contact fetch request */ |
|
67 QContactFetchRequest::~QContactFetchRequest() |
|
68 { |
|
69 } |
|
70 |
|
71 /*! Sets the contact filter used to determine which contacts will be retrieved to \a filter */ |
|
72 void QContactFetchRequest::setFilter(const QContactFilter& filter) |
|
73 { |
|
74 Q_D(QContactFetchRequest); |
|
75 d->m_filter = filter; |
|
76 } |
|
77 |
|
78 /*! Sets the sort order of the result to \a sorting. Only has an effect if called prior to calling \c start() */ |
|
79 void QContactFetchRequest::setSorting(const QList<QContactSortOrder>& sorting) |
|
80 { |
|
81 Q_D(QContactFetchRequest); |
|
82 d->m_sorting = sorting; |
|
83 } |
|
84 |
|
85 /*! Sets the list of allowable detail definition names to \a definitionNames. Any contacts retrieved |
|
86 by the request will have any details whose definition name is not on the restricted list |
|
87 removed prior to being returned. */ |
|
88 void QContactFetchRequest::setDefinitionRestrictions(const QStringList& definitionNames) |
|
89 { |
|
90 Q_D(QContactFetchRequest); |
|
91 d->m_definitionRestrictions = definitionNames; |
|
92 } |
|
93 |
|
94 /*! Returns the filter that will be used to select contacts to be returned */ |
|
95 QContactFilter QContactFetchRequest::filter() const |
|
96 { |
|
97 Q_D(const QContactFetchRequest); |
|
98 return d->m_filter; |
|
99 } |
|
100 |
|
101 /*! Returns the sort ordering that will be used sort the results of this request */ |
|
102 QList<QContactSortOrder> QContactFetchRequest::sorting() const |
|
103 { |
|
104 Q_D(const QContactFetchRequest); |
|
105 return d->m_sorting; |
|
106 } |
|
107 |
|
108 /*! Returns the list of definition names which define which details contacts in the result list will be limited to */ |
|
109 QStringList QContactFetchRequest::definitionRestrictions() const |
|
110 { |
|
111 Q_D(const QContactFetchRequest); |
|
112 return d->m_definitionRestrictions; |
|
113 } |
|
114 |
|
115 /*! Returns the list of contacts retrieved by this request */ |
|
116 QList<QContact> QContactFetchRequest::contacts() const |
|
117 { |
|
118 Q_D(const QContactFetchRequest); |
|
119 return d->m_contacts; |
|
120 } |
|
121 |
|
122 #include "moc_qcontactfetchrequest.cpp" |
|
123 |
|
124 QTM_END_NAMESPACE |