Qt 4.7: D-Bus Adaptor Example

Qt Reference Documentation

[Previous: The QtDBus Type System]

# D-Bus Adaptor Example

The following example code shows how a D-Bus interface can be implemented using an adaptor.

A sample usage of QDBusAbstractAdaptor is as follows:

     class MainApplicationAdaptor: public QDBusAbstractAdaptor
     {
         Q_OBJECT
         Q_CLASSINFO("D-Bus Interface", "org.kde.DBus.MainApplication")
         Q_PROPERTY(QString caption READ caption WRITE setCaption)
         Q_PROPERTY(QString organizationName READ organizationName)
         Q_PROPERTY(QString organizationDomain READ organizationDomain)

     private:
         QApplication *app;

     public:
         MainApplicationAdaptor(QApplication *application)
             : QDBusAbstractAdaptor(application), app(application)
         {
             connect(application, SIGNAL(aboutToQuit()), SIGNAL(aboutToQuit()));
             connect(application, SIGNAL(focusChanged(QWidget*, QWidget*)),
                     SLOT(focusChangedSlot(QWidget*, QWidget*)));
         }

         QString caption()
         {
             if (app->hasMainWindow())
                 return app->mainWindow()->caption();
             return QString(""); // must not return a null QString
         }

         void setCaption(const QString &newCaption)
         {
             if (app->hasMainWindow())
                 app->mainWindow()->setCaption(newCaption);
         }

         QString organizationName()
         {
             return app->organizationName();
         }

         QString organizationDomain()
         {
             return app->organizationDomain();
         }

     public slots:
         Q_NOREPLY void quit()
         { app->quit(); }

         void reparseConfiguration()
         { app->reparseConfiguration(); }

         QString mainWindowObject()
         {
             if (app->hasMainWindow())
                 return QString("/%1/mainwindow").arg(app->applicationName());
             return QString();
         }

         void setSessionManagement(bool enable)
         {
             if (enable)
                app->enableSessionManagement();
             else
                app->disableSessionManagement();
         }

     private slots:
         void focusChangedSlot(QWidget *, QWidget *now)
         {
             if (now == app->mainWindow())
                 emit mainWindowHasFocus();
         }

     signals:
         void aboutToQuit();
         void mainWindowHasFocus();
     };

The code above would create an interface that could be represented more or less in the following canonical representation:

     interface org.kde.DBus.MainApplication
     {
         property readwrite STRING caption
         property read STRING organizationName
         property read STRING organizationDomain

         method quit() annotation("org.freedesktop.DBus.Method.NoReply", "true")
         method reparseConfiguration()
         method mainWindowObject(out STRING)
         method disableSessionManagement(in BOOLEAN enable)

         signal aboutToQuit()
         signal mainWindowHasFocus()
     }

This adaptor could be used in the application's main function as follows

     int main(int argc, char **argv)
     {
         // create the QApplication object
         QApplication app(argc, argv);

         // create the MainApplication adaptor:
         new MainApplicationAdaptor(app);

         // connect to D-Bus and register as an object:
         QDBusConnection::sessionBus().registerObject("/MainApplication", app);

         // add main window, etc.
         [...]

         app.exec();
     }

Break-down analysis:

## The header

