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#ifndef QT_NO_DBUS
49
50#if defined(Q_OS_WIN) && defined(interface)
51# undef interface
52#endif
53
54QT_BEGIN_NAMESPACE
55
56
57class QDBusMessagePrivate;
58class Q_DBUS_EXPORT QDBusMessage
59{
60public:
61 enum MessageType {
62 InvalidMessage,
63 MethodCallMessage,
64 ReplyMessage,
65 ErrorMessage,
66 SignalMessage
67 };
68
69 QDBusMessage();
70 QDBusMessage(const QDBusMessage &other);
71 QDBusMessage &operator=(QDBusMessage &&other) noexcept { swap(other); return *this; }
72 QDBusMessage &operator=(const QDBusMessage &other);
73 ~QDBusMessage();
74
75 void swap(QDBusMessage &other) noexcept { qSwap(value1&: d_ptr, value2&: other.d_ptr); }
76
77 static QDBusMessage createSignal(const QString &path, const QString &interface,
78 const QString &name);
79 static QDBusMessage createTargetedSignal(const QString &service, const QString &path,
80 const QString &interface, const QString &name);
81 static QDBusMessage createMethodCall(const QString &destination, const QString &path,
82 const QString &interface, const QString &method);
83 static QDBusMessage createError(const QString &name, const QString &msg);
84 static inline QDBusMessage createError(const QDBusError &err)
85 { return createError(name: err.name(), msg: err.message()); }
86 static inline QDBusMessage createError(QDBusError::ErrorType type, const QString &msg)
87 { return createError(name: QDBusError::errorString(error: type), msg); }
88
89 QDBusMessage createReply(const QList<QVariant> &arguments = QList<QVariant>()) const;
90 inline QDBusMessage createReply(const QVariant &argument) const
91 { return createReply(arguments: QList<QVariant>() << argument); }
92
93#if QT_VERSION >= QT_VERSION_CHECK(6,0,0)
94 QDBusMessage createErrorReply(const QString &name, const QString &msg) const;
95#else
96 QDBusMessage createErrorReply(const QString name, const QString &msg) const;
97#endif
98 inline QDBusMessage createErrorReply(const QDBusError &err) const
99 { return createErrorReply(name: err.name(), msg: err.message()); }
100 QDBusMessage createErrorReply(QDBusError::ErrorType type, const QString &msg) const;
101
102 // there are no setters; if this changes, see qdbusmessage_p.h
103 QString service() const;
104 QString path() const;
105 QString interface() const;
106 QString member() const;
107 QString errorName() const;
108 QString errorMessage() const;
109 MessageType type() const;
110 QString signature() const;
111
112 bool isReplyRequired() const;
113
114 void setDelayedReply(bool enable) const;
115 bool isDelayedReply() const;
116
117 void setAutoStartService(bool enable);
118 bool autoStartService() const;
119
120 void setInteractiveAuthorizationAllowed(bool enable);
121 bool isInteractiveAuthorizationAllowed() const;
122
123 void setArguments(const QList<QVariant> &arguments);
124 QList<QVariant> arguments() const;
125
126 QDBusMessage &operator<<(const QVariant &arg);
127
128private:
129 friend class QDBusMessagePrivate;
130 QDBusMessagePrivate *d_ptr;
131};
132Q_DECLARE_SHARED_NOT_MOVABLE_UNTIL_QT6(QDBusMessage)
133
134#ifndef QT_NO_DEBUG_STREAM
135Q_DBUS_EXPORT QDebug operator<<(QDebug, const QDBusMessage &);
136#endif
137
138QT_END_NAMESPACE
139
140Q_DECLARE_METATYPE(QDBusMessage)
141
142#endif // QT_NO_DBUS
143#endif
144
145

source code of qtbase/src/dbus/qdbusmessage.h