QDBusViewer Class Reference

#include <qdbusviewer.h>

Inheritance diagram for QDBusViewer:

[legend]Collaboration diagram for QDBusViewer:

[legend]List of all members.

---

Detailed Description

Definition at line 39 of file qdbusviewer.h.

Public Slots
void	refresh ()
Public Member Functions
	QDBusViewer (const QDBusConnection &connection, QWidget *parent=0)
Private Slots
void	serviceChanged (QTreeWidgetItem *item)
void	showContextMenu (const QPoint &)
void	connectionRequested (const BusSignature &sig)
void	callMethod (const BusSignature &sig)
void	dumpMessage (const QDBusMessage &msg)
void	refreshChildren ()
void	serviceRegistered (const QString &service)
void	serviceUnregistered (const QString &service)
void	serviceOwnerChanged (const QString &name, const QString &oldOwner, const QString &newOwner)
void	activate (const QModelIndex &item)
void	logError (const QString &msg)
Private Member Functions
void	logMessage (const QString &msg)
Private Attributes
QDBusConnection	c
QString	currentService
QTreeView *	tree
QAction *	refreshAction
QTreeWidget *	services
QTextEdit *	log

---

Constructor & Destructor Documentation

QDBusViewer::QDBusViewer	(	const QDBusConnection &	connection,
		QWidget *	parent = 0
	)

Definition at line 47 of file qdbusviewer.cpp.

References activate(), QBoxLayout::addLayout(), QLayout::addWidget(), QBoxLayout::addWidget(), c, QObject::connect(), Qt::CustomContextMenu, QWidget::customContextMenuRequested(), QDBusConnection::interface(), QMetaObject::invokeMethod(), QDBusConnection::isConnected(), QDBusConnection::lastError(), QWidget::layout(), log, logError(), logMessage(), QDBusError::message(), Qt::QueuedConnection, QKeySequence::Refresh, refreshAction, refreshChildren(), serviceChanged(), serviceOwnerChanged(), serviceRegistered(), services, serviceUnregistered(), QWidget::setContextMenuPolicy(), QAction::setData(), QTreeWidget::setHeaderLabels(), QTextEdit::setReadOnly(), QTreeView::setRootIsDecorated(), QAction::setShortcut(), showContextMenu(), SIGNAL, SLOT, and tree.

    : QWidget(parent), c(connection)
{
    services = new QTreeWidget;
    services->setRootIsDecorated(false);
    services->setHeaderLabels(QStringList("Services"));

    tree = new QTreeView;
    tree->setContextMenuPolicy(Qt::CustomContextMenu);

    connect(tree, SIGNAL(activated(const QModelIndex&)), this, SLOT(activate(const QModelIndex&)));

    refreshAction = new QAction(tr("&Refresh"), tree);
    refreshAction->setData(42); // increase the amount of 42 used as magic number by one
    refreshAction->setShortcut(QKeySequence::Refresh);
    connect(refreshAction, SIGNAL(triggered()), this, SLOT(refreshChildren()));

    QShortcut *refreshShortcut = new QShortcut(QKeySequence::Refresh, tree);
    connect(refreshShortcut, SIGNAL(activated()), this, SLOT(refreshChildren()));

    QVBoxLayout *topLayout = new QVBoxLayout(this);
    log = new QTextEdit;
    log->setReadOnly(true);

    QHBoxLayout *layout = new QHBoxLayout;
    layout->addWidget(services, 1);
    layout->addWidget(tree, 2);

    topLayout->addLayout(layout);
    topLayout->addWidget(log);

    connect(services, SIGNAL(currentItemChanged(QTreeWidgetItem*,QTreeWidgetItem*)),
            this, SLOT(serviceChanged(QTreeWidgetItem*)));
    connect(tree, SIGNAL(customContextMenuRequested(QPoint)),
            this, SLOT(showContextMenu(QPoint)));

    QMetaObject::invokeMethod(this, "refresh", Qt::QueuedConnection);

    if (c.isConnected()) {
        logMessage("Connected to D-Bus.");
        QDBusConnectionInterface *iface = c.interface();
        connect(iface, SIGNAL(serviceRegistered(QString)),
                this, SLOT(serviceRegistered(QString)));
        connect(iface, SIGNAL(serviceUnregistered(QString)),
                this, SLOT(serviceUnregistered(QString)));
        connect(iface, SIGNAL(serviceOwnerChanged(QString,QString,QString)),
                this, SLOT(serviceOwnerChanged(QString,QString,QString)));
    } else {
        logError("Cannot connect to D-Bus: " + c.lastError().message());
    }
}

