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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
/* -*- C++ -*-
*
* Copyright (C) 2005 Thiago Macieira <thiago@kde.org>
* Copyright (C) 2006 Trolltech AS. All rights reserved.
* Author: Thiago Macieira <thiago.macieira@trolltech.com>
*
* Licensed under the Academic Free License version 2.1
*
* This program 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; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef QDBUSINTERFACE_H
#define QDBUSINTERFACE_H
#include "qdbusmessage.h"
#include "qdbusobject.h"
#include "qdbusintrospection.h"
#include <QtCore/qstring.h>
#include <QtCore/qvariant.h>
#include <QtCore/qlist.h>
class QDBusConnection;
class QDBusInterfacePrivate;
/**
* Base class for all DBUS interfaces in the QtDBUS binding.
*/
class QDBUS_EXPORT QDBusInterface
{
friend class QDBusConnection;
public:
enum CallMode {
WaitForReply,
NoWaitForReply
};
public:
/**
* Construct an interface of the given name
*/
QDBusInterface(const QDBusObject& obj, const QString& name);
/**
* @overload.
* Construct an interface of the given name
*/
QDBusInterface(QDBusConnection& conn, const QString& service, const QString& path, const QString& name);
/**
* Construct a copy of the interface.
*/
QDBusInterface(const QDBusInterface&);
/**
* Destructs this interface.
*/
virtual ~QDBusInterface();
/**
* Copy the interface.
*/
QDBusInterface& operator=(const QDBusInterface&);
/**
* Returns the object associated with this interface.
*/
inline QDBusObject object()
{ return QDBusObject(*this); }
inline const QDBusObject object() const
{ return QDBusObject(*this); }
/**
* Returns the connection this interface is on.
*/
QDBusConnection connection() const;
/**
* Returns the name of the service this interface is associated with.
*/
QString service() const;
/**
* Returns the object path that this interface is associated with.
*/
QString path() const;
/**
* Returns the name of this interface.
*/
QString interface() const;
/**
* Returns the introspection XML fragment data of this interface.
*/
virtual QString introspectionData() const;
/**
* Returns the interface data for this interface.
*/
const QDBusIntrospection::Interface& interfaceData() const;
/**
* Returns the annotations present in this interface, if any.
*/
const QDBusIntrospection::Annotations& annotationData() const;
/**
* List all methods in this interface.
*/
const QDBusIntrospection::Methods& methodData() const;
/**
* List all signals in this interface.
*/
const QDBusIntrospection::Signals& signalData() const;
/**
* List all properties in this interface.
*/
const QDBusIntrospection::Properties& propertyData() const;
/**
* Call the given method.
*/
QDBusMessage callWithArgs(const QDBusIntrospection::Method& method,
const QList<QVariant>& args = QList<QVariant>(),
CallMode mode = WaitForReply);
/**
* Call the given method.
*/
QDBusMessage callWithArgs(const QString& method, const QList<QVariant>& args = QList<QVariant>(),
CallMode mode = WaitForReply);
/**
* Call the given method.
*/
QDBusMessage callWithArgs(const QString& method, const QString& signature,
const QList<QVariant>& args = QList<QVariant>(),
CallMode mode = WaitForReply);
/**
* Connects the DBUS signal to the given slot.
*/
bool connect(const QDBusIntrospection::Signal&, QObject* obj, const char *slot);
/**
* Connects the DBUS signal to the given slot.
*/
bool connect(const QString& signalName, QObject* obj, const char *slot);
/**
* Connects the DBUS signal to the given slot.
*/
bool connect(const QString& signalName, const QString& signature,
QObject* obj, const char *slot);
/**
* Gets the value of the given property.
*/
QVariant propertyGet(const QDBusIntrospection::Property&);
/**
* Gets the value of the given property.
*/
QVariant propertyGet(const QString& property);
/**
* Sets the value of the given property.
*/
void propertySet(const QDBusIntrospection::Property&, QVariant newValue);
/**
* Sets the value of the given property.
*/
void propertySet(const QString& property, QVariant newValue);
/**
* Casts to QDBusObject.
*/
inline operator QDBusObject()
{ return QDBusObject(*this); }
/**
* Casts to const QDBusObject.
*/
inline operator const QDBusObject() const
{ return QDBusObject(*this); }
/**
* Call the given method.
*/
template<typename MethodType>
inline QDBusMessage call(MethodType m)
{
return callWithArgs(m);
}
/**
* Call the given method.
*/
template<typename MethodType, typename T1>
inline QDBusMessage call(MethodType m, T1 t1)
{
QList<QVariant> args;
args << t1;
return callWithArgs(m, args);
}
/**
* Call the given method.
*/
template<typename MethodType, typename T1, typename T2>
inline QDBusMessage call(MethodType m, T1 t1, T2 t2)
{
QList<QVariant> args;
args << t1 << t2;
return callWithArgs(m, args);
}
/**
* Call the given method.
*/
template<typename MethodType, typename T1, typename T2, typename T3>
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3)
{
QList<QVariant> args;
args << t1 << t2 << t3;
return callWithArgs(m, args);
}
/**
* Call the given method.
*/
template<typename MethodType, typename T1, typename T2, typename T3, typename T4>
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4)
{
QList<QVariant> args;
args << t1 << t2 << t3 << t4;
return callWithArgs(m, args);
}
/**
* Call the given method.
*/
template<typename MethodType, typename T1, typename T2, typename T3, typename T4, typename T5>
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4, T5 t5)
{
QList<QVariant> args;
args << t1 << t2 << t3 << t4 << t5;
return callWithArgs(m, args);
}
/**
* Call the given method.
*/
template<typename MethodType, typename T1, typename T2, typename T3, typename T4, typename T5,
typename T6>
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6)
{
QList<QVariant> args;
args << t1 << t2 << t3 << t4 << t5 << t6;
return callWithArgs(m, args);
}
/**
* Call the given method.
*/
template<typename MethodType, typename T1, typename T2, typename T3, typename T4, typename T5,
typename T6, typename T7>
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7)
{
QList<QVariant> args;
args << t1 << t2 << t3 << t4 << t5 << t6 << t7;
return callWithArgs(m, args);
}
/**
* Call the given method.
*/
template<typename MethodType, typename T1, typename T2, typename T3, typename T4, typename T5,
typename T6, typename T7, typename T8>
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7, T8 t8)
{
QList<QVariant> args;
args << t1 << t2 << t3 << t4 << t5 << t6 << t7 << t8;
return callWithArgs(m, args);
}
private:
QDBusInterface(QDBusInterfacePrivate*);
QDBusInterfacePrivate *d;
};
#endif
|
