← Back to branch summary

~tiagosh/telepathy-qt/group-chat2

« back to all changes in this revision

Viewing changes to doc/html/a00410.html

  • Committer: Package Import Robot
  • Author(s): Ricardo Salveti de Araujo
  • Date: 2013-06-06 04:56:14 UTC
  • Revision ID: package-import@ubuntu.com-20130606045614-inpxexo6765rnmp1
Tags: upstream-0.9.3
Import upstream version 0.9.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/a00410.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>Tp::StreamTubeServer::Tube Class Reference</title>
 
7
  <link href="doxygen.css" rel="stylesheet" type="text/css" />
 
8
</head>
 
9
<body>
 
10
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
11
<tr>
 
12
<td width="1">&nbsp;&nbsp;</td>
 
13
<td class="postheader" valign="center">
 
14
<a href="index.html">
 
15
<font color="#004faf">Home</font></a>&nbsp;&middot;
 
16
<a href="classes.html">
 
17
<font color="#004faf">All Classes</font></a>&nbsp;&middot;
 
18
<a href="namespaces.html">
 
19
<font color="#004faf">All Namespaces</font></a>&nbsp;&middot;
 
20
<a href="modules.html">
 
21
<font color="#004faf">Modules</font></a>&nbsp;&middot;
 
22
<a href="functions.html">
 
23
<font color="#004faf">Functions</font></a>&nbsp;&middot;
 
24
<a href="files.html">
 
25
<font color="#004faf">Files</font></a>
 
26
</td>
 
27
</tr>
 
28
</table>
 
29
<!-- Generated by Doxygen 1.7.6.1 -->
 
30
  <div id="nav-path" class="navpath">
 
31
    <ul>
 
32
      <li class="navelem"><a class="el" href="a00724.html">Tp</a>      </li>
 
33
      <li class="navelem"><a class="el" href="a00403.html">StreamTubeServer</a>      </li>
 
34
      <li class="navelem"><a class="el" href="a00410.html">Tube</a>      </li>
 
35
    </ul>
 
36
  </div>
 
37
</div>
 
38
<div class="header">
 
39
  <div class="summary">
 
40
<a href="#pub-methods">Public Member Functions</a>  </div>
 
41
  <div class="headertitle">
 
42
<div class="title">Tp::StreamTubeServer::Tube Class Reference</div>  </div>
 
43
</div><!--header-->
 
44
<div class="contents">
 
45
<!-- doxytag: class="Tp::StreamTubeServer::Tube" -->
 
46
<p>The <a class="el" href="a00410.html" title="The StreamTubeServer::Tube class represents a tube being handled by the server.">StreamTubeServer::Tube</a> class represents a tube being handled by the server.  
 
47
 <a href="a00410.html#details">More...</a></p>
 
48
 
 
49
<p><code>#include &lt;<a class="el" href="a00706_source.html">TelepathyQt/StreamTubeServer</a>&gt;</code></p>
 
50
 
 
51
<p><a href="a00948.html">List of all members.</a></p>
 
52
<h2><a name="pub-methods"></a>
 
53
Public Member Functions</h2>
 
54
<ul>
 
55
<li><a class="el" href="a00410.html#a6529318397d861649902642ae4711b77">Tube</a> ()
 
56
<li><a class="el" href="a00410.html#a7405a77abdebb5f0eeedeb73fb979652">Tube</a> (const AccountPtr &amp;<a class="el" href="a00410.html#a12f8951e6ecd4162acf35404101df420">account</a>, const OutgoingStreamTubeChannelPtr &amp;<a class="el" href="a00410.html#aa886319747f3b685f8ab9c9e9c13db4a">channel</a>)
 
57
<li><a class="el" href="a00410.html#a4582e0c1f763920a55241fb27d42e103">Tube</a> (const <a class="el" href="a00410.html">Tube</a> &amp;other)
 
58
<li><a class="el" href="a00410.html#a71568f91c500a4e551c4f7b75ad9f971">~Tube</a> ()
 
59
<li>bool <a class="el" href="a00410.html#a63f048fc5177b4b652aaf8f83033c49d">isValid</a> () const 
 
60
<li><a class="el" href="a00410.html">Tube</a> &amp; <a class="el" href="a00410.html#a73282136752c854a99e67bbeac39bf8b">operator=</a> (const <a class="el" href="a00410.html">Tube</a> &amp;other)
 
61
<li>const AccountPtr &amp; <a class="el" href="a00410.html#a12f8951e6ecd4162acf35404101df420">account</a> () const 
 
62
<li>const <br class="typebreak"/>
 
63
OutgoingStreamTubeChannelPtr &amp; <a class="el" href="a00410.html#aa886319747f3b685f8ab9c9e9c13db4a">channel</a> () const 
 
64
</ul>
 