Here is the call graph for this function:

---

Member Function Documentation

void QDBusViewer::refresh

(

)

[slot]

Definition at line 109 of file qdbusviewer.cpp.

References c, QTreeWidget::clear(), QDBusConnection::interface(), QDBusConnectionInterface::registeredServiceNames(), and services.

{
    services->clear();

    const QStringList serviceNames = c.interface()->registeredServiceNames();
    foreach (QString service, serviceNames)
        new QTreeWidgetItem(services, QStringList(service));
}

void QDBusViewer::serviceChanged

(

QTreeWidgetItem *

item

)

[private, slot]

Definition at line 345 of file qdbusviewer.cpp.

References c, QString::clear(), QObject::connect(), currentService, logError(), QAbstractItemView::model(), QTreeView::setModel(), SIGNAL, SLOT, QTreeWidgetItem::text(), and tree.

Referenced by QDBusViewer().

{
    delete tree->model();

    currentService.clear();
    if (!item)
        return;
    currentService = item->text(0);

    tree->setModel(new QDBusViewModel(currentService, c));
    connect(tree->model(), SIGNAL(busError(QString)), this, SLOT(logError(QString)));
}

void QDBusViewer::showContextMenu

(

const QPoint &

)

[private, slot]

Definition at line 218 of file qdbusviewer.cpp.

References QMenu::addAction(), callMethod(), connectionRequested(), currentService, QAction::data(), QDBusModel::dBusInterface(), QDBusModel::dBusMethodName(), QDBusModel::dBusPath(), QMenu::exec(), QTreeView::indexAt(), QModelIndex::isValid(), QDBusModel::itemType(), QWidget::mapToGlobal(), QDBusModel::MethodItem, QModelIndex::model(), refreshAction, QAction::setData(), QDBusModel::SignalItem, QVariant::toInt(), tree, and QAbstractScrollArea::viewport().

Referenced by QDBusViewer().

{
    QModelIndex item = tree->indexAt(point);
    if (!item.isValid())
        return;

    const QDBusModel *model = static_cast<const QDBusModel *>(item.model());

    BusSignature sig;
    sig.mService = currentService;
    sig.mPath = model->dBusPath(item);
    sig.mInterface = model->dBusInterface(item);
    sig.mName = model->dBusMethodName(item);

    QMenu menu;
    menu.addAction(refreshAction);

    switch (model->itemType(item)) {
    case QDBusModel::SignalItem: {
        QAction *action = new QAction("&Connect", &menu);
        action->setData(1);
        menu.addAction(action);
        break; }
    case QDBusModel::MethodItem: {
        QAction *action = new QAction("&Call", &menu);
        action->setData(2);
        menu.addAction(action);
        break; }
#if 0
    case PropertyItem: {
        QAction *actionSet = new QAction("&Set value", &menu);
        actionSet->setData(3);
        QAction *actionGet = new QAction("&Get value", &menu);
        actionGet->setData(4);
        menu.addAction(actionSet);
        menu.addAction(actionGet);
        break; }
#endif
    default:
        break;
    }

    QAction *selectedAction = menu.exec(tree->viewport()->mapToGlobal(point));
    if (!selectedAction)
        return;

    switch (selectedAction->data().toInt()) {
    case 1:
        connectionRequested(sig);
        break;
    case 2:
        callMethod(sig);
        break;
    }
}

