summaryrefslogtreecommitdiffstats
path: root/qt/qdbusinterface.h
blob: 966a4705760d4cad14803a412c59ed281221ea3f (plain)
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
/* -*- 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 "qdbusreply.h"
#include "qdbusvariant.h"
#include <QtCore/qstring.h>
#include <QtCore/qvariant.h>
#include <QtCore/qlist.h>

class QDBusConnection;

class QDBusInterfacePrivate;
class QDBUS_EXPORT QDBusInterface
{
    friend class QDBusConnection;

public:
    enum CallMode {
        WaitForReply,
        NoWaitForReply
    };

public:
    QDBusInterface(const QDBusObject& obj, const QString& name);
    QDBusInterface(const QDBusInterface&);
    virtual ~QDBusInterface();

    QDBusInterface& operator=(const QDBusInterface&);
    
    inline QDBusObject object()
    { return QDBusObject(*this); }

    inline const QDBusObject object() const
    { return QDBusObject(*this); }

    inline operator QDBusObject()
    { return QDBusObject(*this); }

    inline operator const QDBusObject() const
    { return QDBusObject(*this); }

    
    QDBusConnection connection() const;

    QString service() const;
    QString path() const;
    QString interface() const;

    virtual QString introspectionData() const;
    const QDBusIntrospection::Interface& interfaceData() const;
    const QDBusIntrospection::Annotations& annotationData() const;
    const QDBusIntrospection::Methods& methodData() const;
    const QDBusIntrospection::Signals& signalData() const;
    const QDBusIntrospection::Properties& propertyData() const;

    QDBusMessage callWithArgs(const QDBusIntrospection::Method& method,
                              const QList<QVariant>& args = QList<QVariant>(),
                              CallMode mode = WaitForReply);
    QDBusMessage callWithArgs(const QString& method, const QList<QVariant>& args = QList<QVariant>(),
                              CallMode mode = WaitForReply);
    QDBusMessage callWithArgs(const QString& method, const QString& signature,
                              const QList<QVariant>& args = QList<QVariant>(),
                              CallMode mode = WaitForReply);
   
    bool connect(const QDBusIntrospection::Signal&, QObject* obj, const char *slot);
    bool connect(const QString& signalName, QObject* obj, const char *slot);
    bool connect(const QString& signalName, const QString& signature,
                 QObject* obj, const char *slot);

    QDBusReply<QDBusVariant> property(const QDBusIntrospection::Property&);
    QDBusReply<QDBusVariant> property(const QString& property);

    QDBusReply<void> setProperty(const QDBusIntrospection::Property&, const QDBusVariant& newValue);
    QDBusReply<void> setProperty(const QString& property, const QDBusVariant& newValue);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    template<typename MethodType>
    inline QDBusMessage call(MethodType m)
    {
        return callWithArgs(m);
    }

    template<typename MethodType, typename T1>
        inline QDBusMessage call(MethodType m, T1 t1)
    {
        QList<QVariant> args;
        args << t1;
        return callWithArgs(m, args);
    }

    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);
    }

    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);
    }
      
    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);
    }

    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);
    }
  
    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);
    }

    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);
    }

    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);
    }
#else
    // fool Doxygen
    inline QDBusMessage call(const QDBusIntrospection::Method &method, ...);
    inline QDBusMessage call(const QString &method, ...);
#endif

private:
    QDBusInterface(QDBusInterfacePrivate*);
    QDBusInterfacePrivate *d;
};

#endif