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
|
/*
* Copyright (C) 2015-2016 Canonical, Ltd.
*
* Authors:
* Gustavo Pichorim Boiko <gustavo.boiko@canonical.com>
* Tiago Salem Herrmann <tiago.herrmann@canonical.com>
*
* This file is part of telephony-service.
*
* telephony-service is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3.
*
* telephony-service 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef PROTOCOL_H
#define PROTOCOL_H
#include "dbustypes.h"
#include <QObject>
/// @brief describes one protocol and the features it supports
class Protocol : public QObject
{
Q_OBJECT
/// @brief the name of the protocol
Q_PROPERTY(QString name READ name CONSTANT)
/// @brief the features this protocol supports
Q_PROPERTY(Features features READ features CONSTANT)
/// @brief the fallback protocol to be used for operations that support it (mainly text features)
Q_PROPERTY(QString fallbackProtocol READ fallbackProtocol CONSTANT)
/// @brief the strategy to be used when matching fallback accounts
Q_PROPERTY(MatchRule fallbackMatchRule READ fallbackMatchRule CONSTANT)
/// @brief the property to be used on this protocol to match the fallback account
Q_PROPERTY(QString fallbackSourceProperty READ fallbackSourceProperty CONSTANT)
/// @brief the property to be used on the fallback protocol to match the account
Q_PROPERTY(QString fallbackDestinationProperty READ fallbackDestinationProperty CONSTANT)
/// @brief whether accounts from this protocol should be shown on account selectors
Q_PROPERTY(bool showOnSelector READ showOnSelector CONSTANT)
/// @brief whether the online status of contacts for this account should be shown on UI
Q_PROPERTY(bool showOnlineStatus READ showOnlineStatus CONSTANT)
/// @brief the file path for the image that represents this protocol
Q_PROPERTY(QString backgroundImage READ backgroundImage CONSTANT)
/// @brief the file path for the image that represents this protocol
Q_PROPERTY(QString icon READ icon CONSTANT)
/// @brief the title that represents this protocol
Q_PROPERTY(QString serviceName READ serviceName CONSTANT)
/// @brief the name to display for this protocol
Q_PROPERTY(QString serviceDisplayName READ serviceDisplayName CONSTANT)
public:
enum Feature {
TextChats = 0x1,
VoiceCalls = 0x2,
AllFeatures = (TextChats | VoiceCalls)
};
Q_DECLARE_FLAGS(Features, Feature)
Protocol(const ProtocolStruct& protocolStruct);
enum MatchRule {
MatchAny,
MatchProperties
};
QString name() const;
Features features() const;
QString fallbackProtocol() const;
MatchRule fallbackMatchRule() const;
QString fallbackSourceProperty() const;
QString fallbackDestinationProperty() const;
bool showOnSelector() const;
bool showOnlineStatus() const;
QString backgroundImage() const;
QString icon() const;
QString serviceName() const;
QString serviceDisplayName() const;
static Protocol *fromFile(const QString &fileName);
ProtocolStruct dbusType();
friend class ProtocolManager;
protected:
explicit Protocol(const QString &name, Features features,
const QString &fallbackProtocol = QString::null,
const MatchRule fallbackMatchRule = MatchAny,
const QString &fallbackSourceProperty = QString::null,
const QString &fallbackDestinationProperty = QString::null,
bool showOnSelector = true,
bool showOnlineStatus = false,
const QString &backgroundImage = QString::null,
const QString &icon = QString::null,
const QString &serviceName = QString::null,
const QString &serviceDisplayName = QString::null,
QObject *parent = 0);
private:
QString mName;
Features mFeatures;
QString mFallbackProtocol;
MatchRule mFallbackMatchRule;
QString mFallbackSourceProperty;
QString mFallbackDestinationProperty;
bool mShowOnSelector;
bool mShowOnlineStatus;
QString mBackgroundImage;
QString mIcon;
QString mServiceName;
QString mServiceDisplayName;
};
class Protocols : public QList<Protocol*>
{
public:
ProtocolList dbusType() {
// return list of DBus types
ProtocolList protocolList;
Q_FOREACH(Protocol *protocol, *this) {
protocolList << protocol->dbusType();
}
return protocolList;
}
};
#endif // PROTOCOL_H
|