void QDBusViewer::connectionRequested

(

const BusSignature &

sig

)

[private, slot]

Definition at line 274 of file qdbusviewer.cpp.

References c, QDBusConnection::connect(), dumpMessage(), logError(), BusSignature::mInterface, BusSignature::mName, BusSignature::mPath, BusSignature::mService, and SLOT.

Referenced by activate(), and showContextMenu().

{
    if (!c.connect(sig.mService, QString(), sig.mInterface, sig.mName, this,
              SLOT(dumpMessage(QDBusMessage)))) {
        logError(QString("Unable to connect to service %1, path %2, interface %3, signal %4").arg(
                    sig.mService).arg(sig.mPath).arg(sig.mInterface).arg(sig.mName));
    }
}

void QDBusViewer::callMethod

(

const BusSignature &

sig

)

[private, slot]

Definition at line 147 of file qdbusviewer.cpp.

References QList< T >::at(), c, QDBusConnection::callWithCallback(), QList< T >::clear(), QVariant::convert(), QList< T >::count(), QDBusMessage::createMethodCall(), dumpMessage(), QByteArray::endsWith(), Qt::escape(), QString::fromLatin1(), QString::fromUtf8(), QInputDialog::getText(), i, QList< T >::isEmpty(), QString::length(), message, QDBusInterface::metaObject(), QMetaObject::method(), method, QMetaObject::methodCount(), BusSignature::mInterface, BusSignature::mName, BusSignature::mPath, BusSignature::mService, QVariant::nameToType(), QLineEdit::Normal, QMetaMethod::signature(), SLOT, QString::split(), QVariant::String, and QMessageBox::warning().

Referenced by activate(), and showContextMenu().

{
    QDBusInterface iface(sig.mService, sig.mPath, sig.mInterface, c);
    const QMetaObject *mo = iface.metaObject();

    // find the method
    QMetaMethod method;
    for (int i = 0; i < mo->methodCount(); ++i) {
        const QString signature = QString::fromLatin1(mo->method(i).signature());
        if (signature.startsWith(sig.mName) && signature.at(sig.mName.length()) == '(')
            method = mo->method(i);
    }
    if (!method.signature()) {
        QMessageBox::warning(this, "Unable to find method",
                QString("Unable to find method %1 on path %2 in interface %3").arg(
                    sig.mName).arg(sig.mPath).arg(sig.mInterface));
        return;
    }

    QList<QByteArray> paramTypes = method.parameterTypes();
    int paramTypeCount = 0;
    foreach (QByteArray paramType, paramTypes) {
        if (paramType.endsWith('&'))
            continue; // ignore OUT parameters

        if (!QVariant(QVariant::nameToType(paramType)).canConvert(QVariant::String)) {
            QMessageBox::warning(this, "Unable to call method",
                    QString("Cannot marshall parameter of type %1").arg(
                        QVariant::nameToType(paramType)));
            return;
        }
        ++paramTypeCount;
    }

    QList<QVariant> arguments;
    if (!paramTypes.isEmpty()) {
        QString input;
        bool ok = true;
        while (arguments.isEmpty()) {
            input = QInputDialog::getText(this, "Arguments",
                    "Please enter the arguments for the call, separated by comma."
                    "<br>Example: <i>hello,world,2.3,-34</i><br><br><b>Signature:</b> "
                    + Qt::escape(QString::fromUtf8(method.signature())),
                    QLineEdit::Normal, input, &ok);
            if (!ok)
                return;

            QStringList argStrings = input.split(',');
            if (argStrings.count() != paramTypeCount)
                continue;

            for (int i = 0; i < argStrings.count(); ++i) {
                if (paramTypes.at(i).endsWith('&'))
                    continue; // ignore OUT paramters

                QVariant v = argStrings.at(i);
                if (!v.convert(QVariant::nameToType(paramTypes.at(i)))) {
                    arguments.clear();
                    break;
                }
                arguments += v;
            }
        }
    }

    QDBusMessage message = QDBusMessage::createMethodCall(sig.mService, sig.mPath, sig.mInterface,
            sig.mName);
    message.setArguments(arguments);
    c.callWithCallback(message, this, SLOT(dumpMessage(QDBusMessage)));
}

