/
transfermethodinfo.cpp
182 lines (160 loc) · 5.15 KB
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/****************************************************************************************
**
** Copyright (C) 2013 Jolla Ltd.
** Contact: Marko Mattila <marko.mattila@jollamobile.com>
** All rights reserved.
**
** This file is part of Nemo Transfer Engine package.
**
** You may use this file 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.
**
** This library is free software; you can redistribute it and/or
** modify it 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.
**
** This library is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
** Lesser General Public License for more details.
**
****************************************************************************************/
#include "transfermethodinfo.h"
#include "metatypedeclarations.h"
/*!
\class TransferMethodInfo
\brief The TransferMethodInfo class encapsulate information of a single transfer method.
\ingroup transfer-engine-lib
Share plugin must create a list of instances of TransferMethodInfo class to encapsulate
information about the plugin for example filling information for the Bluetooth sharing plugin:
\code
QList<TransferMethodInfo> infoList;
TransferMethodInfo info;
QStringList capabilities;
capabilities << QLatin1String("*");
info.displayName = QLatin1String("Bluetooth");
info.userName = "";
info.accountId = "";
info.methodId = QLatin1String("bluetooth");
info.shareUIPath = SHARE_UI_PATH + QLatin1String("/BluetoothShareUI.qml");
info.capabilitities = capabilities;
infoList << info;
\endcode
*/
/*!
\enum TransferMethodInfo::TransferMethodInfoField
This enum can be used for accessing different values using value() method
\value DisplayName The name that will be visible e.g. Facebook or Bluetooth
\value UserName User name e.g. mike.myers@gmail.com
\value MethodId The plugin Id of the share plugin e.g. "bluetooth"
\value AccountId The Id the account, needed in a case of multiple accounts
\value ShareUIPath The path to the share ui QML plugin. This QML file will be loaded by the share UI
\value Capabilities A list of supported mimetypes
*/
/*!
Creates an instance of TransferMethodInfo.
*/
TransferMethodInfo::TransferMethodInfo():
displayName(),
userName(),
methodId(),
shareUIPath(),
capabilitities(),
accountId()
{
}
/*!
Assigns \a other object to this.
*/
TransferMethodInfo &TransferMethodInfo::operator=(const TransferMethodInfo &other)
{
displayName = other.displayName;
userName = other.userName;
methodId = other.methodId;
shareUIPath = other.shareUIPath;
capabilitities = other.capabilitities;
accountId = other.accountId;
return *this;
}
/*!
Copies \a other to this instance.
*/
TransferMethodInfo::TransferMethodInfo(const TransferMethodInfo &other):
displayName(other.displayName),
userName(other.userName),
methodId(other.methodId),
shareUIPath(other.shareUIPath),
capabilitities(other.capabilitities),
accountId(other.accountId)
{
}
/*!
Destroys TransferMethodInfo instance.
*/
TransferMethodInfo::~TransferMethodInfo()
{
}
/*!
Writes data from \a info to \a argument.
*/
QDBusArgument &operator<<(QDBusArgument &argument, const TransferMethodInfo &info)
{
argument.beginStructure();
argument << info.displayName
<< info.userName
<< info.methodId
<< info.shareUIPath
<< info.capabilitities
<< info.accountId;
argument.endStructure();
return argument;
}
/*!
Reads data from \a argument to \a info.
*/
const QDBusArgument &operator>>(const QDBusArgument &argument, TransferMethodInfo &info)
{
argument.beginStructure();
argument >> info.displayName
>> info.userName
>> info.methodId
>> info.shareUIPath
>> info.capabilitities
>> info.accountId;
argument.endStructure();
return argument;
}
/*!
Registers TransferMethodInfo and QList<TransferMethodInfo> as DBus types.
*/
void TransferMethodInfo::registerType()
{
qDBusRegisterMetaType<TransferMethodInfo>();
qDBusRegisterMetaType<QList<TransferMethodInfo> >();
}
/*!
Returns the value using the \a index. Actually the index is enum TransferMethodInfoField.
*/
QVariant TransferMethodInfo::value(int index) const
{
switch(index) {
case DisplayName:
return displayName;
case UserName:
return userName;
case MethodId:
return methodId;
case ShareUIPath:
return shareUIPath;
case Capabilities:
return capabilitities;
case AccountId:
return accountId;
default:
return QVariant();
}
}