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
|
<?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: contact.h Source File</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 -->
<h1>contact.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * This file is part of TelepathyQt4</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2008 Collabora Ltd. <http://www.collabora.co.uk/></span>
<a name="l00005"></a>00005 <span class="comment"> * Copyright (C) 2008 Nokia Corporation</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00008"></a>00008 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00009"></a>00009 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00010"></a>00010 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00015"></a>00015 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00018"></a>00018 <span class="comment"> * License along with this library; if not, write to the Free Software</span>
<a name="l00019"></a>00019 <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _TelepathyQt4_contact_h_HEADER_GUARD_</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _TelepathyQt4_contact_h_HEADER_GUARD_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef IN_TELEPATHY_QT4_HEADER</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#error IN_TELEPATHY_QT4_HEADER</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <QObject></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <QSet></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <QSharedPointer></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <QVariantMap></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="preprocessor">#include <TelepathyQt4/Types></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">namespace </span>Tp
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">class </span>ContactCapabilities;
<a name="l00040"></a>00040 <span class="keyword">class </span>ContactLocation;
<a name="l00041"></a>00041 <span class="keyword">class </span>ContactManager;
<a name="l00042"></a>00042 <span class="keyword">class </span>PendingContactInfo;
<a name="l00043"></a>00043 <span class="keyword">class </span>PendingOperation;
<a name="l00044"></a>00044 <span class="keyword">class </span>ReferencedHandles;
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="classTp_1_1Contact.html">00046</a> <span class="keyword">class </span>TELEPATHY_QT4_EXPORT <a class="code" href="classTp_1_1Contact.html">Contact</a> : <span class="keyword">public</span> QObject
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 Q_OBJECT
<a name="l00049"></a>00049 Q_DISABLE_COPY(<a class="code" href="classTp_1_1Contact.html">Contact</a>);
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00052"></a><a class="code" href="classTp_1_1Contact.html#a3c12a1037c64a4969f55e5bf19729560">00052</a> <span class="keyword">enum</span> <a class="code" href="classTp_1_1Contact.html#a3c12a1037c64a4969f55e5bf19729560">Feature</a> {
<a name="l00053"></a><a class="code" href="classTp_1_1Contact.html#a3c12a1037c64a4969f55e5bf19729560a873440b3ee48c29a897f9debbfa0afeb">00053</a> FeatureAlias,
<a name="l00054"></a><a class="code" href="classTp_1_1Contact.html#a3c12a1037c64a4969f55e5bf19729560a77f88d1a3525b8d3201b554aec700540">00054</a> FeatureAvatarToken,
<a name="l00055"></a><a class="code" href="classTp_1_1Contact.html#a3c12a1037c64a4969f55e5bf19729560afb8b268e173f460379657ba737646a9d">00055</a> FeatureSimplePresence,
<a name="l00056"></a><a class="code" href="classTp_1_1Contact.html#a3c12a1037c64a4969f55e5bf19729560affc47a17ff5700c5c5ac08fb2660fec8">00056</a> FeatureCapabilities,
<a name="l00057"></a><a class="code" href="classTp_1_1Contact.html#a3c12a1037c64a4969f55e5bf19729560af00debd165ff107994f44f8b1e0b283e">00057</a> FeatureLocation,
<a name="l00058"></a><a class="code" href="classTp_1_1Contact.html#a3c12a1037c64a4969f55e5bf19729560a24263058f1986dc84d9e34db3b43c749">00058</a> FeatureInfo,
<a name="l00059"></a><a class="code" href="classTp_1_1Contact.html#a3c12a1037c64a4969f55e5bf19729560abe91d23d32bb823105622b1df4cb7d3c">00059</a> _Padding = 0xFFFFFFFF
<a name="l00060"></a>00060 };
<a name="l00061"></a>00061
<a name="l00062"></a><a class="code" href="classTp_1_1Contact.html#ab758b1908d04f9870c8091456f3ddc5b">00062</a> <span class="keyword">enum</span> <a class="code" href="classTp_1_1Contact.html#ab758b1908d04f9870c8091456f3ddc5b">PresenceState</a> {
<a name="l00063"></a><a class="code" href="classTp_1_1Contact.html#ab758b1908d04f9870c8091456f3ddc5baf7076e1e97f86d1c4ebc4ebe290e3c61">00063</a> PresenceStateNo,
<a name="l00064"></a><a class="code" href="classTp_1_1Contact.html#ab758b1908d04f9870c8091456f3ddc5ba9c5f79349a1de47e9734bf77042f0728">00064</a> PresenceStateAsk,
<a name="l00065"></a><a class="code" href="classTp_1_1Contact.html#ab758b1908d04f9870c8091456f3ddc5ba7eabc92c3f6ae76802f5bdfac658ebdc">00065</a> PresenceStateYes
<a name="l00066"></a>00066 };
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <a class="code" href="classTp_1_1ContactManager.html" title="The ContactManager class is responsible for managing contacts.">ContactManager</a> *manager() <span class="keyword">const</span>;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <a class="code" href="classTp_1_1ReferencedHandles.html" title="Helper container for safe management of handle lifetimes. Every handle in a ReferencedHandles...">ReferencedHandles</a> handle() <span class="keyword">const</span>;
<a name="l00071"></a>00071 QString id() <span class="keyword">const</span>;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 QSet<Feature> requestedFeatures() <span class="keyword">const</span>;
<a name="l00074"></a>00074 QSet<Feature> actualFeatures() <span class="keyword">const</span>;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 QString alias() <span class="keyword">const</span>;
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keywordtype">bool</span> isAvatarTokenKnown() <span class="keyword">const</span>;
<a name="l00079"></a>00079 QString avatarToken() <span class="keyword">const</span>;
<a name="l00080"></a>00080
<a name="l00081"></a>00081 QString presenceStatus() <span class="keyword">const</span>;
<a name="l00082"></a>00082 uint presenceType() <span class="keyword">const</span>;
<a name="l00083"></a>00083 QString presenceMessage() <span class="keyword">const</span>;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <a class="code" href="classTp_1_1ContactCapabilities.html" title="The ContactCapabilities class provides an object representing the capabilities of...">ContactCapabilities</a> *capabilities() <span class="keyword">const</span>;
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <a class="code" href="classTp_1_1ContactLocation.html" title="The ContactLocation class provides an object representing the location of a Contact...">ContactLocation</a> *location() <span class="keyword">const</span>;
<a name="l00088"></a>00088
<a name="l00089"></a>00089 ContactInfoFieldList info() <span class="keyword">const</span>;
<a name="l00090"></a>00090 <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *refreshInfo();
<a name="l00091"></a>00091 <a class="code" href="classTp_1_1PendingContactInfo.html" title="Class containing the parameters of and the reply to an asynchronous contact info...">PendingContactInfo</a> *requestInfo();
<a name="l00092"></a>00092
<a name="l00093"></a>00093 PresenceState subscriptionState() <span class="keyword">const</span>;
<a name="l00094"></a>00094 PresenceState publishState() <span class="keyword">const</span>;
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *requestPresenceSubscription(<span class="keyword">const</span> QString &message = QString());
<a name="l00097"></a>00097 <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *removePresenceSubscription(<span class="keyword">const</span> QString &message = QString());
<a name="l00098"></a>00098 <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *authorizePresencePublication(<span class="keyword">const</span> QString &message = QString());
<a name="l00099"></a>00099 <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *removePresencePublication(<span class="keyword">const</span> QString &message = QString());
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="keywordtype">bool</span> isBlocked() <span class="keyword">const</span>;
<a name="l00102"></a>00102 <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *block(<span class="keywordtype">bool</span> value = <span class="keyword">true</span>);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 QStringList groups() <span class="keyword">const</span>;
<a name="l00105"></a>00105 <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *addToGroup(<span class="keyword">const</span> QString &group);
<a name="l00106"></a>00106 <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *removeFromGroup(<span class="keyword">const</span> QString &group);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 ~<a class="code" href="classTp_1_1Contact.html">Contact</a>();
<a name="l00109"></a>00109
<a name="l00110"></a>00110 Q_SIGNALS:
<a name="l00111"></a>00111 <span class="keywordtype">void</span> aliasChanged(<span class="keyword">const</span> QString &alias);
<a name="l00112"></a>00112 <span class="keywordtype">void</span> avatarTokenChanged(<span class="keyword">const</span> QString &avatarToken);
<a name="l00113"></a>00113 <span class="keywordtype">void</span> simplePresenceChanged(<span class="keyword">const</span> QString &status, uint type, <span class="keyword">const</span> QString &presenceMessage);
<a name="l00114"></a>00114 <span class="keywordtype">void</span> capabilitiesChanged(<a class="code" href="classTp_1_1ContactCapabilities.html" title="The ContactCapabilities class provides an object representing the capabilities of...">Tp::ContactCapabilities</a> *caps);
<a name="l00115"></a>00115 <span class="keywordtype">void</span> locationUpdated(<a class="code" href="classTp_1_1ContactLocation.html" title="The ContactLocation class provides an object representing the location of a Contact...">Tp::ContactLocation</a> *location);
<a name="l00116"></a>00116 <span class="keywordtype">void</span> infoChanged(<span class="keyword">const</span> Tp::ContactInfoFieldList &info);
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keywordtype">void</span> subscriptionStateChanged(<a class="code" href="classTp_1_1Contact.html#ab758b1908d04f9870c8091456f3ddc5b">Tp::Contact::PresenceState</a> state);
<a name="l00119"></a>00119 <span class="keywordtype">void</span> publishStateChanged(<a class="code" href="classTp_1_1Contact.html#ab758b1908d04f9870c8091456f3ddc5b">Tp::Contact::PresenceState</a> state);
<a name="l00120"></a>00120 <span class="keywordtype">void</span> blockStatusChanged(<span class="keywordtype">bool</span> blocked);
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keywordtype">void</span> addedToGroup(<span class="keyword">const</span> QString &group);
<a name="l00123"></a>00123 <span class="keywordtype">void</span> removedFromGroup(<span class="keyword">const</span> QString &group);
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">// TODO: consider how the Renaming interface should work and map to Contacts</span>
<a name="l00126"></a>00126 <span class="comment">// I guess it would be something like:</span>
<a name="l00127"></a>00127 <span class="comment">// void renamedTo(Tp::ContactPtr)</span>
<a name="l00128"></a>00128 <span class="comment">// with that contact getting the same features requested as the current one. Or would we rather</span>
<a name="l00129"></a>00129 <span class="comment">// want to signal that change right away with a handle?</span>
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keyword">private</span>:
<a name="l00132"></a>00132 <a class="code" href="classTp_1_1Contact.html">Contact</a>(<a class="code" href="classTp_1_1ContactManager.html" title="The ContactManager class is responsible for managing contacts.">ContactManager</a> *manager, <span class="keyword">const</span> <a class="code" href="classTp_1_1ReferencedHandles.html" title="Helper container for safe management of handle lifetimes. Every handle in a ReferencedHandles...">ReferencedHandles</a> &handle,
<a name="l00133"></a>00133 <span class="keyword">const</span> QSet<Feature> &requestedFeatures, <span class="keyword">const</span> QVariantMap &attributes);
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keywordtype">void</span> augment(<span class="keyword">const</span> QSet<Feature> &requestedFeatures, <span class="keyword">const</span> QVariantMap &attributes);
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keywordtype">void</span> receiveAlias(<span class="keyword">const</span> QString &alias);
<a name="l00138"></a>00138 <span class="keywordtype">void</span> receiveAvatarToken(<span class="keyword">const</span> QString &avatarToken);
<a name="l00139"></a>00139 <span class="keywordtype">void</span> receiveSimplePresence(<span class="keyword">const</span> SimplePresence &presence);
<a name="l00140"></a>00140 <span class="keywordtype">void</span> receiveCapabilities(<span class="keyword">const</span> RequestableChannelClassList &caps);
<a name="l00141"></a>00141 <span class="keywordtype">void</span> receiveLocation(<span class="keyword">const</span> QVariantMap &location);
<a name="l00142"></a>00142 <span class="keywordtype">void</span> receiveInfo(<span class="keyword">const</span> ContactInfoFieldList &info);
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="keywordtype">void</span> setSubscriptionState(PresenceState state);
<a name="l00145"></a>00145 <span class="keywordtype">void</span> setPublishState(PresenceState state);
<a name="l00146"></a>00146 <span class="keywordtype">void</span> setBlocked(<span class="keywordtype">bool</span> value);
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="keywordtype">void</span> setAddedToGroup(<span class="keyword">const</span> QString &group);
<a name="l00149"></a>00149 <span class="keywordtype">void</span> setRemovedFromGroup(<span class="keyword">const</span> QString &group);
<a name="l00150"></a>00150
<a name="l00151"></a><a class="code" href="classTp_1_1Contact.html#a47e77d21706e11e895af252dd4105c97">00151</a> <span class="keyword">struct </span>Private;
<a name="l00152"></a>00152 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classTp_1_1ContactManager.html" title="The ContactManager class is responsible for managing contacts.">ContactManager</a>;
<a name="l00153"></a><a class="code" href="classTp_1_1Contact.html#a15a94ff2bd578e608a94d0a1ba4bd3e0">00153</a> <span class="keyword">friend</span> <span class="keyword">struct </span>Private;
<a name="l00154"></a>00154 Private *mPriv;
<a name="l00155"></a>00155 };
<a name="l00156"></a>00156
<a name="l00157"></a><a class="code" href="namespaceTp.html#aebaea72cfe74d9d2a30ae88539f05c82">00157</a> <span class="keyword">typedef</span> QSet<ContactPtr> <a class="code" href="namespaceTp.html#aebaea72cfe74d9d2a30ae88539f05c82">Contacts</a>;
<a name="l00158"></a>00158
<a name="l00159"></a><a class="code" href="namespaceTp.html#a0a2c90c4d60d7f0753b77c17dfb781a1">00159</a> <span class="keyword">inline</span> uint <a class="code" href="namespaceTp.html#a0a2c90c4d60d7f0753b77c17dfb781a1">qHash</a>(<span class="keyword">const</span> <a class="code" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> &contact)
<a name="l00160"></a>00160 {
<a name="l00161"></a>00161 <span class="keywordflow">return</span> <a class="code" href="namespaceTp.html#a0a2c90c4d60d7f0753b77c17dfb781a1">qHash</a>(contact.data());
<a name="l00162"></a>00162 }
<a name="l00163"></a>00163
<a name="l00164"></a>00164 } <span class="comment">// Tp</span>
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="preprocessor">#endif</span>
</pre></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>
|