void QDBusViewer::dumpMessage

(

const QDBusMessage &

msg

)

[private, slot]

Definition at line 283 of file qdbusviewer.cpp.

References QTextEdit::append(), QString::arg(), QVariant::canConvert(), QString::chop(), QDBusMessage::ErrorMessage, Qt::escape(), QString::fromLatin1(), QList< T >::isEmpty(), log, message, QVariant::Rect, QDBusMessage::ReplyMessage, QDBusMessage::SignalMessage, QVariant::String, QVariant::StringList, QVariant::toRect(), and QVariant::toStringList().

Referenced by callMethod(), and connectionRequested().

{
    QList<QVariant> args = message.arguments();
    QString out = "Received ";

    switch (message.type()) {
    case QDBusMessage::SignalMessage:
        out += "signal ";
        break;
    case QDBusMessage::ErrorMessage:
        out += "error message ";
        break;
    case QDBusMessage::ReplyMessage:
        out += "reply ";
        break;
    default:
        out += "message ";
        break;
    }

    out += "from ";
    out += message.service();
    if (!message.path().isEmpty())
        out += ", path " + message.path();
    if (!message.interface().isEmpty())
        out += ", interface <i>" + message.interface() + "</i>";
    if (!message.member().isEmpty())
        out += ", member " + message.member();
    out += "<br>";
    if (!args.isEmpty()) {
        out += "&nbsp;&nbsp;Parameters: ";
        foreach (QVariant arg, args) {
            if (arg.canConvert(QVariant::StringList)) {
                out += "<b>{</b>";
                QStringList list = arg.toStringList();
                foreach (QString item, list)
                    out += "<b>\"</b>" + Qt::escape(item) + "<b>\"</b>, ";
                if (!list.isEmpty())
                    out.chop(2);
                out += "<b>}</b>";
            } else if (arg.canConvert(QVariant::Rect)) {
                QRect r = arg.toRect();
                out += QString::fromLatin1("QRect(%1, %2, %3, %4)").arg(r.left()).arg(r.top()).arg(
                        r.right()).arg(r.bottom());
            } else if (qVariantCanConvert<QDBusArgument>(arg)) {
                out += "[QDBusArgument: " + qvariant_cast<QDBusArgument>(arg).currentSignature();
                out += "]";
            } else if (arg.canConvert(QVariant::String)) {
                out += "<b>\"</b>" + Qt::escape(arg.toString()) + "<b>\"</b>";
            } else {
                out += "[";
                out += arg.typeName();
                out += "]";
            }
            out += ", ";
        }
        out.chop(2);
    }

    log->append(out);
}

void QDBusViewer::refreshChildren

(

)

[private, slot]

Definition at line 395 of file qdbusviewer.cpp.

References QAbstractItemView::currentIndex(), QAbstractItemView::model(), QDBusModel::refresh(), and tree.

Referenced by QDBusViewer().

{
    QDBusModel *model = qobject_cast<QDBusModel *>(tree->model());
    if (!model)
        return;
    model->refresh(tree->currentIndex());
}

void QDBusViewer::serviceRegistered

(

const QString &

service

)

[private, slot]

Definition at line 358 of file qdbusviewer.cpp.

References QDBusConnection::baseService(), c, and services.

Referenced by QDBusViewer(), and serviceOwnerChanged().

{
    if (service == c.baseService())
        return;

    new QTreeWidgetItem(services, QStringList(service));
}

void QDBusViewer::serviceUnregistered

(

const QString &

service

)

[private, slot]

Definition at line 375 of file qdbusviewer.cpp.

References findItem(), name, and services.

