File: classTp_1_1DBusProxy.html

package info (click to toggle)
telepathy-qt4 0.3.6-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 14,260 kB
  • ctags: 12,185
  • sloc: cpp: 29,241; xml: 23,692; ansic: 16,079; sh: 10,327; python: 3,080; makefile: 1,553
file content (363 lines) | stat: -rw-r--r-- 16,002 bytes parent folder | download
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>TelepathyQt4: Tp::DBusProxy Class Reference</title>
  <link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="1">&nbsp;&nbsp;</td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a>&nbsp;&middot;
<a href="classes.html">
<font color="#004faf">All Classes</font></a>&nbsp;&middot;
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a>&nbsp;&middot;
<a href="modules.html">
<font color="#004faf">Modules</font></a>&nbsp;&middot;
<a href="functions.html">
<font color="#004faf">Functions</font></a>&nbsp;&middot;
<a href="files.html">
<font color="#004faf">Files</font></a>
</td>
</tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.6.3 -->
  <div class="navpath"><a class="el" href="namespaceTp.html">Tp</a>::<a class="el" href="classTp_1_1DBusProxy.html">DBusProxy</a>
  </div>
<div class="contents">
<h1>Tp::DBusProxy Class Reference</h1><!-- doxytag: class="Tp::DBusProxy" -->
<p><code>#include &lt;<a class="el" href="dbus-proxy_8h_source.html">TelepathyQt4/DBusProxy</a>&gt;</code></p>

<p>Inherited by <a class="el" href="classTp_1_1StatefulDBusProxy.html">Tp::StatefulDBusProxy</a>, and <a class="el" href="classTp_1_1StatelessDBusProxy.html">Tp::StatelessDBusProxy</a>.</p>

