summaryrefslogtreecommitdiffstats
path: root/qt/qdbusobject.h
blob: ffb41add6d9012fdc732f0c3bdfdbc4d9d23a953 (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
/* -*- 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 QDBUSOBJECT_H
#define QDBUSOBJECT_H

#include <QtCore/qstring.h>
#include <QtCore/qvariant.h>
#include <QtCore/qlist.h>
#include <QtCore/qshareddata.h>

#include "qdbusconnection.h"
#include "qdbusintrospection.h"

class QDBusInterface;
class QDBusObject;

template<class Interface>
inline Interface qdbus_cast(QDBusObject& obj, Interface * = 0);

template<class Interface>
inline const Interface qdbus_cast(const QDBusObject& obj, Interface * = 0);

class QDBusObjectPrivate;
/**
 * QDBusObject
 * Base object for DBUS objects imported and exported.
 */
class QDBUS_EXPORT QDBusObject
{
    friend class QDBusConnection;
public:
    // public constructors
    /**
     * Construct a QDBusObject referencing the remote object given.
     */
    QDBusObject(const QDBusConnection& conn, const QString& service, const QString& path);    

    /**
     * Copy constructor.
     */
    QDBusObject(const QDBusObject& other);

    /**
     * Construct from an interface.
     */
    QDBusObject(const QDBusInterface& iface);

    // public destructors
    /**
     * Destructor.
     */
    ~QDBusObject();

public:
    // public functions

    /**
     * Assignment operator
     */
    QDBusObject& operator=(const QDBusObject&);

    /**
     * Returns the connection this object is bound to.
     */
    QDBusConnection connection() const;

    /**
     * Returns the service this object is associated to.
     */
    QString service() const;

    /**
     * Returns the path on the service this object is on.
     */
    QString path() const;

    /**
     * Returns the introspection XML data of this object node.
     */
    QString introspect() const;

    /**
     * Returns the introspection data for this object node.
     */
    QSharedDataPointer<QDBusIntrospection::Object> introspectionData() const;

    /**
     * Returns all the interfaces in this object.
     */
    QStringList interfaces() const;

    /**
     * Returns all the children object in this object.
     */
    QMap<QString, QDBusObject> children() const;

    /**
     * Returns true if the object being referenced exists.
     */
    //bool exists() const;

    /**
     * Returns true if we're referencing a valid object.
     */
    bool isValid() const;

    /**
     * Cast this object to an interface, if possible.
     */
    template<typename Interface>
        inline operator Interface()
    { return qdbus_cast<Interface>(*this); }

    /**
     * Cast this object to an interface, if possible.
     */
    template<typename Interface>
        inline operator const Interface() const
    { return qdbus_cast<Interface>(*this); }
    
private:
    QDBusObject(QDBusObjectPrivate*, const QDBusConnection& conn);
    QSharedDataPointer<QDBusObjectPrivate> d;
    QDBusConnection m_conn;
};

template<class Interface>
inline Interface qdbus_cast(QDBusObject& obj, Interface *)
{
    return Interface(obj);
}

template<class Interface>
inline const Interface qdbus_cast(const QDBusObject& obj, Interface *)
{
    return Interface(obj);
}

#endif // QDBUSOBJECT_H