|
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 "qcontactaction.h" |
|
43 #include "qcontactmanager_p.h" |
|
44 #include "qcontactactiondescriptor.h" |
|
45 |
|
46 #include <QSet> |
|
47 #include <QString> |
|
48 |
|
49 QTM_BEGIN_NAMESPACE |
|
50 |
|
51 QContactAction::~QContactAction() |
|
52 { |
|
53 } |
|
54 |
|
55 /*! |
|
56 \class QContactAction |
|
57 \brief The QContactAction class provides an interface for performing an |
|
58 action on a QContact or QContactDetail. |
|
59 \ingroup contacts-main |
|
60 |
|
61 An action is anything that can be performed on a contact, or a detail of a contact. An example |
|
62 of an action might be "Send Email" or "Dial" or "Plot Navigation Route". One action may be |
|
63 implemented by multiple vendors, and indeed one vendor may provide multiple implementations of |
|
64 the same action. The name of an action identifies its semantics, while its implementation version |
|
65 distinguishes it from other implementations of the action by the same vendor. |
|
66 |
|
67 Invocation of an action is asynchronous; at some stage after calling \l invokeAction() the |
|
68 action instance will emit the \l progress() signal. Any results of the action may be retrieved |
|
69 by calling \l result(). |
|
70 |
|
71 Each instance of a QContactAction is created by a \l QContactActionFactory when |
|
72 \l QContactActionFactory::instance() is called; the caller takes ownership of the action instance. |
|
73 |
|
74 \sa QContactActionFactory, QContactActionFilter |
|
75 */ |
|
76 |
|
77 /*! |
|
78 \fn QContactAction::~QContactAction() |
|
79 Clears any memory in use by this instance of the action implementation |
|
80 */ |
|
81 |
|
82 /*! |
|
83 \fn QContactAction::actionDescriptor() const |
|
84 Returns the descriptor which uniquely identifies this action implementation. A descriptor |
|
85 consists of an action name, a vendor name and an implementation version. |
|
86 The name of the action identifies the action provided; different implementations of an action |
|
87 with the same name must provide the same functionality, but may differ in implementation semantics. |
|
88 Hence, the action name includes the major version of the interface definition implemented. |
|
89 The vendor name is the identification string of the vendor which has provided this implementation. |
|
90 The implementation version is the (minor) version of the implementation, and is vendor-specific. |
|
91 |
|
92 \sa QContactActionDescriptor |
|
93 */ |
|
94 |
|
95 /*! |
|
96 \fn QContactAction::metaData() const |
|
97 Returns the meta-data associated with this action, such as icons, labels or sound cues |
|
98 */ |
|
99 |
|
100 /*! |
|
101 \fn QContactAction::contactFilter(const QVariant& value) const |
|
102 Returns a filter which may be used to filter contacts by the availability of this action implementation for them. |
|
103 If \a value is valid, only contacts which have a detail with the given value and for which the action is available are returned |
|
104 */ |
|
105 |
|
106 /*! |
|
107 \fn QContactAction::supportsDetail(const QContactDetail& detail) const |
|
108 Returns true if the provided \a detail contains the fields required for this action to be |
|
109 performed on it; otherwise, returns false |
|
110 */ |
|
111 |
|
112 /*! |
|
113 \fn QContactAction::supportedDetails(const QContact& contact) const |
|
114 Returns a list of the details saved in the given \a contact which contain the fields required |
|
115 for this action to be performed on them. |
|
116 |
|
117 The default implementation of this function simply tests all the details in the contact |
|
118 using \l supportsDetail() |
|
119 */ |
|
120 QList<QContactDetail> QContactAction::supportedDetails(const QContact& contact) const |
|
121 { |
|
122 QList<QContactDetail> ret; |
|
123 QList<QContactDetail> details = contact.details(); |
|
124 for (int j=0; j < details.count(); j++) { |
|
125 if (supportsDetail(details.at(j))) |
|
126 ret.append(details.at(j)); |
|
127 } |
|
128 return ret; |
|
129 } |
|
130 |
|
131 /*! |
|
132 \fn QContactAction::invokeAction(const QContact& contact, const QContactDetail& detail = QContactDetail()) |
|
133 Initiates the implemented action on the specified \a detail of the given \a contact, or on the first |
|
134 eligible detail saved in the contact if the given \a detail is empty. |
|
135 At some point after invocation, one or more \l progress() signals will be emitted by the action instance. |
|
136 The results of the action (if any) may be retrieved by calling \l result(). |
|
137 |
|
138 \sa result(), progress() |
|
139 */ |
|
140 |
|
141 /*! |
|
142 \fn QContactAction::result() const |
|
143 Returns the result of the action, if any exists. Calling this function prior to receiving the \l progress() |
|
144 signal will not return a meaningful result. |
|
145 */ |
|
146 |
|
147 /*! |
|
148 \enum QContactAction::State |
|
149 Describes the current status of the asynchronous action operation |
|
150 \value InactiveState The operation has not yet been initiated |
|
151 \value AutonomousState The operation was initiated but no further information is or will be available |
|
152 \value ActiveState The operation was initiated and is not yet finished |
|
153 \value FinishedState The operation successfully completed |
|
154 \value FinishedWithErrorState The operation has finished, but an error occurred |
|
155 */ |
|
156 |
|
157 /*! |
|
158 \fn QContactAction::progress(QContactAction::State state, const QVariantMap& result) |
|
159 This signal is emitted by an action instance whose functionality has been initiated with \l invokeAction(). |
|
160 It provides clients with the current \a state of the action, and any \a result associated with the action. |
|
161 This signal must be emitted at least once by every action instance after \l invokeAction() is called. |
|
162 |
|
163 If the action implementation is incapable of reporting the status of the operation (for example, the |
|
164 action is implemented via a one-way IPC call) it should emit the progress signal with \a state |
|
165 set to \c QContactAction::AutonomousState. |
|
166 */ |
|
167 |
|
168 /*! |
|
169 Returns a list of identifiers of the available actions which are provided by the given \a vendor and of the given \a implementationVersion. |
|
170 If \a vendor is empty, actions from all vendors and of any implementation version are returned; if \a implementationVersion is empty, |
|
171 any actions from the given \a vendor (regardless of implementation version) are returned. |
|
172 */ |
|
173 QStringList QContactAction::availableActions(const QString& vendor, int implementationVersion) |
|
174 { |
|
175 // SLOW naive implementation... |
|
176 QSet<QString> ret; |
|
177 QContactManagerData::loadFactories(); |
|
178 QList<QContactActionDescriptor> actionDescriptors = QContactManagerData::actionDescriptors(QString(), vendor, implementationVersion); |
|
179 for (int i = 0; i < actionDescriptors.size(); i++) { |
|
180 QContactActionDescriptor descriptor = actionDescriptors.at(i); |
|
181 ret.insert(descriptor.actionName()); |
|
182 } |
|
183 |
|
184 return ret.toList(); |
|
185 } |
|
186 |
|
187 /*! |
|
188 Returns a list of QContactActionDescriptor instances which identified implementations of the given \a actionName which are provided by the |
|
189 given \a vendorName and are of the given \a implementationVersion. If \a actionName is empty, descriptors for |
|
190 implementations of all actions are returned; if \a vendorName is empty, descriptors for implementations provided by any vendor and |
|
191 of any implementation version are returned; if \a implementationVersion is empty, descriptors for any implementations provided by the |
|
192 given \a vendorName of the given \a actionName are returned. |
|
193 */ |
|
194 QList<QContactActionDescriptor> QContactAction::actionDescriptors(const QString& actionName, const QString& vendorName, int implementationVersion) |
|
195 { |
|
196 QContactManagerData::loadFactories(); |
|
197 return QContactManagerData::actionDescriptors(actionName, vendorName, implementationVersion); |
|
198 } |
|
199 |
|
200 /*! |
|
201 Returns a pointer to a new instance of the action implementation identified by the given \a descriptor. |
|
202 The caller takes ownership of the action implementation and must delete it to avoid leaking memory. |
|
203 */ |
|
204 QContactAction* QContactAction::action(const QContactActionDescriptor& descriptor) |
|
205 { |
|
206 QContactManagerData::loadFactories(); |
|
207 return QContactManagerData::action(descriptor); |
|
208 } |
|
209 |
|
210 #include "moc_qcontactaction.cpp" |
|
211 |
|
212 QTM_END_NAMESPACE |