<p><a href="classTp_1_1DBusProxy-members.html">List of all members.</a></p>
<h2>Signals</h2>
<ul>
<li>void <a class="el" href="classTp_1_1DBusProxy.html#a2ec4e99262674ba916321d11398c6b58">invalidated</a> (<a class="el" href="classTp_1_1DBusProxy.html">Tp::DBusProxy</a> *proxy, const QString &amp;errorName, const QString &amp;errorMessage)
</ul>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1DBusProxy.html#a60303ad156e616a75bc71d285d33cc61">DBusProxy</a> (const QDBusConnection &amp;dbusConnection, const QString &amp;busName, const QString &amp;objectPath, QObject *parent=0)
<li>virtual <a class="el" href="classTp_1_1DBusProxy.html#ae9dd49ab6450270eee49c7e608e4699b">~DBusProxy</a> ()
<li>QDBusConnection <a class="el" href="classTp_1_1DBusProxy.html#a336b08c4b43ff12b92d4e3bd75296a8d">dbusConnection</a> () const 
<li>QString <a class="el" href="classTp_1_1DBusProxy.html#ac37e3a353d5bdaebf451600959c1af1d">busName</a> () const 
<li>QString <a class="el" href="classTp_1_1DBusProxy.html#af95b104d2da1bb0c2ec5bc9cae224ecb">objectPath</a> () const 
<li>bool <a class="el" href="classTp_1_1DBusProxy.html#adb39028a597488f81d5f8bacfe822886">isValid</a> () const 
<li>QString <a class="el" href="classTp_1_1DBusProxy.html#a5485c06ca011151760106abe47e0109f">invalidationReason</a> () const 
<li>QString <a class="el" href="classTp_1_1DBusProxy.html#af3808f1cfe2ddf7187066e65639529db">invalidationMessage</a> () const 
</ul>
<h2>Protected Member Functions</h2>
<ul>
<li>void <a class="el" href="classTp_1_1DBusProxy.html#a8454cf67e8444988c50ba0d14ac5c2d5">setBusName</a> (const QString &amp;busName)
<li>void <a class="el" href="classTp_1_1DBusProxy.html#a4cff103158912bc2207e0da18d00b710">invalidate</a> (const QString &amp;reason, const QString &amp;message)
<li>void <a class="el" href="classTp_1_1DBusProxy.html#a5b3bddf9ffeefd35b8efbf7fb0ba6134">invalidate</a> (const QDBusError &amp;error)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>: ?</p>
<p>Base class representing a remote object available over D-Bus.</p>
<p>All TelepathyQt4 client convenience classes that wrap Telepathy interfaces inherit from this class in order to provide basic D-Bus interface information. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a60303ad156e616a75bc71d285d33cc61"></a><!-- doxytag: member="Tp::DBusProxy::DBusProxy" ref="a60303ad156e616a75bc71d285d33cc61" args="(const QDBusConnection &amp;dbusConnection, const QString &amp;busName, const QString &amp;objectPath, QObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Tp::DBusProxy::DBusProxy </td>
          <td>(</td>
          <td class="paramtype">const QDBusConnection &amp;&nbsp;</td>
          <td class="paramname"> <em>dbusConnection</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>busName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QObject *&nbsp;</td>
          <td class="paramname"> <em>parent</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor </p>

</div>
</div>
<a class="anchor" id="ae9dd49ab6450270eee49c7e608e4699b"></a><!-- doxytag: member="Tp::DBusProxy::~DBusProxy" ref="ae9dd49ab6450270eee49c7e608e4699b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Tp::DBusProxy::~DBusProxy </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a336b08c4b43ff12b92d4e3bd75296a8d"></a><!-- doxytag: member="Tp::DBusProxy::dbusConnection" ref="a336b08c4b43ff12b92d4e3bd75296a8d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QDBusConnection Tp::DBusProxy::dbusConnection </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the D-Bus connection through which the remote object is accessed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The connection the object is associated with. </dd></dl>

</div>
</div>
<a class="anchor" id="ac37e3a353d5bdaebf451600959c1af1d"></a><!-- doxytag: member="Tp::DBusProxy::busName" ref="ac37e3a353d5bdaebf451600959c1af1d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Tp::DBusProxy::busName </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the D-Bus bus name (either a unique name or a well-known name) of the service that provides the remote object.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The service name the object is associated with. </dd></dl>

</div>
</div>
<a class="anchor" id="af95b104d2da1bb0c2ec5bc9cae224ecb"></a><!-- doxytag: member="Tp::DBusProxy::objectPath" ref="af95b104d2da1bb0c2ec5bc9cae224ecb" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Tp::DBusProxy::objectPath </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the D-Bus object path of the remote object within the service.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The object path the object is associated with. </dd></dl>

</div>
</div>
<a class="anchor" id="adb39028a597488f81d5f8bacfe822886"></a><!-- doxytag: member="Tp::DBusProxy::isValid" ref="adb39028a597488f81d5f8bacfe822886" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Tp::DBusProxy::isValid </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>If this object is usable (has not emitted <a class="el" href="classTp_1_1DBusProxy.html#a2ec4e99262674ba916321d11398c6b58">invalidated()</a>), returns <code>true</code>. Otherwise returns <code>false</code>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if this object is still fully usable </dd></dl>

</div>
</div>
<a class="anchor" id="a5485c06ca011151760106abe47e0109f"></a><!-- doxytag: member="Tp::DBusProxy::invalidationReason" ref="a5485c06ca011151760106abe47e0109f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Tp::DBusProxy::invalidationReason </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>If this object is no longer usable (has emitted <a class="el" href="classTp_1_1DBusProxy.html#a2ec4e99262674ba916321d11398c6b58">invalidated()</a>), returns the error name indicating the reason it became invalid in a machine-readable way. Otherwise, returns a null QString.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A D-Bus error name, or QString() if this object is still valid </dd></dl>

</div>
</div>
<a class="anchor" id="af3808f1cfe2ddf7187066e65639529db"></a><!-- doxytag: member="Tp::DBusProxy::invalidationMessage" ref="af3808f1cfe2ddf7187066e65639529db" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Tp::DBusProxy::invalidationMessage </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>If this object is no longer usable (has emitted <a class="el" href="classTp_1_1DBusProxy.html#a2ec4e99262674ba916321d11398c6b58">invalidated()</a>), returns a debugging message indicating the reason it became invalid. Otherwise, returns a null QString.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A debugging message, or QString() if this object is still valid </dd></dl>

</div>
</div>
<a class="anchor" id="a2ec4e99262674ba916321d11398c6b58"></a><!-- doxytag: member="Tp::DBusProxy::invalidated" ref="a2ec4e99262674ba916321d11398c6b58" args="(Tp::DBusProxy *proxy, const QString &amp;errorName, const QString &amp;errorMessage)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Tp::DBusProxy::invalidated </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTp_1_1DBusProxy.html">Tp::DBusProxy</a> *&nbsp;</td>
          <td class="paramname"> <em>proxy</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>errorName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>errorMessage</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Emitted when this object is no longer usable.</p>
<p>After this signal is emitted, any D-Bus method calls on the object will fail, but it may be possible to retrieve information that has already been retrieved and cached.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>proxy</em>&nbsp;</td><td>This proxy </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>errorName</em>&nbsp;</td><td>A D-Bus error name (a string in a subset of ASCII, prefixed with a reversed domain name) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>errorMessage</em>&nbsp;</td><td>A debugging message associated with the error </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a8454cf67e8444988c50ba0d14ac5c2d5"></a><!-- doxytag: member="Tp::DBusProxy::setBusName" ref="a8454cf67e8444988c50ba0d14ac5c2d5" args="(const QString &amp;busName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Tp::DBusProxy::setBusName </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>busName</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the D-Bus bus name. This is used by subclasses after converting well-known names to unique names. </p>

</div>
</div>
<a class="anchor" id="a4cff103158912bc2207e0da18d00b710"></a><!-- doxytag: member="Tp::DBusProxy::invalidate" ref="a4cff103158912bc2207e0da18d00b710" args="(const QString &amp;reason, const QString &amp;message)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Tp::DBusProxy::invalidate </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>reason</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>message</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Called by subclasses when the <a class="el" href="classTp_1_1DBusProxy.html">DBusProxy</a> should become invalid.</p>
<p>This method takes care of setting the invalidationReason, invalidationMessage, and emitting the invalidated signal.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>A D-Bus error name (a string in a subset of ASCII, prefixed with a reversed domain name) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>A debugging message associated with the error </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5b3bddf9ffeefd35b8efbf7fb0ba6134"></a><!-- doxytag: member="Tp::DBusProxy::invalidate" ref="a5b3bddf9ffeefd35b8efbf7fb0ba6134" args="(const QDBusError &amp;error)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Tp::DBusProxy::invalidate </td>
          <td>(</td>
          <td class="paramtype">const QDBusError &amp;&nbsp;</td>
          <td class="paramname"> <em>error</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
</div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright &copy; 2008-2010 Collabora Ltd. and Nokia Corporation</td>
<td width="30%" align="right"><div align="right">Telepathy-Qt4 0.3.6</div></td>
</tr></table></div></address>
</body>
</html>