1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtDBus module of the Qt Toolkit.
7**
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QDBUSMESSAGE_H
41#define QDBUSMESSAGE_H
42
43#include <QtDBus/qtdbusglobal.h>
44#include <QtDBus/qdbuserror.h>
45#include <QtCore/qlist.h>
46#include <QtCore/qvariant.h>
47
48#if !defined(QT_NO_DBUS) && !defined(QT_BOOTSTRAPPED)
49
50#if defined(Q_OS_WIN) && defined(interface)
51# undef interface
52#endif
53
54QT_BEGIN_NAMESPACE
55
56class QDBusMessagePrivate;
57class Q_DBUS_EXPORT QDBusMessage
58{
59public:
60 enum MessageType {
61 InvalidMessage,
62 MethodCallMessage,
63 ReplyMessage,
64 ErrorMessage,
65 SignalMessage
66 };
67
68 QDBusMessage();
69 QDBusMessage(const QDBusMessage &other);
70 QDBusMessage &operator=(QDBusMessage &&other) noexcept { swap(other); return *this; }
71 QDBusMessage &operator=(const QDBusMessage &other);
72 ~QDBusMessage();
73
74 void swap(QDBusMessage &other) noexcept { qSwap(d_ptr, other.d_ptr); }
75
76 static QDBusMessage createSignal(const QString &path, const QString &interface,
77 const QString &name);
78 static QDBusMessage createTargetedSignal(const QString &service, const QString &path,
79 const QString &interface, const QString &name);
80 static QDBusMessage createMethodCall(const QString &destination, const QString &path,
81 const QString &interface, const QString &method);
82 static QDBusMessage createError(const QString &name, const QString &msg);
83 static inline QDBusMessage createError(const QDBusError &err)
84 { return createError(err.name(), err.message()); }
85 static inline QDBusMessage createError(QDBusError::ErrorType type, const QString &msg)
86 { return createError(QDBusError::errorString(type), msg); }
87
88 QDBusMessage createReply(const QList<QVariant> &arguments = QList<QVariant>()) const;
89 inline QDBusMessage createReply(const QVariant &argument) const
90 { return createReply(QList<QVariant>() << argument); }
91
92 QDBusMessage createErrorReply(const QString &name, const QString &msg) const;
93 inline QDBusMessage createErrorReply(const QDBusError &err) const
94 { return createErrorReply(err.name(), err.message()); }
95 QDBusMessage createErrorReply(QDBusError::ErrorType type, const QString &msg) const;
96
97 // there are no setters; if this changes, see qdbusmessage_p.h
98 QString service() const;
99 QString path() const;
100 QString interface() const;
101 QString member() const;
102 QString errorName() const;
103 QString errorMessage() const;
104 MessageType type() const;
105 QString signature() const;
106
107 bool isReplyRequired() const;
108
109 void setDelayedReply(bool enable) const;
110 bool isDelayedReply() const;
111
112 void setAutoStartService(bool enable);
113 bool autoStartService() const;
114
115 void setInteractiveAuthorizationAllowed(bool enable);
116 bool isInteractiveAuthorizationAllowed() const;
117
118 void setArguments(const QList<QVariant> &arguments);
119 QList<QVariant> arguments() const;
120
121 QDBusMessage &operator<<(const QVariant &arg);
122
123private:
124 friend class QDBusMessagePrivate;
125 QDBusMessagePrivate *d_ptr;
126};
127Q_DECLARE_SHARED(QDBusMessage)
128
129#ifndef QT_NO_DEBUG_STREAM
130Q_DBUS_EXPORT QDebug operator<<(QDebug, const QDBusMessage &);
131#endif
132
133QT_END_NAMESPACE
134
135Q_DECLARE_METATYPE(QDBusMessage)
136
137#else
138class Q_DBUS_EXPORT QDBusMessage {}; // dummy class for moc
139#endif // QT_NO_DBUS
140#endif
141
142