1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtDBus module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qdbusvirtualobject.h"
41
42#ifndef QT_NO_DBUS
43
44QT_BEGIN_NAMESPACE
45
46/*!
47 Constructs a QDBusVirtualObject with \a parent.
48*/
49QDBusVirtualObject::QDBusVirtualObject(QObject *parent) :
50 QObject(parent)
51{
52}
53
54/*!
55 Destroys the object, deleting all of its child objects.
56*/
57QDBusVirtualObject::~QDBusVirtualObject()
58{
59}
60
61QT_END_NAMESPACE
62
63
64/*!
65 \class QDBusVirtualObject
66 \inmodule QtDBus
67 \since 5.1
68
69 \brief The QDBusVirtualObject class is used to handle several DBus paths with one class.
70*/
71
72/*!
73 \fn bool QDBusVirtualObject::handleMessage(const QDBusMessage &message, const QDBusConnection &connection) = 0
74
75 This function needs to handle all messages to the path of the
76 virtual object, when the SubPath option is specified.
77 The service, path, interface and methos are all part of the \a message.
78 Parameter \a connection is the connection handle.
79 Must return \c true when the message is handled, otherwise \c false (will generate dbus error message).
80*/
81
82
83/*!
84 \fn QString QDBusVirtualObject::introspect(const QString &path) const
85
86 This function needs to handle the introspection of the
87 virtual object on \a path. It must return xml of the form:
88
89 \code
90<interface name="org.qtproject.QtDBus.MyObject" >
91 <property access="readwrite" type="i" name="prop1" />
92</interface>
93 \endcode
94
95 If you pass the SubPath option, this introspection has to include all child nodes.
96 Otherwise QDBus handles the introspection of the child nodes.
97*/
98
99#endif // QT_NO_DBUS
100

source code of qtbase/src/dbus/qdbusvirtualobject.cpp