The header of the example is:

     class MainApplicationAdaptor: public QDBusAbstractAdaptor
     {
         Q_OBJECT
         Q_CLASSINFO("D-Bus Interface", "org.kde.DBus.MainApplication")

The code does the following:

- it declares the adaptor MainApplicationAdaptor, which descends from QDBusAbstractAdaptor
- it declares the Qt meta-object data using the Q_OBJECT macro
- it declares the name of the D-Bus interface it implements.

## The properties

The properties are declared as follows:

         Q_PROPERTY(QString caption READ caption WRITE setCaption)
         Q_PROPERTY(QString organizationName READ organizationName)
         Q_PROPERTY(QString organizationDomain READ organizationDomain)

And are implemented as follows:

     QString caption()
     {
         if (app->hasMainWindow())
             return app->mainWindow()->caption();
         return QString();
     }

     void setCaption(const QString &newCaption)
     {
         if (app->hasMainWindow())
             app->mainWindow()->setCaption(newCaption);
     }

     QString organizationName()
     {
         return app->organizationName();
     }

     QString organizationDomain()
     {
         return app->organizationDomain();
     }

The code declares three properties: one of them is a read-write property called "caption" of string type. The other two are read-only, also of the string type.

The properties organizationName and organizationDomain are simple relays of the app object's organizationName and organizationDomain properties. However, the caption property requires verifying if the application has a main window associated with it: if there isn't any, the caption property is empty. Note how it is possible to access data defined in other objects through the getter/setter functions.

## The constructor

The constructor:

     MyInterfaceAdaptor(QApplication *application)
         : QDBusAbstractAdaptor(application), app(application)
     {
         connect(application, SIGNAL(aboutToQuit()), SIGNAL(aboutToQuit());
         connect(application, SIGNAL(focusChanged(QWidget*, QWidget*)),
                 SLOT(focusChangedSlot(QWidget*, QWidget*)));
     }

The constructor does the following:

- it initialises its base class (QDBusAbstractAdaptor) with the parent object it is related to.
- it stores the app pointer in a member variable. Note that it would be possible to access the same object using the QDBusAbstractAdaptor::object() function, but it would be necessary to use static_cast<> to properly access the methods in QApplication that are not part of QObject.
- it connects the application's signal aboutToQuit to its own signal aboutToQuit.
- it connects the application's signal focusChanged to a private slot to do some further processing before emitting a D-Bus signal.

Note that there is no destructor in the example. An eventual destructor could be used to emit one last signal before the object is destroyed, for instance.

## Slots/methods

The public slots in the example (which will be exported as D-Bus methods) are the following:

     public slots:
         Q_NOREPLY void quit()
         { app->quit(); }

         void reparseConfiguration()
         { app->reparseConfiguration(); }

         QString mainWindowObject()
         {
             if (app->hasMainWindow())
                 return QString("/%1/mainwindow").arg(app->applicationName());
             return QString();
         }

         void setSessionManagement(bool enable)
         {
             if (enable)
                app->enableSessionManagement();
             else
                app->disableSessionManagement();
         }

This snippet of code defines 4 methods with different properties each:

1. `quit`: this method takes no parameters and is defined to be asynchronous. That is, callers are expected to use "fire-and-forget" mechanism when calling this method, since it provides no useful reply. This is represented in D-Bus by the use of the org.freedesktop.DBus.Method.NoReply annotation. See Q_NOREPLY for more information on asynchronous methods
2. `reparseConfiguration`: this simple method, with no input or output arguments simply relays the call to the application's reparseConfiguration member function.
3. `mainWindowObject`: this method takes no input parameter, but returns one string output argument, containing the path to the main window object (if the application has a main window), or an empty string if it has no main window. Note that this method could have also been written: void mainWindowObject(QString &path).
4. `setSessionManagement`: this method takes one input argument (a boolean) and, depending on its value, it calls one function or another in the application.

See also: Q_NOREPLY.

## Signals

The signals in this example are defined as follows:

     signals:
         void aboutToQuit();
         void mainWindowHasFocus();

However, signal definition isn't enough: signals have to be emitted. One simple way of emitting signals is to connect another signal to them, so that Qt's signal handling system chains them automatically. This is what is done for the aboutToQuit signal.

When this is the case, one can use the QDBusAbstractAdaptor::setAutoRelaySignals to automatically connect every signal from the real object to the adaptor.

When simple signal-to-signal connection isn't enough, one can use a private slot do do some work. This is what was done for the mainWindowHasFocus signal:

     private slots:
         void focusChangedSlot(QWidget *, QWidget *now)
         {
             if (now == app->mainWindow())
                 emit mainWindowHasFocus();
         }

This private slot (which will not be exported as a method via D-Bus) was connected to the `focusChanged` signal in the adaptor's constructor. It is therefore able to shape the application's signal into what the interface expects it to be.

[Previous: The QtDBus Type System]