65
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 
66
<div class="textblock"><p>The <a class="el" href="a00410.html" title="The StreamTubeServer::Tube class represents a tube being handled by the server.">StreamTubeServer::Tube</a> class represents a tube being handled by the server. </p>
 
67
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
68
<a class="anchor" id="a6529318397d861649902642ae4711b77"></a><!-- doxytag: member="Tp::StreamTubeServer::Tube::Tube" ref="a6529318397d861649902642ae4711b77" args="()" -->
 
69
<div class="memitem">
 
70
<div class="memproto">
 
71
      <table class="memname">
 
72
        <tr>
 
73
          <td class="memname"><a class="el" href="a00410.html#a6529318397d861649902642ae4711b77">Tp::StreamTubeServer::Tube::Tube</a> </td>
 
74
          <td>(</td>
 
75
          <td class="paramname"></td><td>)</td>
 
76
          <td></td>
 
77
        </tr>
 
78
      </table>
 
79
</div>
 
80
<div class="memdoc">
 
81
<p>Constructs a new invalid <a class="el" href="a00410.html" title="The StreamTubeServer::Tube class represents a tube being handled by the server.">Tube</a> instance. </p>
 
82
 
 
83
</div>
 
84
</div>
 
85
<a class="anchor" id="a7405a77abdebb5f0eeedeb73fb979652"></a><!-- doxytag: member="Tp::StreamTubeServer::Tube::Tube" ref="a7405a77abdebb5f0eeedeb73fb979652" args="(const AccountPtr &amp;account, const OutgoingStreamTubeChannelPtr &amp;channel)" -->
 
86
<div class="memitem">
 
87
<div class="memproto">
 
88
      <table class="memname">
 
89
        <tr>
 
90
          <td class="memname"><a class="el" href="a00410.html#a6529318397d861649902642ae4711b77">Tp::StreamTubeServer::Tube::Tube</a> </td>
 
91
          <td>(</td>
 
92
          <td class="paramtype">const AccountPtr &amp;&#160;</td>
 
93
          <td class="paramname"><em>account</em>, </td>
 
94
        </tr>
 
95
        <tr>
 
96
          <td class="paramkey"></td>
 
97
          <td></td>
 
98
          <td class="paramtype">const OutgoingStreamTubeChannelPtr &amp;&#160;</td>
 
99
          <td class="paramname"><em>channel</em>&#160;</td>
 
100
        </tr>
 
101
        <tr>
 
102
          <td></td>
 
103
          <td>)</td>
 
104
          <td></td><td></td>
 
105
        </tr>
 
106
      </table>
 
107
</div>
 
108
<div class="memdoc">
 
109
<p>Constructs a <a class="el" href="a00410.html" title="The StreamTubeServer::Tube class represents a tube being handled by the server.">Tube</a> instance for the given tube <em>channel</em> originating from the given <em>account</em>.</p>
 
110
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
111
  <table class="params">
 
112
    <tr><td class="paramname">account</td><td>A pointer to the account object. </td></tr>
 
113
    <tr><td class="paramname">channel</td><td>A pointer to the tube channel object. </td></tr>
 
114
  </table>
 
115
  </dd>
 
116
</dl>
 
117
 
 
118
</div>
 
119
</div>
 
120
<a class="anchor" id="a4582e0c1f763920a55241fb27d42e103"></a><!-- doxytag: member="Tp::StreamTubeServer::Tube::Tube" ref="a4582e0c1f763920a55241fb27d42e103" args="(const Tube &amp;other)" -->
 
121
<div class="memitem">
 
122
<div class="memproto">
 
123
      <table class="memname">
 
124
        <tr>
 
125
          <td class="memname"><a class="el" href="a00410.html#a6529318397d861649902642ae4711b77">Tp::StreamTubeServer::Tube::Tube</a> </td>
 
126
          <td>(</td>
 
127
          <td class="paramtype">const <a class="el" href="a00410.html">Tube</a> &amp;&#160;</td>
 
128
          <td class="paramname"><em>other</em></td><td>)</td>
 
129
          <td></td>
 
130
        </tr>
 
131
      </table>
 
132
</div>
 
133
<div class="memdoc">
 
134
<p>Copy constructor. </p>
 
135
 
 
136
</div>
 
137
</div>
 
138
<a class="anchor" id="a71568f91c500a4e551c4f7b75ad9f971"></a><!-- doxytag: member="Tp::StreamTubeServer::Tube::~Tube" ref="a71568f91c500a4e551c4f7b75ad9f971" args="()" -->
 
139
<div class="memitem">
 
140
<div class="memproto">
 
141
      <table class="memname">
 
142
        <tr>
 
143
          <td class="memname"><a class="el" href="a00410.html#a71568f91c500a4e551c4f7b75ad9f971">Tp::StreamTubeServer::Tube::~Tube</a> </td>
 
