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
|
<?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::PendingHandles 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"> </td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a> ·
<a href="classes.html">
<font color="#004faf">All Classes</font></a> ·
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a> ·
<a href="modules.html">
<font color="#004faf">Modules</font></a> ·
<a href="functions.html">
<font color="#004faf">Functions</font></a> ·
<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_1PendingHandles.html">PendingHandles</a>
</div>
<div class="contents">
<h1>Tp::PendingHandles Class Reference<br/>
<small>
[<a class="el" href="group__clientconn.html">Connection proxies</a>]</small>
</h1><!-- doxytag: class="Tp::PendingHandles" --><!-- doxytag: inherits="Tp::PendingOperation" -->
<p>Class containing the parameters of and the reply to an asynchronous handle request/hold. Instances of this class cannot be constructed directly; the only way to get one is to use <a class="el" href="classTp_1_1Connection.html#ace52d32457f85c93d5836873b98d90f7">Connection::requestHandles()</a> or <a class="el" href="classTp_1_1Connection.html#a66b465f855d0094bb9077fe56c3bb74b">Connection::referenceHandles()</a>.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="pending-handles_8h_source.html">TelepathyQt4/PendingHandles</a>></code></p>
<p>Inherits <a class="el" href="classTp_1_1PendingOperation.html">Tp::PendingOperation</a>.</p>
<p><a href="classTp_1_1PendingHandles-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1PendingHandles.html#a172397f19a1210f05607ef590c7de78f">~PendingHandles</a> ()
<li><a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> <a class="el" href="classTp_1_1PendingHandles.html#a6a5444e8f92fea9470b420c156afe7f6">connection</a> () const
<li>uint <a class="el" href="classTp_1_1PendingHandles.html#a69e647c8d62521822e3a30c97edca8fa">handleType</a> () const
<li>bool <a class="el" href="classTp_1_1PendingHandles.html#a8998c31c8bc58004556d00da296c1a42">isRequest</a> () const
<li>bool <a class="el" href="classTp_1_1PendingHandles.html#a974ddc8bddde79caef0a9e3a79ee7999">isReference</a> () const
<li>const QStringList & <a class="el" href="classTp_1_1PendingHandles.html#abcbc041a1c3503944fb1a0b46efbe8cb">namesRequested</a> () const
<li>QStringList <a class="el" href="classTp_1_1PendingHandles.html#ab4dd0740e8aaedacc945c1470d67d63d">validNames</a> () const
<li>QHash< QString, QPair< QString, <br class="typebreak"/>
QString > > <a class="el" href="classTp_1_1PendingHandles.html#af966a0dc9e6d69d66193b7ddca23aec8">invalidNames</a> () const
<li>const UIntList & <a class="el" href="classTp_1_1PendingHandles.html#ac80bd40f0e27b8eed444fe2cbf54e472">handlesToReference</a> () const
<li><a class="el" href="classTp_1_1ReferencedHandles.html">ReferencedHandles</a> <a class="el" href="classTp_1_1PendingHandles.html#ac524bbfe23f411945a48b30c42409860">handles</a> () const
<li>UIntList <a class="el" href="classTp_1_1PendingHandles.html#aa101cc641ddfa3e21ce2cd5e18e741f5">invalidHandles</a> () const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class containing the parameters of and the reply to an asynchronous handle request/hold. Instances of this class cannot be constructed directly; the only way to get one is to use <a class="el" href="classTp_1_1Connection.html#ace52d32457f85c93d5836873b98d90f7">Connection::requestHandles()</a> or <a class="el" href="classTp_1_1Connection.html#a66b465f855d0094bb9077fe56c3bb74b">Connection::referenceHandles()</a>. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a172397f19a1210f05607ef590c7de78f"></a><!-- doxytag: member="Tp::PendingHandles::~PendingHandles" ref="a172397f19a1210f05607ef590c7de78f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::PendingHandles::~PendingHandles </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6a5444e8f92fea9470b420c156afe7f6"></a><!-- doxytag: member="Tp::PendingHandles::connection" ref="a6a5444e8f92fea9470b420c156afe7f6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> Tp::PendingHandles::connection </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a> object through which the operation was made.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a69e647c8d62521822e3a30c97edca8fa"></a><!-- doxytag: member="Tp::PendingHandles::handleType" ref="a69e647c8d62521822e3a30c97edca8fa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint Tp::PendingHandles::handleType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the handle type specified in the operation.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The handle type, as specified in HandleType. </dd></dl>
</div>
</div>
<a class="anchor" id="a8998c31c8bc58004556d00da296c1a42"></a><!-- doxytag: member="Tp::PendingHandles::isRequest" ref="a8998c31c8bc58004556d00da296c1a42" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::PendingHandles::isRequest </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the operation was a handle request (as opposed to a reference of existing handles).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1PendingHandles.html#a974ddc8bddde79caef0a9e3a79ee7999">isReference()</a></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Whether the operation was a request (== !isReference()). </dd></dl>
</div>
</div>
<a class="anchor" id="a974ddc8bddde79caef0a9e3a79ee7999"></a><!-- doxytag: member="Tp::PendingHandles::isReference" ref="a974ddc8bddde79caef0a9e3a79ee7999" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::PendingHandles::isReference </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the operation was a handle reference (as opposed to a request for new handles).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1PendingHandles.html#a8998c31c8bc58004556d00da296c1a42">isRequest()</a></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Whether the operation was a reference (== !isRequest()). </dd></dl>
</div>
</div>
<a class="anchor" id="abcbc041a1c3503944fb1a0b46efbe8cb"></a><!-- doxytag: member="Tp::PendingHandles::namesRequested" ref="abcbc041a1c3503944fb1a0b46efbe8cb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QStringList & Tp::PendingHandles::namesRequested </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the operation was a request (as returned by <a class="el" href="classTp_1_1PendingHandles.html#a8998c31c8bc58004556d00da296c1a42">isRequest()</a>), returns the names of the entities for which handles were requested for. Otherwise, returns an empty list.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to a list of the names of the entities. </dd></dl>
</div>
</div>
<a class="anchor" id="ab4dd0740e8aaedacc945c1470d67d63d"></a><!-- doxytag: member="Tp::PendingHandles::validNames" ref="ab4dd0740e8aaedacc945c1470d67d63d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QStringList Tp::PendingHandles::validNames </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af966a0dc9e6d69d66193b7ddca23aec8"></a><!-- doxytag: member="Tp::PendingHandles::invalidNames" ref="af966a0dc9e6d69d66193b7ddca23aec8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QHash< QString, QPair< QString, QString > > Tp::PendingHandles::invalidNames </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac80bd40f0e27b8eed444fe2cbf54e472"></a><!-- doxytag: member="Tp::PendingHandles::handlesToReference" ref="ac80bd40f0e27b8eed444fe2cbf54e472" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const UIntList & Tp::PendingHandles::handlesToReference </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the operation was a reference (as returned by <a class="el" href="classTp_1_1PendingHandles.html#a974ddc8bddde79caef0a9e3a79ee7999">isReference()</a>), returns the handles which were to be referenced. Otherwise, returns an empty list.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to a list of the handles specified to be referenced. </dd></dl>
</div>
</div>
<a class="anchor" id="ac524bbfe23f411945a48b30c42409860"></a><!-- doxytag: member="Tp::PendingHandles::handles" ref="ac524bbfe23f411945a48b30c42409860" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1ReferencedHandles.html">ReferencedHandles</a> Tp::PendingHandles::handles </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the now-referenced handles resulting from the operation. If the operation has not (yet) finished successfully (<a class="el" href="classTp_1_1PendingOperation.html#adb775a9b977ebb85e1ee0473669f45b0">isFinished()</a> returns <code>false</code>), the return value is undefined.</p>
<p>For requests of new handles, <code><a class="el" href="classTp_1_1PendingHandles.html#ac524bbfe23f411945a48b30c42409860">handles()</a>[i]</code> will be the handle corresponding to the entity name <code>namesToRequest()[i]</code>. For references of existing handles, <code><a class="el" href="classTp_1_1PendingHandles.html#ac524bbfe23f411945a48b30c42409860">handles()</a>[i] == <a class="el" href="classTp_1_1PendingHandles.html#ac80bd40f0e27b8eed444fe2cbf54e472">handlesToReference()</a>[i]</code> will be true for any <code>i</code>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classTp_1_1ReferencedHandles.html" title="Helper container for safe management of handle lifetimes. Every handle in a ReferencedHandles...">ReferencedHandles</a> instance containing the handles. </dd></dl>
</div>
</div>
<a class="anchor" id="aa101cc641ddfa3e21ce2cd5e18e741f5"></a><!-- doxytag: member="Tp::PendingHandles::invalidHandles" ref="aa101cc641ddfa3e21ce2cd5e18e741f5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UIntList Tp::PendingHandles::invalidHandles </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</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 © 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>
|
