File: text-channel_8h_source.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 (199 lines) | stat: -rw-r--r-- 18,613 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
<?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: text-channel.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">&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 -->
<h1>text-channel.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Text channel client-side proxy</span>
<a name="l00002"></a>00002 <span class="comment"> *</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (C) 2009 Collabora Ltd. &lt;http://www.collabora.co.uk/&gt;</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2009 Nokia Corporation</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00008"></a>00008 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00014"></a>00014 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00017"></a>00017 <span class="comment"> * License along with this library; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef _TelepathyQt4_text_channel_h_HEADER_GUARD_</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define _TelepathyQt4_text_channel_h_HEADER_GUARD_</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef IN_TELEPATHY_QT4_HEADER</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#error IN_TELEPATHY_QT4_HEADER</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;TelepathyQt4/Channel&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;TelepathyQt4/PendingOperation&gt;</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="keyword">namespace </span>Tp
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="keyword">class </span>PendingReadyChannel;
<a name="l00035"></a>00035 <span class="keyword">class </span>Message;
<a name="l00036"></a>00036 <span class="keyword">class </span>ReceivedMessage;
<a name="l00037"></a>00037 <span class="keyword">class </span>TextChannel;
<a name="l00038"></a>00038 
<a name="l00039"></a><a class="code" href="classTp_1_1PendingSendMessage.html">00039</a> <span class="keyword">class </span>TELEPATHY_QT4_EXPORT <a class="code" href="classTp_1_1PendingSendMessage.html">PendingSendMessage</a> : <span class="keyword">public</span> <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a>
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041     Q_OBJECT
<a name="l00042"></a>00042     Q_DISABLE_COPY(<a class="code" href="classTp_1_1PendingSendMessage.html">PendingSendMessage</a>)
<a name="l00043"></a>00043 
<a name="l00044"></a>00044 <span class="keyword">public</span>:
<a name="l00045"></a>00045     <a class="code" href="classTp_1_1PendingSendMessage.html">PendingSendMessage</a>(<span class="keyword">const</span> <a class="code" href="classTp_1_1Message.html" title="The Message class represents a Telepathy message in a text channel. These objects...">Message</a> &amp;message, QObject *parent = 0);
<a name="l00046"></a>00046     ~<a class="code" href="classTp_1_1PendingSendMessage.html">PendingSendMessage</a>();
<a name="l00047"></a>00047 
<a name="l00048"></a>00048     QString sentMessageToken() <span class="keyword">const</span>;
<a name="l00049"></a>00049     <a class="code" href="classTp_1_1Message.html" title="The Message class represents a Telepathy message in a text channel. These objects...">Message</a> message() <span class="keyword">const</span>;
<a name="l00050"></a>00050 
<a name="l00051"></a>00051 <span class="keyword">private</span> Q_SLOTS:
<a name="l00052"></a>00052     <span class="keywordtype">void</span> onTextSent(QDBusPendingCallWatcher *);
<a name="l00053"></a>00053     <span class="keywordtype">void</span> onMessageSent(QDBusPendingCallWatcher *);
<a name="l00054"></a>00054 
<a name="l00055"></a>00055 <span class="keyword">private</span>:
<a name="l00056"></a><a class="code" href="classTp_1_1PendingSendMessage.html#a39526f26101e38663d41d61cbfbb8e83">00056</a>     <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classTp_1_1TextChannel.html" title="The TextChannel class provides an object representing a Telepathy channel of type...">TextChannel</a>;
<a name="l00057"></a>00057 
<a name="l00058"></a><a class="code" href="classTp_1_1PendingSendMessage.html#a15a94ff2bd578e608a94d0a1ba4bd3e0">00058</a>     <span class="keyword">struct </span>Private;
<a name="l00059"></a>00059     <span class="keyword">friend</span> <span class="keyword">struct </span>Private;
<a name="l00060"></a>00060     Private *mPriv;
<a name="l00061"></a>00061 };
<a name="l00062"></a>00062 
<a name="l00063"></a><a class="code" href="classTp_1_1TextChannel.html">00063</a> <span class="keyword">class </span>TELEPATHY_QT4_EXPORT <a class="code" href="classTp_1_1TextChannel.html" title="The TextChannel class provides an object representing a Telepathy channel of type...">TextChannel</a> : <span class="keyword">public</span> <a class="code" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a>
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065     Q_OBJECT
<a name="l00066"></a>00066     Q_DISABLE_COPY(<a class="code" href="classTp_1_1TextChannel.html" title="The TextChannel class provides an object representing a Telepathy channel of type...">TextChannel</a>)
<a name="l00067"></a>00067 
<a name="l00068"></a>00068 <span class="keyword">public</span>:
<a name="l00069"></a><a class="code" href="classTp_1_1TextChannel.html#a7293d821bbdfee44693cc1161ef7f6dc">00069</a>     <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classTp_1_1Feature.html">Feature</a> FeatureMessageQueue;
<a name="l00070"></a><a class="code" href="classTp_1_1TextChannel.html#a74b6f9875f38e3c48ecaaeb74762750d">00070</a>     <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classTp_1_1Feature.html">Feature</a> FeatureMessageCapabilities;
<a name="l00071"></a><a class="code" href="classTp_1_1TextChannel.html#a53b22df8df169c3e21e3ebc595334db1">00071</a>     <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classTp_1_1Feature.html">Feature</a> FeatureMessageSentSignal;
<a name="l00072"></a><a class="code" href="classTp_1_1TextChannel.html#aaa1ede637039b587f9072d9cbed336b0">00072</a>     <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classTp_1_1Feature.html">Feature</a> FeatureChatState;
<a name="l00073"></a>00073 
<a name="l00074"></a>00074     <span class="keyword">static</span> <a class="code" href="classTp_1_1SharedPtr.html">TextChannelPtr</a> create(<span class="keyword">const</span> <a class="code" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;connection,
<a name="l00075"></a>00075             <span class="keyword">const</span> QString &amp;objectPath, <span class="keyword">const</span> QVariantMap &amp;immutableProperties);
<a name="l00076"></a>00076 
<a name="l00077"></a>00077     <span class="keyword">virtual</span> ~<a class="code" href="classTp_1_1TextChannel.html" title="The TextChannel class provides an object representing a Telepathy channel of type...">TextChannel</a>();
<a name="l00078"></a>00078 
<a name="l00079"></a>00079     <span class="keywordtype">bool</span> hasMessagesInterface() <span class="keyword">const</span>;
<a name="l00080"></a>00080     <span class="keywordtype">bool</span> hasChatStateInterface() <span class="keyword">const</span>;
<a name="l00081"></a>00081     <span class="keywordtype">bool</span> canInviteContacts() <span class="keyword">const</span>;
<a name="l00082"></a>00082 
<a name="l00083"></a>00083     <span class="comment">// requires FeatureMessageCapabilities</span>
<a name="l00084"></a>00084     QStringList supportedContentTypes() <span class="keyword">const</span>;
<a name="l00085"></a>00085     MessagePartSupportFlags messagePartSupport() <span class="keyword">const</span>;
<a name="l00086"></a>00086     DeliveryReportingSupportFlags deliveryReportingSupport() <span class="keyword">const</span>;
<a name="l00087"></a>00087 
<a name="l00088"></a>00088     <span class="comment">// requires FeatureMessageQueue</span>
<a name="l00089"></a>00089     QList&lt;ReceivedMessage&gt; messageQueue() <span class="keyword">const</span>;
<a name="l00090"></a>00090 
<a name="l00091"></a>00091     <span class="comment">// requires FeatureChatState</span>
<a name="l00092"></a>00092     ChannelChatState chatState(<span class="keyword">const</span> <a class="code" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> &amp;contact) <span class="keyword">const</span>;
<a name="l00093"></a>00093 
<a name="l00094"></a>00094 <span class="keyword">public</span> Q_SLOTS:
<a name="l00095"></a>00095     <span class="keywordtype">void</span> acknowledge(<span class="keyword">const</span> QList&lt;ReceivedMessage&gt; &amp;messages);
<a name="l00096"></a>00096 
<a name="l00097"></a>00097     <span class="keywordtype">void</span> forget(<span class="keyword">const</span> QList&lt;ReceivedMessage&gt; &amp;messages);
<a name="l00098"></a>00098 
<a name="l00099"></a>00099     <a class="code" href="classTp_1_1PendingSendMessage.html">PendingSendMessage</a> *send(<span class="keyword">const</span> QString &amp;text,
<a name="l00100"></a>00100             ChannelTextMessageType type = ChannelTextMessageTypeNormal,
<a name="l00101"></a>00101             MessageSendingFlags flags = 0);
<a name="l00102"></a>00102 
<a name="l00103"></a>00103     <a class="code" href="classTp_1_1PendingSendMessage.html">PendingSendMessage</a> *send(<span class="keyword">const</span> MessagePartList &amp;parts,
<a name="l00104"></a>00104             MessageSendingFlags flags = 0);
<a name="l00105"></a>00105 
<a name="l00106"></a><a class="code" href="classTp_1_1TextChannel.html#a8f6750e534c4fc9882ff5c60a5e0e1af">00106</a>     <span class="keyword">inline</span> <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *inviteContacts(
<a name="l00107"></a>00107             <span class="keyword">const</span> QList&lt;ContactPtr&gt; &amp;contacts,
<a name="l00108"></a>00108             <span class="keyword">const</span> QString &amp;message = QString())
<a name="l00109"></a>00109     {
<a name="l00110"></a>00110         <span class="keywordflow">return</span> groupAddContacts(contacts, message);
<a name="l00111"></a>00111     }
<a name="l00112"></a>00112 
<a name="l00113"></a>00113     <a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> *requestChatState(ChannelChatState state);
<a name="l00114"></a>00114 
<a name="l00115"></a>00115 Q_SIGNALS:
<a name="l00116"></a>00116     <span class="comment">// FeatureMessageSentSignal</span>
<a name="l00117"></a>00117     <span class="keywordtype">void</span> messageSent(<span class="keyword">const</span> <a class="code" href="classTp_1_1Message.html" title="The Message class represents a Telepathy message in a text channel. These objects...">Tp::Message</a> &amp;message,
<a name="l00118"></a>00118             Tp::MessageSendingFlags flags,
<a name="l00119"></a>00119             <span class="keyword">const</span> QString &amp;sentMessageToken);
<a name="l00120"></a>00120 
<a name="l00121"></a>00121     <span class="comment">// FeatureMessageQueue</span>
<a name="l00122"></a>00122     <span class="keywordtype">void</span> messageReceived(<span class="keyword">const</span> <a class="code" href="classTp_1_1ReceivedMessage.html" title="The ReceivedMessage class is a subclass of Message, representing a received message...">Tp::ReceivedMessage</a> &amp;message);
<a name="l00123"></a>00123     <span class="keywordtype">void</span> pendingMessageRemoved(
<a name="l00124"></a>00124             <span class="keyword">const</span> <a class="code" href="classTp_1_1ReceivedMessage.html" title="The ReceivedMessage class is a subclass of Message, representing a received message...">Tp::ReceivedMessage</a> &amp;message);
<a name="l00125"></a>00125 
<a name="l00126"></a>00126     <span class="comment">// FeatureChatState</span>
<a name="l00127"></a>00127     <span class="keywordtype">void</span> chatStateChanged(<span class="keyword">const</span> <a class="code" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">Tp::ContactPtr</a> &amp;contact,
<a name="l00128"></a>00128             ChannelChatState state);
<a name="l00129"></a>00129 
<a name="l00130"></a>00130 <span class="keyword">protected</span>:
<a name="l00131"></a>00131     <a class="code" href="classTp_1_1TextChannel.html" title="The TextChannel class provides an object representing a Telepathy channel of type...">TextChannel</a>(<span class="keyword">const</span> <a class="code" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;connection, <span class="keyword">const</span> QString &amp;objectPath,
<a name="l00132"></a>00132             <span class="keyword">const</span> QVariantMap &amp;immutableProperties);
<a name="l00133"></a>00133 
<a name="l00134"></a>00134 <span class="keyword">private</span> Q_SLOTS:
<a name="l00135"></a>00135     <span class="keywordtype">void</span> onContactsFinished(<a class="code" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">Tp::PendingOperation</a> *);
<a name="l00136"></a>00136     <span class="keywordtype">void</span> onAcknowledgePendingMessagesReply(QDBusPendingCallWatcher *);
<a name="l00137"></a>00137 
<a name="l00138"></a>00138     <span class="keywordtype">void</span> onMessageSent(<span class="keyword">const</span> Tp::MessagePartList &amp;, uint,
<a name="l00139"></a>00139             <span class="keyword">const</span> QString &amp;);
<a name="l00140"></a>00140     <span class="keywordtype">void</span> onMessageReceived(<span class="keyword">const</span> Tp::MessagePartList &amp;);
<a name="l00141"></a>00141     <span class="keywordtype">void</span> onPendingMessagesRemoved(<span class="keyword">const</span> Tp::UIntList &amp;);
<a name="l00142"></a>00142 
<a name="l00143"></a>00143     <span class="keywordtype">void</span> onTextSent(uint, uint, <span class="keyword">const</span> QString &amp;);
<a name="l00144"></a>00144     <span class="keywordtype">void</span> onTextReceived(uint, uint, uint, uint, uint, <span class="keyword">const</span> QString &amp;);
<a name="l00145"></a>00145     <span class="keywordtype">void</span> onTextSendError(uint, uint, uint, <span class="keyword">const</span> QString &amp;);
<a name="l00146"></a>00146 
<a name="l00147"></a>00147     <span class="keywordtype">void</span> gotProperties(QDBusPendingCallWatcher *);
<a name="l00148"></a>00148     <span class="keywordtype">void</span> gotPendingMessages(QDBusPendingCallWatcher *);
<a name="l00149"></a>00149 
<a name="l00150"></a>00150     <span class="keywordtype">void</span> onChatStateChanged(uint, uint);
<a name="l00151"></a>00151 
<a name="l00152"></a>00152 <span class="keyword">private</span>:
<a name="l00153"></a><a class="code" href="classTp_1_1TextChannel.html#a15a94ff2bd578e608a94d0a1ba4bd3e0">00153</a>     <span class="keyword">struct </span>Private;
<a name="l00154"></a>00154     <span class="keyword">friend</span> <span class="keyword">struct </span>Private;
<a name="l00155"></a>00155     Private *mPriv;
<a name="l00156"></a>00156 };
<a name="l00157"></a>00157 
<a name="l00158"></a>00158 } <span class="comment">// Tp</span>
<a name="l00159"></a>00159 
<a name="l00160"></a>00160 <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 &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>