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
|
<?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::ReadyObject 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_1ReadyObject.html">ReadyObject</a>
</div>
<div class="contents">
<h1>Tp::ReadyObject Class Reference</h1><!-- doxytag: class="Tp::ReadyObject" -->
<p><code>#include <<a class="el" href="ready-object_8h_source.html">></a>></code></p>
<p>Inherited by <a class="el" href="classTp_1_1Account.html">Tp::Account</a>, <a class="el" href="classTp_1_1AccountManager.html">Tp::AccountManager</a>, <a class="el" href="classTp_1_1Channel.html">Tp::Channel</a>, <a class="el" href="classTp_1_1ChannelDispatchOperation.html">Tp::ChannelDispatchOperation</a>, <a class="el" href="classTp_1_1ChannelRequest.html">Tp::ChannelRequest</a>, <a class="el" href="classTp_1_1Connection.html">Tp::Connection</a>, <a class="el" href="classTp_1_1ConnectionManager.html">Tp::ConnectionManager</a>, <a class="el" href="classTp_1_1MediaContent.html">Tp::MediaContent</a><code> [private]</code>, and <a class="el" href="classTp_1_1MediaStream.html">Tp::MediaStream</a><code> [private]</code>.</p>
<p><a href="classTp_1_1ReadyObject-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1ReadyObject.html#a6fe8ddf446194387f0eae5169c43c32b">ReadyObject</a> (QObject *object, const <a class="el" href="classTp_1_1Feature.html">Feature</a> &featureCore)
<li>virtual <a class="el" href="classTp_1_1ReadyObject.html#a81f5ea8834c094181c0b5fa5e222809d">~ReadyObject</a> ()
<li>virtual bool <a class="el" href="classTp_1_1ReadyObject.html#a344fc63eaef5278cbf938eaa1ed4c635">isReady</a> (const <a class="el" href="classTp_1_1Features.html">Features</a> &features=<a class="el" href="classTp_1_1Features.html">Features</a>()) const
<li>virtual <a class="el" href="classTp_1_1PendingReady.html">PendingReady</a> * <a class="el" href="classTp_1_1ReadyObject.html#ac02393f99a46725a4ffee32caaec13cc">becomeReady</a> (const <a class="el" href="classTp_1_1Features.html">Features</a> &requestedFeatures=<a class="el" href="classTp_1_1Features.html">Features</a>())
<li>virtual <a class="el" href="classTp_1_1Features.html">Features</a> <a class="el" href="classTp_1_1ReadyObject.html#aa760fb2e39a85324384e337586a76360">requestedFeatures</a> () const
<li>virtual <a class="el" href="classTp_1_1Features.html">Features</a> <a class="el" href="classTp_1_1ReadyObject.html#a417478987395e7f7914527d44603450b">actualFeatures</a> () const
<li>virtual <a class="el" href="classTp_1_1Features.html">Features</a> <a class="el" href="classTp_1_1ReadyObject.html#a404a435b24239ae81bcd58c06da18478">missingFeatures</a> () const
</ul>
<h2>Protected Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1ReadinessHelper.html">ReadinessHelper</a> * <a class="el" href="classTp_1_1ReadyObject.html#a34fdf6035f206e96a34f71d5dd7cb4c9">readinessHelper</a> () const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><TelepathyQt4/ReadyObject> </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6fe8ddf446194387f0eae5169c43c32b"></a><!-- doxytag: member="Tp::ReadyObject::ReadyObject" ref="a6fe8ddf446194387f0eae5169c43c32b" args="(QObject *object, const Feature &featureCore)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::ReadyObject::ReadyObject </td>
<td>(</td>
<td class="paramtype">QObject * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTp_1_1Feature.html">Feature</a> & </td>
<td class="paramname"> <em>featureCore</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a new <a class="el" href="classTp_1_1ReadyObject.html">ReadyObject</a> object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The QObject the object refers to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>featureCore</em> </td><td>The core feature of the object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a81f5ea8834c094181c0b5fa5e222809d"></a><!-- doxytag: member="Tp::ReadyObject::~ReadyObject" ref="a81f5ea8834c094181c0b5fa5e222809d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::ReadyObject::~ReadyObject </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a344fc63eaef5278cbf938eaa1ed4c635"></a><!-- doxytag: member="Tp::ReadyObject::isReady" ref="a344fc63eaef5278cbf938eaa1ed4c635" args="(const Features &features=Features()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::ReadyObject::isReady </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1Features.html">Features</a> & </td>
<td class="paramname"> <em>features</em> = <code><a class="el" href="classTp_1_1Features.html">Features</a>()</code></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this object has finished its initial setup.</p>
<p>This is mostly useful as a sanity check, in code that shouldn't be run until the object is ready. To wait for the object to be ready, call <a class="el" href="classTp_1_1ReadyObject.html#ac02393f99a46725a4ffee32caaec13cc">becomeReady()</a> and connect to the finished signal on the result.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>features</em> </td><td>The features which should be tested </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the object has finished its initial setup for basic functionality plus the given features </dd></dl>
</div>
</div>
<a class="anchor" id="ac02393f99a46725a4ffee32caaec13cc"></a><!-- doxytag: member="Tp::ReadyObject::becomeReady" ref="ac02393f99a46725a4ffee32caaec13cc" args="(const Features &requestedFeatures=Features())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1PendingReady.html">PendingReady</a> * Tp::ReadyObject::becomeReady </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1Features.html">Features</a> & </td>
<td class="paramname"> <em>requestedFeatures</em> = <code><a class="el" href="classTp_1_1Features.html">Features</a>()</code></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pending operation which will succeed when this object finishes its initial setup, or will fail if a fatal error occurs during this initial setup.</p>
<p>If an empty set is used FeatureCore will be considered as the requested feature.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>requestedFeatures</em> </td><td>The features which should be enabled </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classTp_1_1PendingReady.html" title="Class containing the features requested and the reply to a request for an object...">PendingReady</a> object which will emit finished when this object has finished or failed initial setup for basic functionality plus the given features </dd></dl>
</div>
</div>
<a class="anchor" id="aa760fb2e39a85324384e337586a76360"></a><!-- doxytag: member="Tp::ReadyObject::requestedFeatures" ref="aa760fb2e39a85324384e337586a76360" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1Features.html">Features</a> Tp::ReadyObject::requestedFeatures </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a417478987395e7f7914527d44603450b"></a><!-- doxytag: member="Tp::ReadyObject::actualFeatures" ref="a417478987395e7f7914527d44603450b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1Features.html">Features</a> Tp::ReadyObject::actualFeatures </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a404a435b24239ae81bcd58c06da18478"></a><!-- doxytag: member="Tp::ReadyObject::missingFeatures" ref="a404a435b24239ae81bcd58c06da18478" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1Features.html">Features</a> Tp::ReadyObject::missingFeatures </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a34fdf6035f206e96a34f71d5dd7cb4c9"></a><!-- doxytag: member="Tp::ReadyObject::readinessHelper" ref="a34fdf6035f206e96a34f71d5dd7cb4c9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1ReadinessHelper.html">ReadinessHelper</a> * Tp::ReadyObject::readinessHelper </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<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 © 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>
|
