1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdbusmessage.cpp -->
<title>Qt 4.8: QDBusMessage Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtdbus.html">QtDBus</a></li>
<li>QDBusMessage</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QDBusMessage Class Reference</h1>
<!-- $$$QDBusMessage-brief -->
<p>The QDBusMessage class represents one message sent or received over the D-Bus bus. <a href="#details">More...</a></p>
<!-- @@@QDBusMessage -->
<pre class="cpp"> <span class="preprocessor">#include <QDBusMessage></span></pre><p>This class was introduced in Qt 4.2.</p>
<ul>
<li><a href="qdbusmessage-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#MessageType-enum">MessageType</a></b> { MethodCallMessage, SignalMessage, ReplyMessage, ErrorMessage, InvalidMessage }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#QDBusMessage">QDBusMessage</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#QDBusMessage-2">QDBusMessage</a></b> ( const QDBusMessage & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#dtor.QDBusMessage">~QDBusMessage</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QVariant> </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#arguments">arguments</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#autoStartService">autoStartService</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createErrorReply">createErrorReply</a></b> ( const QString <i>name</i>, const QString & <i>msg</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createErrorReply-2">createErrorReply</a></b> ( const QDBusError & <i>error</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createErrorReply-3">createErrorReply</a></b> ( QDBusError::ErrorType <i>type</i>, const QString & <i>msg</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createReply">createReply</a></b> ( const QList<QVariant> & <i>arguments</i> = QList<QVariant> () ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createReply-2">createReply</a></b> ( const QVariant & <i>argument</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#errorMessage">errorMessage</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#errorName">errorName</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#interface">interface</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#isDelayedReply">isDelayedReply</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#isReplyRequired">isReplyRequired</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#member">member</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#pathx">path</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#service">service</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#setArguments">setArguments</a></b> ( const QList<QVariant> & <i>arguments</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#setAutoStartService">setAutoStartService</a></b> ( bool <i>enable</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#setDelayedReply">setDelayedReply</a></b> ( bool <i>enable</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#signature">signature</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> MessageType </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#type">type</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage & </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#operator-lt-lt">operator<<</a></b> ( const QVariant & <i>arg</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage & </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#operator-eq">operator=</a></b> ( const QDBusMessage & <i>other</i> )</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createError">createError</a></b> ( const QString & <i>name</i>, const QString & <i>msg</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createError-2">createError</a></b> ( const QDBusError & <i>error</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createError-3">createError</a></b> ( QDBusError::ErrorType <i>type</i>, const QString & <i>msg</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createMethodCall">createMethodCall</a></b> ( const QString & <i>service</i>, const QString & <i>path</i>, const QString & <i>interface</i>, const QString & <i>method</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusMessage </td><td class="memItemRight bottomAlign"><b><a href="qdbusmessage.html#createSignal">createSignal</a></b> ( const QString & <i>path</i>, const QString & <i>interface</i>, const QString & <i>name</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QDBusMessage-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QDBusMessage class represents one message sent or received over the D-Bus bus.</p>
<p>This object can represent any of the four different types of messages (<a href="qdbusmessage.html#MessageType-enum">MessageType</a>) that can occur on the bus:</p>
<ul>
<li>Method calls</li>
<li>Method return values</li>
<li>Signal emissions</li>
<li>Error codes</li>
</ul>
<p>Objects of this type are created with the static <a href="qdbusmessage.html#createError">createError</a>(), <a href="qdbusmessage.html#createMethodCall">createMethodCall</a>() and <a href="qdbusmessage.html#createSignal">createSignal</a>() functions. Use the <a href="qdbusconnection.html#send">QDBusConnection::send</a>() function to send the messages.</p>
</div>
<!-- @@@QDBusMessage -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$MessageType$$$InvalidMessage$$$MethodCallMessage$$$ReplyMessage$$$ErrorMessage$$$SignalMessage -->
<h3 class="fn"><a name="MessageType-enum"></a>enum QDBusMessage::<span class="name">MessageType</span></h3>
<p>The possible message types:</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QDBusMessage::MethodCallMessage</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">a message representing an outgoing or incoming method call</td></tr>
<tr><td class="topAlign"><tt>QDBusMessage::SignalMessage</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">a message representing an outgoing or incoming signal emission</td></tr>
<tr><td class="topAlign"><tt>QDBusMessage::ReplyMessage</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">a message representing the return values of a method call</td></tr>
<tr><td class="topAlign"><tt>QDBusMessage::ErrorMessage</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">a message representing an error condition in response to a method call</td></tr>
<tr><td class="topAlign"><tt>QDBusMessage::InvalidMessage</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">an invalid message: this is never set on messages received from D-Bus</td></tr>
</table>
<!-- @@@MessageType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QDBusMessage[overload1]$$$QDBusMessage -->
<h3 class="fn"><a name="QDBusMessage"></a>QDBusMessage::<span class="name">QDBusMessage</span> ()</h3>
<p>Constructs an empty, invalid <a href="qdbusmessage.html">QDBusMessage</a> object.</p>
<p><b>See also </b><a href="qdbusmessage.html#createError">createError</a>(), <a href="qdbusmessage.html#createMethodCall">createMethodCall</a>(), and <a href="qdbusmessage.html#createSignal">createSignal</a>().</p>
<!-- @@@QDBusMessage -->
<!-- $$$QDBusMessage$$$QDBusMessageconstQDBusMessage& -->
<h3 class="fn"><a name="QDBusMessage-2"></a>QDBusMessage::<span class="name">QDBusMessage</span> ( const <span class="type">QDBusMessage</span> & <i>other</i> )</h3>
<p>Constructs a copy of the object given by <i>other</i>.</p>
<p>Note: <a href="qdbusmessage.html">QDBusMessage</a> objects are shared. Modifications made to the copy will affect the original one as well. See <a href="qdbusmessage.html#setDelayedReply">setDelayedReply</a>() for more information.</p>
<!-- @@@QDBusMessage -->
<!-- $$$~QDBusMessage[overload1]$$$~QDBusMessage -->
<h3 class="fn"><a name="dtor.QDBusMessage"></a>QDBusMessage::<span class="name">~QDBusMessage</span> ()</h3>
<p>Disposes of the object and frees any resources that were being held.</p>
<!-- @@@~QDBusMessage -->
<!-- $$$arguments[overload1]$$$arguments -->
<h3 class="fn"><a name="arguments"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qvariant.html">QVariant</a></span>> QDBusMessage::<span class="name">arguments</span> () const</h3>
<p>Returns the list of arguments that are going to be sent or were received from D-Bus.</p>
<p><b>See also </b><a href="qdbusmessage.html#setArguments">setArguments</a>().</p>
<!-- @@@arguments -->
<!-- $$$autoStartService[overload1]$$$autoStartService -->
<h3 class="fn"><a name="autoStartService"></a><span class="type">bool</span> QDBusMessage::<span class="name">autoStartService</span> () const</h3>
<p>Returns the auto start flag, as set by <a href="qdbusmessage.html#setAutoStartService">setAutoStartService</a>(). By default, this flag is true, which means <a href="qtdbus.html">QtDBus</a> will auto start a service, if it is not running already.</p>
<p>This function was introduced in Qt 4.7.</p>
<p><b>See also </b><a href="qdbusmessage.html#setAutoStartService">setAutoStartService</a>().</p>
<!-- @@@autoStartService -->
<!-- $$$createError[overload1]$$$createErrorconstQString&constQString& -->
<h3 class="fn"><a name="createError"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createError</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>msg</i> )<tt> [static]</tt></h3>
<p>Constructs a new DBus message representing an error, with the given <i>name</i> and <i>msg</i>.</p>
<!-- @@@createError -->
<!-- $$$createError$$$createErrorconstQDBusError& -->
<h3 class="fn"><a name="createError-2"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createError</span> ( const <span class="type"><a href="qdbuserror.html">QDBusError</a></span> & <i>error</i> )<tt> [static]</tt></h3>
<p>Constructs a new DBus message representing the given <i>error</i>.</p>
<!-- @@@createError -->
<!-- $$$createError$$$createErrorQDBusError::ErrorTypeconstQString& -->
<h3 class="fn"><a name="createError-3"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createError</span> ( <span class="type"><a href="qdbuserror.html#ErrorType-enum">QDBusError::ErrorType</a></span> <i>type</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>msg</i> )<tt> [static]</tt></h3>
<p>Constructs a new DBus message for the error type <i>type</i> using the message <i>msg</i>. Returns the DBus message.</p>
<!-- @@@createError -->
<!-- $$$createErrorReply[overload1]$$$createErrorReplyconstQStringconstQString& -->
<h3 class="fn"><a name="createErrorReply"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createErrorReply</span> ( const <span class="type"><a href="qstring.html">QString</a></span> <i>name</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>msg</i> ) const</h3>
<p>Constructs a new DBus message representing an error reply message, with the given <i>name</i> and <i>msg</i>.</p>
<!-- @@@createErrorReply -->
<!-- $$$createErrorReply$$$createErrorReplyconstQDBusError& -->
<h3 class="fn"><a name="createErrorReply-2"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createErrorReply</span> ( const <span class="type"><a href="qdbuserror.html">QDBusError</a></span> & <i>error</i> ) const</h3>
<p>Constructs a new DBus message representing an error reply message, from the given <i>error</i> object.</p>
<!-- @@@createErrorReply -->
<!-- $$$createErrorReply$$$createErrorReplyQDBusError::ErrorTypeconstQString& -->
<h3 class="fn"><a name="createErrorReply-3"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createErrorReply</span> ( <span class="type"><a href="qdbuserror.html#ErrorType-enum">QDBusError::ErrorType</a></span> <i>type</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>msg</i> ) const</h3>
<p>Constructs a new DBus reply message for the error type <i>type</i> using the message <i>msg</i>. Returns the DBus message.</p>
<!-- @@@createErrorReply -->
<!-- $$$createMethodCall[overload1]$$$createMethodCallconstQString&constQString&constQString&constQString& -->
<h3 class="fn"><a name="createMethodCall"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createMethodCall</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>service</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>path</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>interface</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>method</i> )<tt> [static]</tt></h3>
<p>Constructs a new DBus message representing a method call. A method call always informs its destination address (<i>service</i>, <i>path</i>, <i>interface</i> and <i>method</i>).</p>
<p>The DBus bus allows calling a method on a given remote object without specifying the destination interface, if the method name is unique. However, if two interfaces on the remote object export the same method name, the result is undefined (one of the two may be called or an error may be returned).</p>
<p>When using DBus in a peer-to-peer context (i.e., not on a bus), the <i>service</i> parameter is optional.</p>
<p>The QDBusObject and <a href="qdbusinterface.html">QDBusInterface</a> classes provide a simpler abstraction to synchronous method calling.</p>
<p>This function returns a <a href="qdbusmessage.html">QDBusMessage</a> object that can be sent with <a href="qdbusconnection.html#call">QDBusConnection::call</a>().</p>
<!-- @@@createMethodCall -->
<!-- $$$createReply[overload1]$$$createReplyconstQList<QVariant>& -->
<h3 class="fn"><a name="createReply"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createReply</span> ( const <span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qvariant.html">QVariant</a></span>> & <i>arguments</i> = QList<QVariant> () ) const</h3>
<p>Constructs a new DBus message representing a reply, with the given <i>arguments</i>.</p>
<!-- @@@createReply -->
<!-- $$$createReply$$$createReplyconstQVariant& -->
<h3 class="fn"><a name="createReply-2"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createReply</span> ( const <span class="type"><a href="qvariant.html">QVariant</a></span> & <i>argument</i> ) const</h3>
<p>Constructs a new DBus message representing a reply, with the given <i>argument</i>.</p>
<!-- @@@createReply -->
<!-- $$$createSignal[overload1]$$$createSignalconstQString&constQString&constQString& -->
<h3 class="fn"><a name="createSignal"></a><span class="type">QDBusMessage</span> QDBusMessage::<span class="name">createSignal</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>path</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>interface</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )<tt> [static]</tt></h3>
<p>Constructs a new DBus message with the given <i>path</i>, <i>interface</i> and <i>name</i>, representing a signal emission.</p>
<p>A DBus signal is emitted from one application and is received by all applications that are listening for that signal from that interface.</p>
<p>The <a href="qdbusmessage.html">QDBusMessage</a> object that is returned can be sent using the <a href="qdbusconnection.html#send">QDBusConnection::send</a>() function.</p>
<!-- @@@createSignal -->
<!-- $$$errorMessage[overload1]$$$errorMessage -->
<h3 class="fn"><a name="errorMessage"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusMessage::<span class="name">errorMessage</span> () const</h3>
<p>Returns the human-readable message associated with the error that was received.</p>
<p>This function was introduced in Qt 4.3.</p>
<!-- @@@errorMessage -->
<!-- $$$errorName[overload1]$$$errorName -->
<h3 class="fn"><a name="errorName"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusMessage::<span class="name">errorName</span> () const</h3>
<p>Returns the name of the error that was received.</p>
<!-- @@@errorName -->
<!-- $$$interface[overload1]$$$interface -->
<h3 class="fn"><a name="interface"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusMessage::<span class="name">interface</span> () const</h3>
<p>Returns the interface of the method being called (in the case of a method call) or of the signal being received from.</p>
<!-- @@@interface -->
<!-- $$$isDelayedReply[overload1]$$$isDelayedReply -->
<h3 class="fn"><a name="isDelayedReply"></a><span class="type">bool</span> QDBusMessage::<span class="name">isDelayedReply</span> () const</h3>
<p>Returns the delayed reply flag, as set by <a href="qdbusmessage.html#setDelayedReply">setDelayedReply</a>(). By default, this flag is false, which means <a href="qtdbus.html">QtDBus</a> will generate automatic replies when necessary.</p>
<!-- @@@isDelayedReply -->
<!-- $$$isReplyRequired[overload1]$$$isReplyRequired -->
<h3 class="fn"><a name="isReplyRequired"></a><span class="type">bool</span> QDBusMessage::<span class="name">isReplyRequired</span> () const</h3>
<p>Returns the flag that indicates if this message should see a reply or not. This is only meaningful for <a href="qdbusmessage.html#MessageType-enum">method call messages</a>: any other kind of message cannot have replies and this function will always return false for them.</p>
<!-- @@@isReplyRequired -->
<!-- $$$member[overload1]$$$member -->
<h3 class="fn"><a name="member"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusMessage::<span class="name">member</span> () const</h3>
<p>Returns the name of the signal that was emitted or the name of the method that was called.</p>
<!-- @@@member -->
<!-- $$$path[overload1]$$$path -->
<h3 class="fn"><a name="pathx"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusMessage::<span class="name">path</span> () const</h3>
<p>Returns the path of the object that this message is being sent to (in the case of a method call) or being received from (for a signal).</p>
<!-- @@@path -->
<!-- $$$service[overload1]$$$service -->
<h3 class="fn"><a name="service"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusMessage::<span class="name">service</span> () const</h3>
<p>Returns the name of the service or the bus address of the remote method call.</p>
<!-- @@@service -->
<!-- $$$setArguments[overload1]$$$setArgumentsconstQList<QVariant>& -->
<h3 class="fn"><a name="setArguments"></a><span class="type">void</span> QDBusMessage::<span class="name">setArguments</span> ( const <span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qvariant.html">QVariant</a></span>> & <i>arguments</i> )</h3>
<p>Sets the arguments that are going to be sent over D-Bus to <i>arguments</i>. Those will be the arguments to a method call or the parameters in the signal.</p>
<p><b>See also </b><a href="qdbusmessage.html#arguments">arguments</a>().</p>
<!-- @@@setArguments -->
<!-- $$$setAutoStartService[overload1]$$$setAutoStartServicebool -->
<h3 class="fn"><a name="setAutoStartService"></a><span class="type">void</span> QDBusMessage::<span class="name">setAutoStartService</span> ( <span class="type">bool</span> <i>enable</i> )</h3>
<p>Sets the auto start flag to <i>enable</i>. This flag only makes sense for method call messages, where it tells the D-Bus server to either auto start the service responsible for the service name, or not to auto start it.</p>
<p>By default this flag is true, i.e. a service is autostarted. This means:</p>
<p>When the service that this method call is sent to is already running, the method call is sent to it. If the service is not running yet, the D-Bus daemon is requested to autostart the service that is assigned to this service name. This is handled by .service files that are placed in a directory known to the D-Bus server. These files then each contain a service name and the path to a program that should be executed when this service name is requested.</p>
<p>This function was introduced in Qt 4.7.</p>
<p><b>See also </b><a href="qdbusmessage.html#autoStartService">autoStartService</a>().</p>
<!-- @@@setAutoStartService -->
<!-- $$$setDelayedReply[overload1]$$$setDelayedReplybool -->
<h3 class="fn"><a name="setDelayedReply"></a><span class="type">void</span> QDBusMessage::<span class="name">setDelayedReply</span> ( <span class="type">bool</span> <i>enable</i> ) const</h3>
<p>Sets whether the message will be replied later (if <i>enable</i> is true) or if an automatic reply should be generated by <a href="qtdbus.html">QtDBus</a> (if <i>enable</i> is false).</p>
<p>In D-Bus, all method calls must generate a reply to the caller, unless the caller explicitly indicates otherwise (see <a href="qdbusmessage.html#isReplyRequired">isReplyRequired</a>()). <a href="qtdbus.html">QtDBus</a> automatically generates such replies for any slots being called, but it also allows slots to indicate whether they will take responsibility of sending the reply at a later time, after the function has finished processing.</p>
<p><b>See also </b><a href="qdbusmessage.html#isDelayedReply">isDelayedReply</a>() and <a href="qdbusdeclaringslots.html#delayed-replies">Delayed Replies</a>.</p>
<!-- @@@setDelayedReply -->
<!-- $$$signature[overload1]$$$signature -->
<h3 class="fn"><a name="signature"></a><span class="type"><a href="qstring.html">QString</a></span> QDBusMessage::<span class="name">signature</span> () const</h3>
<p>Returns the signature of the signal that was received or for the output arguments of a method call.</p>
<!-- @@@signature -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="qdbusmessage.html#MessageType-enum">MessageType</a></span> QDBusMessage::<span class="name">type</span> () const</h3>
<p>Returns the message type.</p>
<!-- @@@type -->
<!-- $$$operator<<[overload1]$$$operator<<constQVariant& -->
<h3 class="fn"><a name="operator-lt-lt"></a><span class="type">QDBusMessage</span> & QDBusMessage::<span class="name">operator<<</span> ( const <span class="type"><a href="qvariant.html">QVariant</a></span> & <i>arg</i> )</h3>
<p>Appends the argument <i>arg</i> to the list of arguments to be sent over D-Bus in a method call or signal emission.</p>
<!-- @@@operator<< -->
<!-- $$$operator=[overload1]$$$operator=constQDBusMessage& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QDBusMessage</span> & QDBusMessage::<span class="name">operator=</span> ( const <span class="type">QDBusMessage</span> & <i>other</i> )</h3>
<p>Copies the contents of the object given by <i>other</i>.</p>
<p>Note: <a href="qdbusmessage.html">QDBusMessage</a> objects are shared. Modifications made to the copy will affect the original one as well. See <a href="qdbusmessage.html#setDelayedReply">setDelayedReply</a>() for more information.</p>
<!-- @@@operator= -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