144
          <td>(</td>
 
145
          <td class="paramname"></td><td>)</td>
 
146
          <td></td>
 
147
        </tr>
 
148
      </table>
 
149
</div>
 
150
<div class="memdoc">
 
151
<p>Class destructor. </p>
 
152
 
 
153
</div>
 
154
</div>
 
155
<hr/><h2>Member Function Documentation</h2>
 
156
<a class="anchor" id="a63f048fc5177b4b652aaf8f83033c49d"></a><!-- doxytag: member="Tp::StreamTubeServer::Tube::isValid" ref="a63f048fc5177b4b652aaf8f83033c49d" args="() const " -->
 
157
<div class="memitem">
 
158
<div class="memproto">
 
159
      <table class="memname">
 
160
        <tr>
 
161
          <td class="memname">bool <a class="el" href="a00410.html#a63f048fc5177b4b652aaf8f83033c49d">Tp::StreamTubeServer::Tube::isValid</a> </td>
 
162
          <td>(</td>
 
163
          <td class="paramname"></td><td>)</td>
 
164
          <td> const<code> [inline]</code></td>
 
165
        </tr>
 
166
      </table>
 
167
</div>
 
168
<div class="memdoc">
 
169
<p>Return whether or not the tube is valid or is just the null object created using the default constructor.</p>
 
170
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if valid, <code>false</code> otherwise. </dd></dl>
 
171
 
 
172
</div>
 
173
</div>
 
174
<a class="anchor" id="a73282136752c854a99e67bbeac39bf8b"></a><!-- doxytag: member="Tp::StreamTubeServer::Tube::operator=" ref="a73282136752c854a99e67bbeac39bf8b" args="(const Tube &amp;other)" -->
 
175
<div class="memitem">
 
176
<div class="memproto">
 
177
      <table class="memname">
 
178
        <tr>
 
179
          <td class="memname"><a class="el" href="a00410.html">StreamTubeServer::Tube</a> &amp; Tp::StreamTubeServer::Tube::operator= </td>
 
180
          <td>(</td>
 
181
          <td class="paramtype">const <a class="el" href="a00410.html">Tube</a> &amp;&#160;</td>
 
182
          <td class="paramname"><em>other</em></td><td>)</td>
 
183
          <td></td>
 
184
        </tr>
 
185
      </table>
 
186
</div>
 
187
<div class="memdoc">
 
188
<p>Assignment operator. </p>
 
189
 
 
190
</div>
 
191
</div>
 
192
<a class="anchor" id="a12f8951e6ecd4162acf35404101df420"></a><!-- doxytag: member="Tp::StreamTubeServer::Tube::account" ref="a12f8951e6ecd4162acf35404101df420" args="() const " -->
 
193
<div class="memitem">
 
194
<div class="memproto">
 
195
      <table class="memname">
 
196
        <tr>
 
197
          <td class="memname">AccountPtr <a class="el" href="a00410.html#a12f8951e6ecd4162acf35404101df420">Tp::StreamTubeServer::Tube::account</a> </td>
 
198
          <td>(</td>
 
199
          <td class="paramname"></td><td>)</td>
 
200
          <td> const<code> [inline]</code></td>
 
201
        </tr>
 
202
      </table>
 
203
</div>
 
204
<div class="memdoc">
 
205
<p>Return the account from which the tube originates.</p>
 
206
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the account object. </dd></dl>
 
207
 
 
208
</div>
 
209
</div>
 
210
<a class="anchor" id="aa886319747f3b685f8ab9c9e9c13db4a"></a><!-- doxytag: member="Tp::StreamTubeServer::Tube::channel" ref="aa886319747f3b685f8ab9c9e9c13db4a" args="() const " -->
 
211
<div class="memitem">
 
212
<div class="memproto">
 
213
      <table class="memname">
 
214
        <tr>
 
215
          <td class="memname">OutgoingStreamTubeChannelPtr <a class="el" href="a00410.html#aa886319747f3b685f8ab9c9e9c13db4a">Tp::StreamTubeServer::Tube::channel</a> </td>
 
216
          <td>(</td>
 
217
          <td class="paramname"></td><td>)</td>
 
218
          <td> const<code> [inline]</code></td>
 
219
        </tr>
 
220
      </table>
 
221
</div>
 
222
<div class="memdoc">
 
223
<p>Return the actual tube channel.</p>
 
224
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the channel. </dd></dl>
 
225
 
 
226
</div>
 
227
</div>
 
228
</div><!-- contents -->
 
229
<p /><address><hr /><div align="center">
 
230
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
231
<td width="30%">Copyright &copy; 2008-2011 Collabora Ltd. and Nokia Corporation</td>
 
232
<td width="30%" align="right"><div align="right">Telepathy-Qt 0.9.3</div></td>
 
233
</tr></table></div></address>
 
234
</body>
 
235
</html>