mirror of
https://gitlab.freedesktop.org/dbus/dbus.git
synced 2026-05-01 04:28:01 +02:00
c2432800b1
This is a major change: library is source- and binary-incompatible to what it used to be. All testcases are green, functionality is preserved. It is not feature-complete. Development will continue in the branch in the Subversion server for a while.
310 lines
8.3 KiB
C++
310 lines
8.3 KiB
C++
/* -*- C++ -*-
|
|
*
|
|
* Copyright (C) 2005 Thiago Macieira <thiago@kde.org>
|
|
* Copyright (C) 2006 Trolltech AS. All rights reserved.
|
|
* Author: Thiago Macieira <thiago.macieira@trolltech.com>
|
|
*
|
|
* Licensed under the Academic Free License version 2.1
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef QDBUSINTERFACE_H
|
|
#define QDBUSINTERFACE_H
|
|
|
|
#include "qdbusmessage.h"
|
|
#include "qdbusobject.h"
|
|
#include "qdbusintrospection.h"
|
|
#include <QtCore/qstring.h>
|
|
#include <QtCore/qvariant.h>
|
|
#include <QtCore/qlist.h>
|
|
|
|
class QDBusConnection;
|
|
|
|
class QDBusInterfacePrivate;
|
|
/**
|
|
* Base class for all DBUS interfaces in the QtDBUS binding.
|
|
*/
|
|
class QDBUS_EXPORT QDBusInterface
|
|
{
|
|
friend class QDBusConnection;
|
|
|
|
public:
|
|
enum CallMode {
|
|
WaitForReply,
|
|
NoWaitForReply
|
|
};
|
|
|
|
public:
|
|
/**
|
|
* Construct an interface of the given name
|
|
*/
|
|
QDBusInterface(const QDBusObject& obj, const QString& name);
|
|
|
|
/**
|
|
* @overload.
|
|
* Construct an interface of the given name
|
|
*/
|
|
QDBusInterface(QDBusConnection& conn, const QString& service, const QString& path, const QString& name);
|
|
|
|
/**
|
|
* Construct a copy of the interface.
|
|
*/
|
|
QDBusInterface(const QDBusInterface&);
|
|
|
|
/**
|
|
* Destructs this interface.
|
|
*/
|
|
virtual ~QDBusInterface();
|
|
|
|
/**
|
|
* Copy the interface.
|
|
*/
|
|
QDBusInterface& operator=(const QDBusInterface&);
|
|
|
|
/**
|
|
* Returns the object associated with this interface.
|
|
*/
|
|
inline QDBusObject object()
|
|
{ return QDBusObject(*this); }
|
|
|
|
inline const QDBusObject object() const
|
|
{ return QDBusObject(*this); }
|
|
|
|
/**
|
|
* Returns the connection this interface is on.
|
|
*/
|
|
QDBusConnection connection() const;
|
|
|
|
/**
|
|
* Returns the name of the service this interface is associated with.
|
|
*/
|
|
QString service() const;
|
|
|
|
/**
|
|
* Returns the object path that this interface is associated with.
|
|
*/
|
|
QString path() const;
|
|
|
|
/**
|
|
* Returns the name of this interface.
|
|
*/
|
|
QString interface() const;
|
|
|
|
/**
|
|
* Returns the introspection XML fragment data of this interface.
|
|
*/
|
|
virtual QString introspectionData() const;
|
|
|
|
/**
|
|
* Returns the interface data for this interface.
|
|
*/
|
|
const QDBusIntrospection::Interface& interfaceData() const;
|
|
|
|
/**
|
|
* Returns the annotations present in this interface, if any.
|
|
*/
|
|
const QDBusIntrospection::Annotations& annotationData() const;
|
|
|
|
/**
|
|
* List all methods in this interface.
|
|
*/
|
|
const QDBusIntrospection::Methods& methodData() const;
|
|
|
|
/**
|
|
* List all signals in this interface.
|
|
*/
|
|
const QDBusIntrospection::Signals& signalData() const;
|
|
|
|
/**
|
|
* List all properties in this interface.
|
|
*/
|
|
const QDBusIntrospection::Properties& propertyData() const;
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
QDBusMessage callWithArgs(const QDBusIntrospection::Method& method,
|
|
const QList<QVariant>& args = QList<QVariant>(),
|
|
CallMode mode = WaitForReply);
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
QDBusMessage callWithArgs(const QString& method, const QList<QVariant>& args = QList<QVariant>(),
|
|
CallMode mode = WaitForReply);
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
QDBusMessage callWithArgs(const QString& method, const QString& signature,
|
|
const QList<QVariant>& args = QList<QVariant>(),
|
|
CallMode mode = WaitForReply);
|
|
|
|
/**
|
|
* Connects the DBUS signal to the given slot.
|
|
*/
|
|
bool connect(const QDBusIntrospection::Signal&, QObject* obj, const char *slot);
|
|
|
|
/**
|
|
* Connects the DBUS signal to the given slot.
|
|
*/
|
|
bool connect(const QString& signalName, QObject* obj, const char *slot);
|
|
|
|
/**
|
|
* Connects the DBUS signal to the given slot.
|
|
*/
|
|
bool connect(const QString& signalName, const QString& signature,
|
|
QObject* obj, const char *slot);
|
|
|
|
/**
|
|
* Gets the value of the given property.
|
|
*/
|
|
QVariant propertyGet(const QDBusIntrospection::Property&);
|
|
|
|
/**
|
|
* Gets the value of the given property.
|
|
*/
|
|
QVariant propertyGet(const QString& property);
|
|
|
|
/**
|
|
* Sets the value of the given property.
|
|
*/
|
|
void propertySet(const QDBusIntrospection::Property&, QVariant newValue);
|
|
|
|
/**
|
|
* Sets the value of the given property.
|
|
*/
|
|
void propertySet(const QString& property, QVariant newValue);
|
|
|
|
/**
|
|
* Casts to QDBusObject.
|
|
*/
|
|
inline operator QDBusObject()
|
|
{ return QDBusObject(*this); }
|
|
|
|
/**
|
|
* Casts to const QDBusObject.
|
|
*/
|
|
inline operator const QDBusObject() const
|
|
{ return QDBusObject(*this); }
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
template<typename MethodType>
|
|
inline QDBusMessage call(MethodType m)
|
|
{
|
|
return callWithArgs(m);
|
|
}
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
template<typename MethodType, typename T1>
|
|
inline QDBusMessage call(MethodType m, T1 t1)
|
|
{
|
|
QList<QVariant> args;
|
|
args << t1;
|
|
return callWithArgs(m, args);
|
|
}
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
template<typename MethodType, typename T1, typename T2>
|
|
inline QDBusMessage call(MethodType m, T1 t1, T2 t2)
|
|
{
|
|
QList<QVariant> args;
|
|
args << t1 << t2;
|
|
return callWithArgs(m, args);
|
|
}
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
template<typename MethodType, typename T1, typename T2, typename T3>
|
|
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3)
|
|
{
|
|
QList<QVariant> args;
|
|
args << t1 << t2 << t3;
|
|
return callWithArgs(m, args);
|
|
}
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
template<typename MethodType, typename T1, typename T2, typename T3, typename T4>
|
|
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4)
|
|
{
|
|
QList<QVariant> args;
|
|
args << t1 << t2 << t3 << t4;
|
|
return callWithArgs(m, args);
|
|
}
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
template<typename MethodType, typename T1, typename T2, typename T3, typename T4, typename T5>
|
|
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4, T5 t5)
|
|
{
|
|
QList<QVariant> args;
|
|
args << t1 << t2 << t3 << t4 << t5;
|
|
return callWithArgs(m, args);
|
|
}
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
template<typename MethodType, typename T1, typename T2, typename T3, typename T4, typename T5,
|
|
typename T6>
|
|
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6)
|
|
{
|
|
QList<QVariant> args;
|
|
args << t1 << t2 << t3 << t4 << t5 << t6;
|
|
return callWithArgs(m, args);
|
|
}
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
template<typename MethodType, typename T1, typename T2, typename T3, typename T4, typename T5,
|
|
typename T6, typename T7>
|
|
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7)
|
|
{
|
|
QList<QVariant> args;
|
|
args << t1 << t2 << t3 << t4 << t5 << t6 << t7;
|
|
return callWithArgs(m, args);
|
|
}
|
|
|
|
/**
|
|
* Call the given method.
|
|
*/
|
|
template<typename MethodType, typename T1, typename T2, typename T3, typename T4, typename T5,
|
|
typename T6, typename T7, typename T8>
|
|
inline QDBusMessage call(MethodType m, T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7, T8 t8)
|
|
{
|
|
QList<QVariant> args;
|
|
args << t1 << t2 << t3 << t4 << t5 << t6 << t7 << t8;
|
|
return callWithArgs(m, args);
|
|
}
|
|
|
|
private:
|
|
QDBusInterface(QDBusInterfacePrivate*);
|
|
QDBusInterfacePrivate *d;
|
|
};
|
|
|
|
#endif
|