Qt 4.8
qdbusmessage.h
Go to the documentation of this file.
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 
53 
55 
56 QT_MODULE(DBus)
57 
60 {
61 public:
62  enum MessageType {
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()); }
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;
120 };
121 
122 #ifndef QT_NO_DEBUG_STREAM
124 #endif
125 
127 
129 
130 #endif // QT_NO_DBUS
131 #endif
132 
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
The QDebug class provides an output stream for debugging information.
Definition: qdebug.h:62
int type
Definition: qmetatype.cpp:239
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
Q_DBUS_EXPORT QDebug operator<<(QDebug, const QDBusMessage &)
The QDBusError class represents an error received from the D-Bus bus or from remote applications foun...
Definition: qdbuserror.h:60
MessageType
The possible message types:
Definition: qdbusmessage.h:62
The QString class provides a Unicode character string.
Definition: qstring.h:83
ErrorType
In order to facilitate verification of the most common D-Bus errors generated by the D-Bus implementa...
Definition: qdbuserror.h:63
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
QDBusMessagePrivate * d_ptr
Definition: qdbusmessage.h:119
const char * name
QString name() const
Returns this error&#39;s name.
Definition: qdbuserror.cpp:335
static QDBusMessage createError(QDBusError::ErrorType type, const QString &msg)
Constructs a new DBus message for the error type type using the message msg.
Definition: qdbusmessage.h:82
static QDBusMessage createError(const QDBusError &err)
Constructs a new DBus message representing the given error.
Definition: qdbusmessage.h:80
#define Q_DBUS_EXPORT
Definition: qglobal.h:1463
The QDBusMessage class represents one message sent or received over the D-Bus bus.
Definition: qdbusmessage.h:59
#define QT_END_HEADER
Definition: qglobal.h:137
static QString errorString(ErrorType error)
Returns the error name associated with error condition error.
Definition: qdbuserror.cpp:368
QDBusMessage createReply(const QVariant &argument) const
Constructs a new DBus message representing a reply, with the given argument.
Definition: qdbusmessage.h:86
QDBusMessage createErrorReply(const QDBusError &err) const
Constructs a new DBus message representing an error reply message, from the given error object...
Definition: qdbusmessage.h:90
QString message() const
Returns the message that the callee associated with this error.
Definition: qdbuserror.cpp:346