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
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QCONTACTACTION_H
#define QCONTACTACTION_H
#include "qtcontactsglobal.h"
#include "qcontactfilter.h"
#include "qcontactdetail.h"
#include "qcontact.h"
#include "qcontactactiontarget.h"
#include <QObject>
QTM_BEGIN_NAMESPACE
class QContactActionDescriptor;
class QContactActionData;
class Q_CONTACTS_EXPORT QContactAction : public QObject
{
Q_OBJECT
public:
virtual ~QContactAction() = 0;
/* Initiate the asynchronous action on the given list of contacts (and optionally, per-contact-details) with the given parameters */
virtual bool invokeAction(const QList<QContactActionTarget>& targets, const QVariantMap& parameters = QVariantMap()) = 0;
/* The possible states of an action */
enum State {
InactiveState = 0, // operation not yet started
ActiveState, // operation started, not yet finished
FinishedState, // operation successfully completed
FinishedDetachedState, // operation started, no further information available - name under discussion.
FinishedWithErrorState // operation finished, but error occurred
};
virtual State state() const = 0;
/* Returns the most recently received result, or an empty QVariantMap if no results received */
virtual QVariantMap results() const = 0;
/* Convenience functions */
bool invokeAction(const QContactActionTarget& target, const QVariantMap& parameters = QVariantMap())
{
return invokeAction(QList<QContactActionTarget>() << target, parameters);
}
bool invokeAction(const QContact& contact, const QContactDetail& detail = QContactDetail(), const QVariantMap& parameters = QVariantMap())
{
return invokeAction(QList<QContactActionTarget>() << QContactActionTarget(contact, detail), parameters);
}
// common actions
#ifdef Q_QDOC
static const QLatin1Constant ActionCall;
static const QLatin1Constant ActionEmail;
static const QLatin1Constant ActionSms;
static const QLatin1Constant ActionMms;
static const QLatin1Constant ActionChat;
static const QLatin1Constant ActionVideoCall;
static const QLatin1Constant ActionOpenInEditor;
static const QLatin1Constant ActionOpenInViewer;
#else
Q_DECLARE_LATIN1_CONSTANT(ActionCall, "call");
Q_DECLARE_LATIN1_CONSTANT(ActionEmail, "email");
Q_DECLARE_LATIN1_CONSTANT(ActionSms, "sms");
Q_DECLARE_LATIN1_CONSTANT(ActionMms, "mms");
Q_DECLARE_LATIN1_CONSTANT(ActionChat, "chat");
Q_DECLARE_LATIN1_CONSTANT(ActionVideoCall, "videocall");
Q_DECLARE_LATIN1_CONSTANT(ActionOpenInEditor, "edit");
Q_DECLARE_LATIN1_CONSTANT(ActionOpenInViewer, "view");
#endif
Q_SIGNALS:
void stateChanged(QContactAction::State);
void resultsAvailable();
public:
/* return a list of names of actions which are available */
static QStringList availableActions(const QString& serviceName = QString());
/* return a list of descriptors for action implementations matching the given criteria */
static QList<QContactActionDescriptor> actionDescriptors(const QString& actionName = QString());
/* return a pointer to an implementation of the action identified by the given descriptor */
static QContactAction* action(const QContactActionDescriptor& descriptor);
};
QTM_END_NAMESPACE
#endif
|
