src/dbus/qdbusvirtualobject.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtDBus module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qdbusvirtualobject.h"
  43
  44 #ifndef QT_NO_DBUS
  45
  46 QT_BEGIN_NAMESPACE
  47
  48 QDBusVirtualObject::QDBusVirtualObject(QObject *parent) :
  49     QObject(parent)
  50 {
  51 }
  52
  53 QDBusVirtualObject::~QDBusVirtualObject()
  54 {
  55 }
  56
  57 QT_END_NAMESPACE
  58
  59
  60 /*!
  61     \internal
  62     \class QDBusVirtualObject
  63     \inmodule QtDBus
  64     \since 4.8
  65
  66     \brief The QDBusVirtualObject class is used to handle several DBus paths with one class.
  67 */
  68
  69 /*!
  70     \internal
  71     \fn bool QDBusVirtualObject::handleMessage(const QDBusMessage &message, const QDBusConnection &connection) = 0
  72
  73     This function needs to handle all messages to the path of the
  74     virtual object, when the SubPath option is specified.
  75     The service, path, interface and methos are all part of the message.
  76     Must return true when the message is handled, otherwise false (will generate dbus error message).
  77 */
  78
  79
  80 /*!
  81     \internal
  82     \fn QString QDBusVirtualObject::introspect(const QString &path) const
  83
  84     This function needs to handle the introspection of the
  85     virtual object. It must return xml of the form:
  86
  87     \code
  88 <interface name="org.qtproject.QtDBus.MyObject" >
  89     <property access="readwrite" type="i" name="prop1" />
  90 </interface>
  91     \endcode
  92
  93     If you pass the SubPath option, this introspection has to include all child nodes.
  94     Otherwise QDBus handles the introspection of the child nodes.
  95 */
  96
  97 #endif // QT_NO_DBUS