Add DBus VirtualObject to handle multiple paths.

When a virtual object is registered with the SubPath option
it will handle all dbus calls to itself and all child paths.
It needs to reimplement handleMessage for that purpose.

Introspection needs to be implemented manually in the introspect function.

Reviewed-by: Thiago Macieira <thiago.macieira@nokia.com>

1 files changed, 97 insertions, 0 deletions

diff --git a/src/dbus/qdbusvirtualobject.cpp b/src/dbus/qdbusvirtualobject.cpp
new file mode 100644
index 0000000..f1c17b5
--- /dev/null
+++ b/src/dbus/qdbusvirtualobject.cpp
@@ -0,0 +1,97 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtDBus module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qdbusvirtualobject.h"
+
+#ifndef QT_NO_DBUS
+
+QT_BEGIN_NAMESPACE
+
+QDBusVirtualObject::QDBusVirtualObject(QObject *parent) :
+    QObject(parent)
+{
+}
+
+QDBusVirtualObject::~QDBusVirtualObject()
+{
+}
+
+QT_END_NAMESPACE
+
+
+/*!
+    \internal
+    \class QDBusVirtualObject
+    \inmodule QtDBus
+    \since 4.8
+
+    \brief The QDBusVirtualObject class is used to handle several DBus paths with one class.
+*/
+
+/*!
+    \internal
+    \fn bool QDBusVirtualObject::handleMessage(const QDBusMessage &message, const QDBusConnection &connection) = 0
+
+    This function needs to handle all messages to the path of the
+    virtual object, when the SubPath option is specified.
+    The service, path, interface and methos are all part of the message.
+    Must return true when the message is handled, otherwise false (will generate dbus error message).
+*/
+
+
+/*!
+    \internal
+    \fn QString QDBusVirtualObject::introspect(const QString &path) const
+
+    This function needs to handle the introspection of the
+    virtual object. It must return xml of the form:
+
+    \code
+<interface name="com.trolltech.QtDBus.MyObject" >
+    <property access="readwrite" type="i" name="prop1" />
+</interface>
+    \endcode
+
+    If you pass the SubPath option, this introspection has to include all child nodes.
+    Otherwise QDBus handles the introspection of the child nodes.
+*/
+
+#endif // QT_NO_DBUS