~ubuntu-branches/ubuntu/karmic/empathy/karmic

« back to all changes in this revision

Viewing changes to doc/libempathy/html/EmpathyFilter.html

  • Committer: Bazaar Package Importer
  • Author(s): Laurent Bigonville
  • Date: 2007-12-04 00:00:31 UTC
  • mto: (6.4.1 sid) (1.3.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 18.
  • Revision ID: james.westby@ubuntu.com-20071204000031-w2os396zoqdbcybt
Tags: upstream-0.21.3
ImportĀ upstreamĀ versionĀ 0.21.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
 
<title>EmpathyFilter</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="libempathy Reference Manual">
8
 
<link rel="up" href="ch01.html" title="libempathy API reference">
9
 
<link rel="prev" href="EmpathyLogManager.html" title="EmpathyLogManager">
10
 
<link rel="next" href="EmpathyChandler.html" title="EmpathyChandler">
11
 
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="ch01.html" title="libempathy API reference">
14
 
</head>
15
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
 
<tr valign="middle">
18
 
<td><a accesskey="p" href="EmpathyLogManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
 
<th width="100%" align="center">libempathy Reference Manual</th>
22
 
<td><a accesskey="n" href="EmpathyChandler.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
 
</tr>
24
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id377761" class="shortcut">Top</a>
25
 
                  &#160;|&#160;
26
 
                  <a href="#id393819" class="shortcut">Description</a>
27
 
                  &#160;|&#160;
28
 
                  <a href="#id395567" class="shortcut">Object Hierarchy</a>
29
 
                  &#160;|&#160;
30
 
                  <a href="#id393790" class="shortcut">Signals</a></nobr></td></tr>
31
 
</table>
32
 
<div class="refentry" lang="en">
33
 
<a name="EmpathyFilter"></a><div class="titlepage"></div>
34
 
<div class="refnamediv"><table width="100%"><tr>
35
 
<td valign="top">
36
 
<h2>
37
 
<a name="id377761"></a><span class="refentrytitle">EmpathyFilter</span>
38
 
</h2>
39
 
<p>EmpathyFilter</p>
40
 
</td>
41
 
<td valign="top" align="right"></td>
42
 
</tr></table></div>
43
 
<div class="refsynopsisdiv">
44
 
<h2>Synopsis</h2>
45
 
<pre class="synopsis">
46
 
 
47
 
 
48
 
 
49
 
                    <a class="link" href="EmpathyFilter.html#EmpathyFilterPriv">EmpathyFilterPriv</a>;
50
 
                    <a class="link" href="EmpathyFilter.html#EmpathyFilter-struct">EmpathyFilter</a>;
51
 
<a class="link" href="EmpathyFilter.html" title="EmpathyFilter">EmpathyFilter</a>*      <a class="link" href="EmpathyFilter.html#empathy-filter-new">empathy_filter_new</a>                  (const gchar *bus_name,
52
 
                                                         const gchar *object_path,
53
 
                                                         const gchar *channel_type,
54
 
                                                         guint priority,
55
 
                                                         guint flags);
56
 
void                <a class="link" href="EmpathyFilter.html#empathy-filter-process">empathy_filter_process</a>              (<a class="link" href="EmpathyFilter.html" title="EmpathyFilter">EmpathyFilter</a> *filter,
57
 
                                                         TpChan *tp_chan,
58
 
                                                         gboolean process);
59
 
 
60
 
</pre>
61
 
</div>
62
 
<div class="refsect1" lang="en">
63
 
<a name="id395567"></a><h2>Object Hierarchy</h2>
64
 
<pre class="synopsis">
65
 
 
66
 
  GObject
67
 
   +----EmpathyFilter
68
 
</pre>
69
 
</div>
70
 
<div class="refsect1" lang="en">
71
 
<a name="id393790"></a><h2>Signals</h2>
72
 
<pre class="synopsis">
73
 
 
74
 
  "<a class="link" href="EmpathyFilter.html#EmpathyFilter-new-channel">new-channel</a>"                                    : Run Last
75
 
  "<a class="link" href="EmpathyFilter.html#EmpathyFilter-process">process</a>"                                        : Run Last
76
 
</pre>
77
 
</div>
78
 
<div class="refsect1" lang="en">
79
 
<a name="id393819"></a><h2>Description</h2>
80
 
<p>
81
 
 
82
 
</p>
83
 
</div>
84
 
<div class="refsect1" lang="en">
85
 
<a name="id393835"></a><h2>Details</h2>
86
 
<div class="refsect2" lang="en">
87
 
<a name="id393846"></a><h3>
88
 
<a name="EmpathyFilterPriv"></a>EmpathyFilterPriv</h3>
89
 
<a class="indexterm" name="id393858"></a><pre class="programlisting">typedef struct _EmpathyFilterPriv EmpathyFilterPriv;</pre>
90
 
<p>
91
 
 
92
 
</p>
93
 
</div>
94
 
<hr>
95
 
<div class="refsect2" lang="en">
96
 
<a name="id395752"></a><h3>
97
 
<a name="EmpathyFilter-struct"></a>EmpathyFilter</h3>
98
 
<a class="indexterm" name="id395764"></a><pre class="programlisting">typedef struct _EmpathyFilter EmpathyFilter;</pre>
99
 
<p>
100
 
 
101
 
</p>
102
 
</div>
103
 
<hr>
104
 
<div class="refsect2" lang="en">
105
 
<a name="id395779"></a><h3>
106
 
<a name="empathy-filter-new"></a>empathy_filter_new ()</h3>
107
 
<a class="indexterm" name="id395791"></a><pre class="programlisting"><a class="link" href="EmpathyFilter.html" title="EmpathyFilter">EmpathyFilter</a>*      empathy_filter_new                  (const gchar *bus_name,
108
 
                                                         const gchar *object_path,
109
 
                                                         const gchar *channel_type,
110
 
                                                         guint priority,
111
 
                                                         guint flags);</pre>
112
 
<p>
113
 
 
114
 
</p>
115
 
<div class="variablelist"><table border="0">
116
 
<col align="left" valign="top">
117
 
<tbody>
118
 
<tr>
119
 
<td><p><span class="term"><em class="parameter"><code>bus_name</code></em>&#160;:</span></p></td>
120
 
<td>
121
 
</td>
122
 
</tr>
123
 
<tr>
124
 
<td><p><span class="term"><em class="parameter"><code>object_path</code></em>&#160;:</span></p></td>
125
 
<td>
126
 
</td>
127
 
</tr>
128
 
<tr>
129
 
<td><p><span class="term"><em class="parameter"><code>channel_type</code></em>&#160;:</span></p></td>
130
 
<td>
131
 
</td>
132
 
</tr>
133
 
<tr>
134
 
<td><p><span class="term"><em class="parameter"><code>priority</code></em>&#160;:</span></p></td>
135
 
<td>
136
 
</td>
137
 
</tr>
138
 
<tr>
139
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></p></td>
140
 
<td>
141
 
</td>
142
 
</tr>
143
 
<tr>
144
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
145
 
<td>
146
 
 
147
 
 
148
 
</td>
149
 
</tr>
150
 
</tbody>
151
 
</table></div>
152
 
</div>
153
 
<hr>
154
 
<div class="refsect2" lang="en">
155
 
<a name="id385183"></a><h3>
156
 
<a name="empathy-filter-process"></a>empathy_filter_process ()</h3>
157
 
<a class="indexterm" name="id385194"></a><pre class="programlisting">void                empathy_filter_process              (<a class="link" href="EmpathyFilter.html" title="EmpathyFilter">EmpathyFilter</a> *filter,
158
 
                                                         TpChan *tp_chan,
159
 
                                                         gboolean process);</pre>
160
 
<p>
161
 
 
162
 
</p>
163
 
<div class="variablelist"><table border="0">
164
 
<col align="left" valign="top">
165
 
<tbody>
166
 
<tr>
167
 
<td><p><span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></p></td>
168
 
<td>
169
 
</td>
170
 
</tr>
171
 
<tr>
172
 
<td><p><span class="term"><em class="parameter"><code>tp_chan</code></em>&#160;:</span></p></td>
173
 
<td>
174
 
</td>
175
 
</tr>
176
 
<tr>
177
 
<td><p><span class="term"><em class="parameter"><code>process</code></em>&#160;:</span></p></td>
178
 
<td>
179
 
 
180
 
 
181
 
</td>
182
 
</tr>
183
 
</tbody>
184
 
</table></div>
185
 
</div>
186
 
</div>
187
 
<div class="refsect1" lang="en">
188
 
<a name="id385281"></a><h2>Signal Details</h2>
189
 
<div class="refsect2" lang="en">
190
 
<a name="id385291"></a><h3>
191
 
<a name="EmpathyFilter-new-channel"></a>The <code class="literal">"new-channel"</code> signal</h3>
192
 
<a class="indexterm" name="id400607"></a><pre class="programlisting">void                user_function                      (<a class="link" href="EmpathyFilter.html" title="EmpathyFilter">EmpathyFilter</a> *empathyfilter,
193
 
                                                        TpConn        *arg1,
194
 
                                                        TpChan        *arg2,
195
 
                                                        gpointer       user_data)          : Run Last</pre>
196
 
<p>
197
 
 
198
 
</p>
199
 
<div class="variablelist"><table border="0">
200
 
<col align="left" valign="top">
201
 
<tbody>
202
 
<tr>
203
 
<td><p><span class="term"><em class="parameter"><code>empathyfilter</code></em>&#160;:</span></p></td>
204
 
<td>the object which received the signal.
205
 
</td>
206
 
</tr>
207
 
<tr>
208
 
<td><p><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></p></td>
209
 
<td>
210
 
</td>
211
 
</tr>
212
 
<tr>
213
 
<td><p><span class="term"><em class="parameter"><code>arg2</code></em>&#160;:</span></p></td>
214
 
<td>
215
 
 
216
 
</td>
217
 
</tr>
218
 
<tr>
219
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
220
 
<td>user data set when the signal handler was connected.</td>
221
 
</tr>
222
 
</tbody>
223
 
</table></div>
224
 
</div>
225
 
<hr>
226
 
<div class="refsect2" lang="en">
227
 
<a name="id400710"></a><h3>
228
 
<a name="EmpathyFilter-process"></a>The <code class="literal">"process"</code> signal</h3>
229
 
<a class="indexterm" name="id400725"></a><pre class="programlisting">void                user_function                      (<a class="link" href="EmpathyFilter.html" title="EmpathyFilter">EmpathyFilter</a> *empathyfilter,
230
 
                                                        guint          arg1,
231
 
                                                        gboolean       arg2,
232
 
                                                        gpointer       user_data)          : Run Last</pre>
233
 
<p>
234
 
 
235
 
</p>
236
 
<div class="variablelist"><table border="0">
237
 
<col align="left" valign="top">
238
 
<tbody>
239
 
<tr>
240
 
<td><p><span class="term"><em class="parameter"><code>empathyfilter</code></em>&#160;:</span></p></td>
241
 
<td>the object which received the signal.
242
 
</td>
243
 
</tr>
244
 
<tr>
245
 
<td><p><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></p></td>
246
 
<td>
247
 
</td>
248
 
</tr>
249
 
<tr>
250
 
<td><p><span class="term"><em class="parameter"><code>arg2</code></em>&#160;:</span></p></td>
251
 
<td>
252
 
 
253
 
</td>
254
 
</tr>
255
 
<tr>
256
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
257
 
<td>user data set when the signal handler was connected.</td>
258
 
</tr>
259
 
</tbody>
260
 
</table></div>
261
 
</div>
262
 
</div>
263
 
<div class="refsect1" lang="en">
264
 
<a name="id400832"></a><div class="refsect2" lang="en"><a name="id400833"></a></div>
265
 
<hr>
266
 
<div class="refsect2" lang="en"><a name="id400834"></a></div>
267
 
</div>
268
 
</div>
269
 
</body>
270
 
</html>