1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). |
4 | ** Contact: http://www.qt-project.org/legal |
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 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. |
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 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. |
24 | ** |
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. |
28 | ** |
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. |
36 | ** |
37 | ** |
38 | ** $QT_END_LICENSE$ |
39 | ** |
40 | ****************************************************************************/ |
41 | |
42 | #ifndef QDBUSMESSAGE_H |
43 | #define QDBUSMESSAGE_H |
44 | |
45 | #include <QtDBus/qdbusmacros.h> |
46 | #include <QtDBus/qdbuserror.h> |
47 | #include <QtCore/qlist.h> |
48 | #include <QtCore/qvariant.h> |
49 | |
50 | #ifndef QT_NO_DBUS |
51 | |
52 | QT_BEGIN_HEADER |
53 | |
54 | QT_BEGIN_NAMESPACE |
55 | |
56 | QT_MODULE(DBus) |
57 | |
58 | class QDBusMessagePrivate; |
59 | class Q_DBUS_EXPORT QDBusMessage |
60 | { |
61 | public: |
62 | enum MessageType { |
63 | InvalidMessage, |
64 | MethodCallMessage, |
65 | ReplyMessage, |
66 | ErrorMessage, |
67 | SignalMessage |
68 | }; |
69 | |
70 | QDBusMessage(); |
71 | QDBusMessage(const QDBusMessage &other); |
72 | QDBusMessage &operator=(const QDBusMessage &other); |
73 | ~QDBusMessage(); |
74 | |
75 | static QDBusMessage createSignal(const QString &path, const QString &interface, |
76 | const QString &name); |
77 | static QDBusMessage createMethodCall(const QString &destination, const QString &path, |
78 | const QString &interface, const QString &method); |
79 | static QDBusMessage createError(const QString &name, const QString &msg); |
80 | static inline QDBusMessage createError(const QDBusError &err) |
81 | { return createError(err.name(), err.message()); } |
82 | static inline QDBusMessage createError(QDBusError::ErrorType type, const QString &msg) |
83 | { return createError(QDBusError::errorString(type), msg); } |
84 | |
85 | QDBusMessage createReply(const QList<QVariant> &arguments = QList<QVariant>()) const; |
86 | inline QDBusMessage createReply(const QVariant &argument) const |
87 | { return createReply(QList<QVariant>() << argument); } |
88 | |
89 | QDBusMessage createErrorReply(const QString name, const QString &msg) const; |
90 | inline QDBusMessage createErrorReply(const QDBusError &err) const |
91 | { return createErrorReply(err.name(), err.message()); } |
92 | QDBusMessage createErrorReply(QDBusError::ErrorType type, const QString &msg) const; |
93 | |
94 | // there are no setters; if this changes, see qdbusmessage_p.h |
95 | QString service() const; |
96 | QString path() const; |
97 | QString interface() const; |
98 | QString member() const; |
99 | QString errorName() const; |
100 | QString errorMessage() const; |
101 | MessageType type() const; |
102 | QString signature() const; |
103 | |
104 | bool isReplyRequired() const; |
105 | |
106 | void setDelayedReply(bool enable) const; |
107 | bool isDelayedReply() const; |
108 | |
109 | void setAutoStartService(bool enable); |
110 | bool autoStartService() const; |
111 | |
112 | void setArguments(const QList<QVariant> &arguments); |
113 | QList<QVariant> arguments() const; |
114 | |
115 | QDBusMessage &operator<<(const QVariant &arg); |
116 | |
117 | private: |
118 | friend class QDBusMessagePrivate; |
119 | QDBusMessagePrivate *d_ptr; |
120 | }; |
121 | |
122 | #ifndef QT_NO_DEBUG_STREAM |
123 | Q_DBUS_EXPORT QDebug operator<<(QDebug, const QDBusMessage &); |
124 | #endif |
125 | |
126 | QT_END_NAMESPACE |
127 | |
128 | QT_END_HEADER |
129 | |
130 | #endif // QT_NO_DBUS |
131 | #endif |
132 | |
133 | |