Referenced by QDBusViewer().

{
    delete findItem(services, name);
}

void QDBusViewer::serviceOwnerChanged	(	const QString &	name,
		const QString &	oldOwner,
		const QString &	newOwner
	)			[private, slot]

Definition at line 380 of file qdbusviewer.cpp.

References findItem(), QString::isEmpty(), name, serviceRegistered(), and services.

Referenced by QDBusViewer().

{
    QTreeWidgetItem *item = findItem(services, name);

    if (!item && oldOwner.isEmpty() && !newOwner.isEmpty())
        serviceRegistered(name);
    else if (item && !oldOwner.isEmpty() && newOwner.isEmpty())
        delete item;
    else if (item && !oldOwner.isEmpty() && !newOwner.isEmpty()) {
        delete item;
        serviceRegistered(name);
    }
}

void QDBusViewer::activate

(

const QModelIndex &

item

)

[private, slot]

Definition at line 118 of file qdbusviewer.cpp.

References callMethod(), connectionRequested(), currentService, QDBusModel::dBusInterface(), QDBusModel::dBusMethodName(), QDBusModel::dBusPath(), QModelIndex::isValid(), QDBusModel::itemType(), QDBusModel::MethodItem, QModelIndex::model(), QDBusModel::PropertyItem, and QDBusModel::SignalItem.

Referenced by QDBusViewer().

{
    if (!item.isValid())
        return;

    const QDBusModel *model = static_cast<const QDBusModel *>(item.model());

    BusSignature sig;
    sig.mService = currentService;
    sig.mPath = model->dBusPath(item);
    sig.mInterface = model->dBusInterface(item);
    sig.mName = model->dBusMethodName(item);

    switch (model->itemType(item)) {
    case QDBusModel::SignalItem:
        connectionRequested(sig);
        break;
    case QDBusModel::MethodItem:
        callMethod(sig);
        break;
#if 0
    case QDBusModel::PropertyItem:
        break;
#endif
    default:
        break;
    }
}

void QDBusViewer::logError

(

const QString &

msg

)

[private, slot]

Definition at line 104 of file qdbusviewer.cpp.

References QTextEdit::append(), Qt::escape(), and log.

Referenced by connectionRequested(), QDBusViewer(), and serviceChanged().

{
    log->append("<font color=\"red\">Error: </font>" + Qt::escape(msg) + "<br>");
}

void QDBusViewer::logMessage

(

const QString &

msg

)

[private]

Definition at line 99 of file qdbusviewer.cpp.

References QTextEdit::append(), and log.

Referenced by QDBusViewer().

{
    log->append(msg + "\n");
}

---

Member Data Documentation

QDBusConnection QDBusViewer::c [private]

Definition at line 67 of file qdbusviewer.h.

Referenced by callMethod(), connectionRequested(), QDBusViewer(), refresh(), serviceChanged(), and serviceRegistered().

QString QDBusViewer::currentService [private]

Definition at line 68 of file qdbusviewer.h.

Referenced by activate(), serviceChanged(), and showContextMenu().

QTreeView* QDBusViewer::tree [private]

Definition at line 69 of file qdbusviewer.h.

Referenced by QDBusViewer(), refreshChildren(), serviceChanged(), and showContextMenu().

QAction* QDBusViewer::refreshAction [private]

Definition at line 70 of file qdbusviewer.h.

Referenced by QDBusViewer(), and showContextMenu().

QTreeWidget* QDBusViewer::services [private]

Definition at line 71 of file qdbusviewer.h.

Referenced by QDBusViewer(), refresh(), serviceOwnerChanged(), serviceRegistered(), and serviceUnregistered().

QTextEdit* QDBusViewer::log [private]

Definition at line 72 of file qdbusviewer.h.

Referenced by dumpMessage(), logError(), logMessage(), and QDBusViewer().

---

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

• demos/dbus-viewer/qdbusviewer.h
• demos/dbus-viewer/qdbusviewer.cpp

---