← Back to branch summary

~ubuntu-branches/ubuntu/maverick/telepathy-glib/maverick

« back to all changes in this revision

Viewing changes to docs/reference/html/TpExportableChannel.html

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2010-05-10 17:59:54 UTC
  • mfrom: (1.6.1 upstream) (27.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20100510175954-bxvqq3xx0sy4itmp
Tags: 0.11.5-1
New upstream version with new API/ABI

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/TpExportableChannel.html
8
8
<link rel="up" href="ch-service-base.html" title="Service-side implementation">
9
9
<link rel="prev" href="telepathy-glib-dbus-properties-mixin.html" title="TpDBusPropertiesMixin">
10
10
<link rel="next" href="telepathy-glib-TpPresenceMixin.html" title="TpPresenceMixin">
11
 
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="ch-dbus.html" title="General D-Bus support">
14
 
<link rel="chapter" href="ch-protocol.html" title="The Telepathy protocol">
15
 
<link rel="chapter" href="ch-client.html" title="Client-side proxies">
16
 
<link rel="chapter" href="ch-service-dbus.html" title="Service-side D-Bus interfaces">
17
 
<link rel="chapter" href="ch-service-base.html" title="Service-side implementation">
18
 
<link rel="chapter" href="ch-service-handles.html" title="Service-side handle repositories">
19
 
<link rel="chapter" href="ch-utilities.html" title="Utilities">
20
13
</head>
21
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
22
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
54
47
<pre class="synopsis">
55
48
#include &lt;telepathy-glib/exportable-channel.h&gt;
56
49
 
57
 
<span class="returnvalue">void</span>                (<a class="link" href="TpExportableChannel.html#TpExportableChannelFunc" title="TpExportableChannelFunc ()">*TpExportableChannelFunc</a>)          (<a class="link" href="TpExportableChannel.html" title="TpExportableChannel"><span class="returnvalue">TpExportableChannel</span></a> *channel,
58
 
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> user_data);
 
50
<span class="returnvalue">void</span>                (<a class="link" href="TpExportableChannel.html#TpExportableChannelFunc" title="TpExportableChannelFunc ()">*TpExportableChannelFunc</a>)          (<em class="parameter"><code><a class="link" href="TpExportableChannel.html" title="TpExportableChannel"><span class="type">TpExportableChannel</span></a> *channel</code></em>,
 
51
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
59
52
                    <a class="link" href="TpExportableChannel.html#TpExportableChannel-struct" title="TpExportableChannel">TpExportableChannel</a>;
60
53
                    <a class="link" href="TpExportableChannel.html#TpExportableChannelIface" title="TpExportableChannelIface">TpExportableChannelIface</a>;
61
54
</pre>
76
69
<div class="refsect1" title="Properties">
77
70
<a name="TpExportableChannel.properties"></a><h2>Properties</h2>
78
71
<pre class="synopsis">
79
 
  "<a class="link" href="TpExportableChannel.html#TpExportableChannel--channel-destroyed" title='The "channel-destroyed" property'>channel-destroyed</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
 
72
  "<a class="link" href="TpExportableChannel.html#TpExportableChannel--channel-destroyed" title='The "channel-destroyed" property'>channel-destroyed</a>"        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
80
73
  "<a class="link" href="TpExportableChannel.html#TpExportableChannel--channel-properties" title='The "channel-properties" property'>channel-properties</a>"       <span class="type">GHashTable_gchararray+GValue_*</span>  : Read
81
 
  "<a class="link" href="TpExportableChannel.html#TpExportableChannel--object-path" title='The "object-path" property'>object-path</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
74
  "<a class="link" href="TpExportableChannel.html#TpExportableChannel--object-path" title='The "object-path" property'>object-path</a>"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
82
75
</pre>
83
76
</div>
84
77
<div class="refsect1" title="Description">
86
79
<p>
87
80
This interface defines a set of channel properties on top of those of
88
81
<a class="link" href="TpChannelIface.html" title="TpChannelIface"><span class="type">TpChannelIface</span></a>. It's mainly used by <a class="link" href="TpChannelManager.html" title="TpChannelManager"><span class="type">TpChannelManager</span></a> to represent the
89
 
returned and managed channel objects.</p>
 
82
returned and managed channel objects.
 
83
</p>
90
84
</div>
91
85
<div class="refsect1" title="Details">
92
86
<a name="TpExportableChannel.details"></a><h2>Details</h2>
93
87
<div class="refsect2" title="TpExportableChannelFunc ()">
94
88
<a name="TpExportableChannelFunc"></a><h3>TpExportableChannelFunc ()</h3>
95
 
<pre class="programlisting"><span class="returnvalue">void</span>                (*TpExportableChannelFunc)          (<a class="link" href="TpExportableChannel.html" title="TpExportableChannel"><span class="returnvalue">TpExportableChannel</span></a> *channel,
96
 
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> user_data);</pre>
 
89
<pre class="programlisting"><span class="returnvalue">void</span>                (*TpExportableChannelFunc)          (<em class="parameter"><code><a class="link" href="TpExportableChannel.html" title="TpExportableChannel"><span class="type">TpExportableChannel</span></a> *channel</code></em>,
 
90
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
97
91
<p>
98
 
A callback for functions which act on exportable channels.</p>
 
92
A callback for functions which act on exportable channels.
 
93
</p>
99
94
<div class="variablelist"><table border="0">
100
95
<col align="left" valign="top">
101
96
<tbody>
102
97
<tr>
103
98
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
104
 
<td> An object implementing the exportable channel interface
 
99
<td>An object implementing the exportable channel interface
105
100
</td>
106
101
</tr>
107
102
<tr>
108
103
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
109
 
<td> Arbitrary user-supplied data
 
104
<td>Arbitrary user-supplied data
110
105
</td>
111
106
</tr>
112
107
</tbody>
117
112
<a name="TpExportableChannel-struct"></a><h3>TpExportableChannel</h3>
118
113
<pre class="programlisting">typedef struct _TpExportableChannel TpExportableChannel;</pre>
119
114
<p>
120
 
Opaque typedef representing a channel with several standard properties.</p>
 
115
Opaque typedef representing a channel with several standard properties.
 
116
</p>
121
117
</div>
122
118
<hr>
123
119
<div class="refsect2" title="TpExportableChannelIface">
127
123
} TpExportableChannelIface;
128
124
</pre>
129
125
<p>
130
 
The interface for <a class="link" href="TpExportableChannel.html" title="TpExportableChannel"><span class="type">TpExportableChannel</span></a> objects.</p>
 
126
The interface for <a class="link" href="TpExportableChannel.html" title="TpExportableChannel"><span class="type">TpExportableChannel</span></a> objects.
 
127
</p>
131
128
<div class="variablelist"><table border="0">
132
129
<col align="left" valign="top">
133
130
<tbody><tr>
134
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="TpExportableChannelIface.parent"></a>parent</code></em>;</span></p></td>
135
 
<td> The parent interface
 
131
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="TpExportableChannelIface.parent"></a>parent</code></em>;</span></p></td>
 
132
<td>The parent interface
136
133
</td>
137
134
</tr></tbody>
138
135
</table></div>
142
139
<a name="TpExportableChannel.property-details"></a><h2>Property Details</h2>
143
140
<div class="refsect2" title='The "channel-destroyed" property'>
144
141
<a name="TpExportableChannel--channel-destroyed"></a><h3>The <code class="literal">"channel-destroyed"</code> property</h3>
145
 
<pre class="programlisting">  "channel-destroyed"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
 
142
<pre class="programlisting">  "channel-destroyed"        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
146
143
<p>
147
144
If true, the closed signal on the Channel interface indicates that
148
145
the channel can go away.
151
148
If false, the closed signal indicates to the channel manager that the
152
149
channel should appear to go away and be re-created, by emitting Closed
153
150
followed by NewChannel. (This is to support the "respawning" of  Text
154
 
channels which are closed with unacknowledged messages.)</p>
 
151
channels which are closed with unacknowledged messages.)
 
152
</p>
155
153
<p>Default value: FALSE</p>
156
154
</div>
157
155
<hr>
203
201
18
204
202
19</pre></td>
205
203
        <td class="listing_code"><pre class="programlisting"><span class="keyword">case</span> PROP_CHANNEL_PROPERTIES<span class="symbol">:</span>
206
 
  <span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#g-value-take-boxed">g_value_take_boxed</a></span> <span class="symbol">(</span>value<span class="symbol">,</span>
 
204
  <span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#g-value-take-boxed">g_value_take_boxed</a></span> <span class="symbol">(</span>value<span class="symbol">,</span>
207
205
    <span class="function"><a href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-make-properties-hash">tp_dbus_properties_mixin_make_properties_hash</a></span> <span class="symbol">(</span>object<span class="symbol">,</span>
208
206
        <span class="gtkdoc slc">// The spec says these properties MUST be included:</span>
209
207
        TP_IFACE_CHANNEL<span class="symbol">,</span> <span class="string">&quot;TargetHandle&quot;</span><span class="symbol">,</span>
226
224
  </table>
227
225
</div>
228
226
 
 
227
<p>
 
228
</p>
229
229
</div>
230
230
<hr>
231
231
<div class="refsect2" title='The "object-path" property'>
232
232
<a name="TpExportableChannel--object-path"></a><h3>The <code class="literal">"object-path"</code> property</h3>
233
 
<pre class="programlisting">  "object-path"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
233
<pre class="programlisting">  "object-path"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
234
234
<p>
235
235
The D-Bus object path used for this object on the bus. Read-only
236
 
except during construction.</p>
 
236
except during construction.
 
237
</p>
237
238
<p>Default value: NULL</p>
238
239
</div>
239
240
</div>
244
245
</div>
245
246
<div class="footer">
246
247
<hr>
247
 
          Generated by GTK-Doc V1.13</div>
 
248
          Generated by GTK-Doc V1.14</div>
248
249
</body>
249
250
</html>
 
 
b'\\ No newline at end of file'