QDBusAbstractAdaptor Class Reference

#include <qdbusabstractadaptor.h>

Inheritance diagram for QDBusAbstractAdaptor:

[legend]Collaboration diagram for QDBusAbstractAdaptor:

[legend]List of all members.

---

Detailed Description

The QDBusAbstractAdaptor class is the base class of D-Bus adaptor classes.

QtDBus

Since:

4.2

The QDBusAbstractAdaptor class is the starting point for all objects intending to provide interfaces to the external world using D-Bus. This is accomplished by attaching a one or more classes derived from QDBusAbstractAdaptor to a normal QObject and then registering that QObject with QDBusConnection::registerObject. QDBusAbstractAdaptor objects are intended to be light-weight wrappers, mostly just relaying calls into the real object (its parent) and the signals from it.

Each QDBusAbstractAdaptor-derived class should define the D-Bus interface it is implementing using the Q_CLASSINFO macro in the class definition.

QDBusAbstractAdaptor uses the standard QObject mechanism of signals, slots and properties to determine what signals, methods and properties to export to the bus. Any signal emitted by QDBusAbstractAdaptor-derived classes will be automatically be relayed through any D-Bus connections the object is registered on.

Classes derived from QDBusAbstractAdaptor must be created on the heap using the new operator and must not be deleted by the user (they will be deleted automatically when the object they are connected to is also deleted).

See also:

{usingadaptors.html}{Using adaptors}, QDBusConnection

Definition at line 34 of file qdbusabstractadaptor.h.

Public Member Functions
	~QDBusAbstractAdaptor ()
Protected Member Functions
	QDBusAbstractAdaptor (QObject *parent)
void	setAutoRelaySignals (bool enable)
bool	autoRelaySignals () const

---

Constructor & Destructor Documentation

QDBusAbstractAdaptor::QDBusAbstractAdaptor

(

QObject *

obj

)

[protected]

Constructs a QDBusAbstractAdaptor with obj as the parent object.

Definition at line 111 of file qdbusabstractadaptor.cpp.

References QCoreApplication::instance(), QMetaObject::invokeMethod(), qDBusCreateAdaptorConnector(), Qt::QueuedConnection, QObject::thread(), and QDBusAdaptorConnector::waitingForPolish.

    : QObject(*new QDBusAbstractAdaptorPrivate, obj)
{
    Q_ASSERT_X(QCoreApplication::instance() == 0 ||
               thread() == QCoreApplication::instance()->thread(),
               "QDBusAbstractAdaptor", "D-BUS Adaptors must be created in the main thread");

    QDBusAdaptorConnector *connector = qDBusCreateAdaptorConnector(obj);

    connector->waitingForPolish = true;
    QMetaObject::invokeMethod(connector, "polish", Qt::QueuedConnection);
}

Here is the call graph for this function:

QDBusAbstractAdaptor::~QDBusAbstractAdaptor

(

)

Destroys the adaptor.

Warning:

Adaptors are destroyed automatically when the real object they refer to is destroyed. Do not delete the adaptors yourself.

Definition at line 130 of file qdbusabstractadaptor.cpp.

{
}

---

Member Function Documentation

void QDBusAbstractAdaptor::setAutoRelaySignals

(

bool

enable

)

[protected]

Toggles automatic signal relaying from the real object (see object()).

Automatic signal relaying consists of signal-to-signal connection of the signals on the parent that have the exact same method signatue in both classes.

If enable is set to true, connect the signals; if set to false, disconnect all signals.

Definition at line 142 of file qdbusabstractadaptor.cpp.

References QObject::connect(), QObject::disconnect(), QMetaObject::indexOfSignal(), QMetaObject::method(), QMetaObject::methodCount(), QMetaObject::normalizedSignature(), QObject::parent(), QByteArray::prepend(), QSIGNAL_CODE, and QMetaMethod::Signal.

{
    const QMetaObject *us = metaObject();
    const QMetaObject *them = parent()->metaObject();
    bool connected = false;
    for (int idx = staticMetaObject.methodCount(); idx < us->methodCount(); ++idx) {
        QMetaMethod mm = us->method(idx);

        if (mm.methodType() != QMetaMethod::Signal)
            continue;

        // try to connect/disconnect to a signal on the parent that has the same method signature
        QByteArray sig = QMetaObject::normalizedSignature(mm.signature());
        if (them->indexOfSignal(sig) == -1)
            continue;
        sig.prepend(QSIGNAL_CODE + '0');
        parent()->disconnect(sig, this, sig);
        if (enable)
            connected = connect(parent(), sig, sig) || connected;
    }
    d_func()->autoRelaySignals = connected;
}

Here is the call graph for this function:

bool QDBusAbstractAdaptor::autoRelaySignals

(

)

const [protected]

Returns true if automatic signal relaying from the real object (see object()) is enabled, otherwiser returns false.

See also:

setAutoRelaySignals()

Definition at line 171 of file qdbusabstractadaptor.cpp.

{
    return d_func()->autoRelaySignals;
}

---

The documentation for this class was generated from the following files:

• tools/qdbus/src/qdbusabstractadaptor.h
• tools/qdbus/src/qdbusabstractadaptor.cpp

---