File: classTp_1_1RoomListChannel.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 (173 lines) | stat: -rw-r--r-- 8,961 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
<?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::RoomListChannel 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_1RoomListChannel.html">RoomListChannel</a>
  </div>
<div class="contents">
<h1>Tp::RoomListChannel Class Reference<br/>
<small>
[<a class="el" href="group__clientchannel.html">Channel proxies</a>]</small>
</h1><!-- doxytag: class="Tp::RoomListChannel" --><!-- doxytag: inherits="Tp::Channel" -->
<p><code>#include &lt;<a class="el" href="room-list-channel_8h_source.html">TelepathyQt4/RoomListChannel</a>&gt;</code></p>

<p>Inherits <a class="el" href="classTp_1_1Channel.html">Tp::Channel</a>.</p>

<p><a href="classTp_1_1RoomListChannel-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li>virtual <a class="el" href="classTp_1_1RoomListChannel.html#a4a13963770e6aaf4e641c5805804c9f9">~RoomListChannel</a> ()
</ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="classTp_1_1SharedPtr.html">RoomListChannelPtr</a> <a class="el" href="classTp_1_1RoomListChannel.html#ab9c88b2759fc8fe16922e46946277c3e">create</a> (const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;connection, const QString &amp;objectPath, const QVariantMap &amp;immutableProperties)
</ul>
<h2>Protected Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1RoomListChannel.html#a7f13631277fd4898d0bc0a94657b552e">RoomListChannel</a> (const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;connection, const QString &amp;objectPath, const QVariantMap &amp;immutableProperties)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>High-level proxy object for accessing remote Channel objects of the RoomList channel type.</p>
<p>This subclass of <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a> will eventually provide a high-level API for the RoomList interface. Until then, it's just a <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a>. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4a13963770e6aaf4e641c5805804c9f9"></a><!-- doxytag: member="Tp::RoomListChannel::~RoomListChannel" ref="a4a13963770e6aaf4e641c5805804c9f9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Tp::RoomListChannel::~RoomListChannel </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Class destructor. </p>

</div>
</div>
<a class="anchor" id="a7f13631277fd4898d0bc0a94657b552e"></a><!-- doxytag: member="Tp::RoomListChannel::RoomListChannel" ref="a7f13631277fd4898d0bc0a94657b552e" args="(const ConnectionPtr &amp;connection, const QString &amp;objectPath, const QVariantMap &amp;immutableProperties)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Tp::RoomListChannel::RoomListChannel </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>connection</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>objectPath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QVariantMap &amp;&nbsp;</td>
          <td class="paramname"> <em>immutableProperties</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>Creates a <a class="el" href="classTp_1_1RoomListChannel.html">RoomListChannel</a> associated with the given object on the same service as the given connection.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>connection</em>&nbsp;</td><td><a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a> owning this <a class="el" href="classTp_1_1RoomListChannel.html">RoomListChannel</a>, and specifying the service. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>objectPath</em>&nbsp;</td><td>Path to the object on the service. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>immutableProperties</em>&nbsp;</td><td>The immutable properties of the channel, as signalled by NewChannels or returned by CreateChannel or EnsureChannel </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab9c88b2759fc8fe16922e46946277c3e"></a><!-- doxytag: member="Tp::RoomListChannel::create" ref="ab9c88b2759fc8fe16922e46946277c3e" args="(const ConnectionPtr &amp;connection, const QString &amp;objectPath, const QVariantMap &amp;immutableProperties)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">RoomListChannelPtr</a> Tp::RoomListChannel::create </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>connection</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>objectPath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QVariantMap &amp;&nbsp;</td>
          <td class="paramname"> <em>immutableProperties</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</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>connection</em>&nbsp;</td><td><a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a> owning this channel, and specifying the service. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>objectPath</em>&nbsp;</td><td>The object path of this channel. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>immutableProperties</em>&nbsp;</td><td>The immutable properties of this channel. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A ChannelPtr object pointing to the newly created <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a> object. </dd></dl>

<p>Reimplemented from <a class="el" href="classTp_1_1Channel.html#ab9e80e6c7d574f9f853cf6c47801da72">Tp::Channel</a>.</p>

</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>