1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtDBus module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
42 #ifndef QDBUSMESSAGE_H
43 #define QDBUSMESSAGE_H
45 #include <QtDBus/qdbusmacros.h>
46 #include <QtDBus/qdbuserror.h>
47 #include <QtCore/qlist.h>
48 #include <QtCore/qvariant.h>
57 class QDBusMessagePrivate;
58 class Q_DBUS_EXPORT QDBusMessage
70 QDBusMessage(const QDBusMessage &other);
71 QDBusMessage &operator=(const QDBusMessage &other);
74 static QDBusMessage createSignal(const QString &path, const QString &interface,
76 static QDBusMessage createMethodCall(const QString &destination, const QString &path,
77 const QString &interface, const QString &method);
78 static QDBusMessage createError(const QString &name, const QString &msg);
79 static inline QDBusMessage createError(const QDBusError &err)
80 { return createError(err.name(), err.message()); }
81 static inline QDBusMessage createError(QDBusError::ErrorType type, const QString &msg)
82 { return createError(QDBusError::errorString(type), msg); }
84 QDBusMessage createReply(const QList<QVariant> &arguments = QList<QVariant>()) const;
85 inline QDBusMessage createReply(const QVariant &argument) const
86 { return createReply(QList<QVariant>() << argument); }
88 QDBusMessage createErrorReply(const QString name, const QString &msg) const;
89 inline QDBusMessage createErrorReply(const QDBusError &err) const
90 { return createErrorReply(err.name(), err.message()); }
91 QDBusMessage createErrorReply(QDBusError::ErrorType type, const QString &msg) const;
93 // there are no setters; if this changes, see qdbusmessage_p.h
94 QString service() const;
96 QString interface() const;
97 QString member() const;
98 QString errorName() const;
99 QString errorMessage() const;
100 MessageType type() const;
101 QString signature() const;
103 bool isReplyRequired() const;
105 void setDelayedReply(bool enable) const;
106 bool isDelayedReply() const;
108 void setAutoStartService(bool enable);
109 bool autoStartService() const;
111 void setArguments(const QList<QVariant> &arguments);
112 QList<QVariant> arguments() const;
114 QDBusMessage &operator<<(const QVariant &arg);
117 friend class QDBusMessagePrivate;
118 QDBusMessagePrivate *d_ptr;
121 #ifndef QT_NO_DEBUG_STREAM
122 Q_DBUS_EXPORT QDebug operator<<(QDebug, const QDBusMessage &);
127 Q_DECLARE_METATYPE(QDBusMessage)