1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtContacts module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL21$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 or version 3 as published by the Free
20** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22** following information to ensure the GNU Lesser General Public License
23** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25**
26** As a special exception, The Qt Company gives you certain additional
27** rights. These rights are described in The Qt Company LGPL Exception
28** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29**
30** $QT_END_LICENSE$
31**
32****************************************************************************/
33
34#ifndef QCONTACTACTIONDESCRIPTOR_H
35#define QCONTACTACTIONDESCRIPTOR_H
36
37#include <QtCore/qmap.h>
38#include <QtCore/qset.h>
39#include <QtCore/qshareddata.h>
40#include <QtCore/qstringlist.h>
41#include <QtCore/qvariant.h>
42
43#include <QtContacts/qcontactactiontarget.h>
44#include <QtContacts/qcontactdetail.h>
45#include <QtContacts/qcontactfilter.h>
46
47QT_BEGIN_NAMESPACE_CONTACTS
48
49class QContact;
50class QContactActionFactory;
51
52class QContactActionDescriptorPrivate;
53class Q_CONTACTS_EXPORT QContactActionDescriptor
54{
55public:
56 QContactActionDescriptor();
57 QContactActionDescriptor(const QContactActionDescriptor& other);
58 QContactActionDescriptor& operator=(const QContactActionDescriptor& other);
59 ~QContactActionDescriptor();
60
61 bool isValid() const;
62 bool operator==(const QContactActionDescriptor& other) const;
63 bool operator!=(const QContactActionDescriptor& other) const;
64
65 QString actionName() const;
66 QString serviceName() const;
67 QString actionIdentifier() const;
68 int implementationVersion() const;
69
70 /* The descriptor provides the client with all information required in UI. */
71 QSet<QContactActionTarget> supportedTargets(const QContact& contact) const;
72 QContactFilter contactFilter() const;
73 bool supportsContact(const QContact& contact) const;
74 QVariant metaData(const QString& key, const QList<QContactActionTarget>& targets, const QVariantMap& parameters = QVariantMap()) const;
75
76 /* Convenience meta data accessors */
77 QVariant metaData(const QString& key, const QVariantMap& parameters = QVariantMap()) const;
78 QVariant metaData(const QString& key, const QContactActionTarget& target, const QVariantMap& parameters = QVariantMap()) const;
79 QVariant metaData(const QString& key, const QContact& contact, const QContactDetail& detail = QContactDetail(), const QVariantMap& parameters = QVariantMap()) const;
80
81 // default meta-data keys
82 static const QString MetaDataIcon;
83 static const QString MetaDataLabel;
84 static const QString MetaDataSecondLabel;
85 static const QString MetaDataOptionalParameterKeys;
86 static const QString MetaDataMandatoryParameterKeys;
87
88private:
89 QSharedDataPointer<QContactActionDescriptorPrivate> d;
90 friend class QContactActionFactory;
91 friend class QContactActionServiceManager;
92#ifndef QT_NO_DEBUG_STREAM
93 Q_CONTACTS_EXPORT friend QDebug& operator<<(QDebug dbg, const QContactActionDescriptor& descriptor);
94#endif
95 Q_CONTACTS_EXPORT friend uint qHash(const QContactActionDescriptor& key);
96};
97
98Q_CONTACTS_EXPORT uint qHash(const QContactActionDescriptor& key);
99#ifndef QT_NO_DEBUG_STREAM
100Q_CONTACTS_EXPORT QDebug& operator<<(QDebug dbg, const QContactActionDescriptor& descriptor);
101#endif
102
103QT_END_NAMESPACE_CONTACTS
104
105QT_BEGIN_NAMESPACE
106Q_DECLARE_TYPEINFO(QTCONTACTS_PREPEND_NAMESPACE(QContactActionDescriptor), Q_MOVABLE_TYPE);
107QT_END_NAMESPACE
108
109#endif // QCONTACTACTIONDESCRIPTOR_H
110

source code of qtpim/src/contacts/qcontactactiondescriptor.h