← Back to branch summary

~chris.gagnon/+junk/qtpim-coverage

« back to all changes in this revision

Viewing changes to src/contacts/doc/snippets/multiaction/multiaction_p.h

  • Committer: chris.gagnon
  • Date: 2013-12-10 23:09:37 UTC
  • Revision ID: chris.gagnon@canonical.com-20131210230937-2akf1ft1edcttk87
first post

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/contacts/doc/snippets/multiaction/multiaction_p.h
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
 
4
** Contact: http://www.qt-project.org/legal
 
5
**
 
6
** This file is part of the documentation of the Qt Toolkit.
 
7
**
 
8
** $QT_BEGIN_LICENSE:BSD$
 
9
** You may use this file under the terms of the BSD license as follows:
 
10
**
 
11
** "Redistribution and use in source and binary forms, with or without
 
12
** modification, are permitted provided that the following conditions are
 
13
** met:
 
14
**   * Redistributions of source code must retain the above copyright
 
15
**     notice, this list of conditions and the following disclaimer.
 
16
**   * Redistributions in binary form must reproduce the above copyright
 
17
**     notice, this list of conditions and the following disclaimer in
 
18
**     the documentation and/or other materials provided with the
 
19
**     distribution.
 
20
**   * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
 
21
**     of its contributors may be used to endorse or promote products derived
 
22
**     from this software without specific prior written permission.
 
23
**
 
24
**
 
25
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 
26
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 
27
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 
28
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 
29
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 
30
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 
31
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 
32
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 
33
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
34
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 
35
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
 
36
**
 
37
** $QT_END_LICENSE$
 
38
**
 
39
****************************************************************************/
 
40
 
 
41
#ifndef QCONTACTMULTIACTION_P_H
 
42
#define QCONTACTMULTIACTION_P_H
 
43
 
 
44
//
 
45
//  W A R N I N G
 
46
//  -------------
 
47
//
 
48
// This file is not part of the Qt API.  It exists purely as an
 
49
// implementation detail.  This header file may change from version to
 
50
// version without notice, or even be removed.
 
51
//
 
52
// We mean it.
 
53
//
 
54
 
 
55
#include "qcontactaction.h"
 
56
#include "qcontactactionfactory.h"
 
57
 
 
58
#include "qserviceinterfacedescriptor.h"
 
59
#include "qserviceplugininterface.h"
 
60
#include "qservicecontext.h"
 
61
#include "qabstractsecuritysession.h"
 
62
 
 
63
#include <QSharedData>
 
64
#include <QString>
 
65
#include <QVariantMap>
 
66
 
 
67
QTM_USE_NAMESPACE
 
68
 
 
69
//! [Example Contact Action Plugin Declaration]
 
70
 
 
71
/*
 
72
   This action plugin is capable of producing two actions which each have the
 
73
   same action name, service name, interface name and implementation (minor) version,
 
74
   but internally use a different implementation.  This difference is reported via the
 
75
   meta data function of the factory (which is exposed to clients via the descriptor
 
76
   which provides a "front end" to the factory).
 
77
 
 
78
   Example use case:
 
79
   Company "Example VoIP Solutions" wants to provide a "Call" action with different implementations.
 
80
       -> it provides a SINGLE plugin which provides two actions, both of which are:
 
81
           - ServiceName = "Example VoIP Solution"
 
82
           - InterfaceName = "org.qt-project.Qt.SampleContactsActionPlugin" (QContactActionFactory::InterfaceName)
 
83
           - Major Version = "1"
 
84
           - Minor Version = "1"
 
85
           - ActionName = "call" (this is a custom property in the service interface xml)
 
86
       -> BUT one of the actions has the custom property:
 
87
           - Provider = "sip"
 
88
       -> where the other action has the custom property:
 
89
           - Provider = "example proprietary protocol"
 
90
       -> the custom properties are available to clients via the QContactActionDescriptor::metaData() function.
 
91
 */
 
92
 
 
93
class QContactMultiActionPlugin : public QObject, public QServicePluginInterface
 
94
{
 
95
    Q_OBJECT
 
96
    Q_INTERFACES(QtMobility::QServicePluginInterface)
 
97
 
 
98
public:
 
99
    QObject* createInstance(const QServiceInterfaceDescriptor& descriptor,
 
100
                            QServiceContext* context,
 
101
                            QAbstractSecuritySession* session);
 
102
};
 
103
 
 
104
class QContactMultiActionFactory : public QContactActionFactory
 
105
{
 
106
    Q_OBJECT
 
107
 
 
108
public:
 
109
    QContactMultiActionFactory();
 
110
    ~QContactMultiActionFactory();
 
111
 
 
112
    QList<QContactActionDescriptor> actionDescriptors() const;
 
113
    QContactAction* create(const QContactActionDescriptor& which) const;
 
114
 
 
115
    QSet<QContactActionTarget> supportedTargets(const QContact& contact, const QContactActionDescriptor& which) const;
 
116
    QContactFilter contactFilter(const QContactActionDescriptor& which) const;
 
117
    QVariant metaData(const QString& key, const QList<QContactActionTarget>& targets, const QVariantMap& parameters, const QContactActionDescriptor& which) const;
 
118
 
 
119
    bool supportsContact(const QContact& contact, const QContactActionDescriptor& which) const;
 
120
 
 
121
private:
 
122
    QContactActionDescriptor m_actionOneDescriptor;
 
123
    QContactActionDescriptor m_actionTwoDescriptor;
 
124
};
 
125
 
 
126
class QContactActionOne : public QContactAction
 
127
{
 
128
    Q_OBJECT
 
129
 
 
130
public:
 
131
    QContactActionOne();
 
132
    ~QContactActionOne();
 
133
 
 
134
    bool invokeAction(const QContactActionTarget& target, const QVariantMap& params = QVariantMap());
 
135
    bool invokeAction(const QList<QContactActionTarget>& targets, const QVariantMap& params = QVariantMap());
 
136
    QVariantMap results() const;
 
137
    State state() const;
 
138
 
 
139
private slots:
 
140
    void performAction();
 
141
};
 
142
 
 
143
class QContactActionTwo : public QContactAction
 
144
{
 
145
    Q_OBJECT
 
146
 
 
147
public:
 
148
    QContactActionTwo();
 
149
    ~QContactActionTwo();
 
150
 
 
151
    bool invokeAction(const QContactActionTarget& target, const QVariantMap& params = QVariantMap());
 
152
    bool invokeAction(const QList<QContactActionTarget>& targets, const QVariantMap& params = QVariantMap());
 
153
    QVariantMap results() const;
 
154
    State state() const;
 
155
 
 
156
private slots:
 
157
    void performAction();
 
158
};
 
159
 
 
160
//! [Example Contact Action Plugin Declaration]
 
161
 
 
162
#endif