← Back to branch summary

~ubuntu-branches/ubuntu/natty/empathy/natty-updates

« back to all changes in this revision

Viewing changes to docs/libempathy/html/EmpathyIrcNetwork.html

  • Committer: Bazaar Package Importer
  • Author(s): Sjoerd Simons
  • Date: 2008-03-10 16:39:07 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20080310163907-tv41g2zmf0qqgi85
Tags: 0.22.0-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libempathy/html/EmpathyIrcNetwork.html
 
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>EmpathyIrcNetwork</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="libempathy_api.html" title="libempathy API reference">
 
9
<link rel="prev" href="EmpathyIrcServer.html" title="EmpathyIrcServer">
 
10
<link rel="next" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">
 
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;libempathy Overview">
 
14
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;API Reference">
 
15
<link rel="chapter" href="libempathy_api.html" title="libempathy API reference">
 
16
<link rel="chapter" href="libempathy-hierarchy.html" title="Object Hierarchy">
 
17
<link rel="index" href="ix01.html" title="Index">
 
18
</head>
 
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
20
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
21
<tr valign="middle">
 
22
<td><a accesskey="p" href="EmpathyIrcServer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
23
<td><a accesskey="u" href="libempathy_api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
24
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
25
<th width="100%" align="center">libempathy Reference Manual</th>
 
26
<td><a accesskey="n" href="EmpathyIrcNetworkManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
27
</tr>
 
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id344954" class="shortcut">Top</a>
 
29
                  &#160;|&#160;
 
30
                  <a href="#id377469" class="shortcut">Description</a>
 
31
                  &#160;|&#160;
 
32
                  <a href="#id346095" class="shortcut">Object Hierarchy</a>
 
33
                  &#160;|&#160;
 
34
                  <a href="#id371852" class="shortcut">Properties</a>
 
35
                  &#160;|&#160;
 
36
                  <a href="#id371894" class="shortcut">Signals</a></nobr></td></tr>
 
37
</table>
 
38
<div class="refentry" lang="en">
 
39
<a name="EmpathyIrcNetwork"></a><div class="titlepage"></div>
 
40
<div class="refnamediv"><table width="100%"><tr>
 
41
<td valign="top">
 
42
<h2>
 
43
<a name="id344954"></a><span class="refentrytitle">EmpathyIrcNetwork</span>
 
44
</h2>
 
45
<p>EmpathyIrcNetwork</p>
 
46
</td>
 
47
<td valign="top" align="right"></td>
 
48
</tr></table></div>
 
49
<div class="refsynopsisdiv">
 
50
<h2>Synopsis</h2>
 
51
<pre class="synopsis">
 
52
 
 
53
 
 
54
 
 
55
                    <a class="link" href="EmpathyIrcNetwork.html#EmpathyIrcNetwork-struct">EmpathyIrcNetwork</a>;
 
56
<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a>*  <a class="link" href="EmpathyIrcNetwork.html#empathy-irc-network-new">empathy_irc_network_new</a>             (const gchar *name);
 
57
GSList*             <a class="link" href="EmpathyIrcNetwork.html#empathy-irc-network-get-servers">empathy_irc_network_get_servers</a>     (<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);
 
58
void                <a class="link" href="EmpathyIrcNetwork.html#empathy-irc-network-append-server">empathy_irc_network_append_server</a>   (<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network,
 
59
                                                         <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer">EmpathyIrcServer</a> *server);
 
60
void                <a class="link" href="EmpathyIrcNetwork.html#empathy-irc-network-remove-server">empathy_irc_network_remove_server</a>   (<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network,
 
61
                                                         <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer">EmpathyIrcServer</a> *server);
 
62
void                <a class="link" href="EmpathyIrcNetwork.html#empathy-irc-network-set-server-position">empathy_irc_network_set_server_position</a>
 
63
                                                        (<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network,
 
64
                                                         <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer">EmpathyIrcServer</a> *server,
 
65
                                                         gint pos);
 
66
 
 
67
</pre>
 
68
</div>
 
69
<div class="refsect1" lang="en">
 
70
<a name="id346095"></a><h2>Object Hierarchy</h2>
 
71
<pre class="synopsis">
 
72
 
 
73
  GObject
 
74
   +----EmpathyIrcNetwork
 
75
</pre>
 
76
</div>
 
77
<div class="refsect1" lang="en">
 
78
<a name="id371852"></a><h2>Properties</h2>
 
79
<pre class="synopsis">
 
80
 
 
81
  "<a class="link" href="EmpathyIrcNetwork.html#EmpathyIrcNetwork--charset">charset</a>"                  gchararray            : Read / Write / Construct
 
82
  "<a class="link" href="EmpathyIrcNetwork.html#EmpathyIrcNetwork--name">name</a>"                     gchararray            : Read / Write
 
83
</pre>
 
84
</div>
 
85
<div class="refsect1" lang="en">
 
86
<a name="id371894"></a><h2>Signals</h2>
 
87
<pre class="synopsis">
 
88
 
 
89
  "<a class="link" href="EmpathyIrcNetwork.html#EmpathyIrcNetwork-modified">modified</a>"                                       : Run Last / Has Details
 
90
</pre>
 
91
</div>
 
92
<div class="refsect1" lang="en">
 
93
<a name="id377469"></a><h2>Description</h2>
 
94
<p>
 
95
 
 
96
</p>
 
97
</div>
 
98
<div class="refsect1" lang="en">
 
99
<a name="id377485"></a><h2>Details</h2>
 
100
<div class="refsect2" lang="en">
 
101
<a name="id377496"></a><h3>
 
102
<a name="EmpathyIrcNetwork-struct"></a>EmpathyIrcNetwork</h3>
 
103
<a class="indexterm" name="id377508"></a><pre class="programlisting">typedef struct _EmpathyIrcNetwork EmpathyIrcNetwork;</pre>
 
104
<p>
 
105
 
 
106
</p>
 
107
</div>
 
108
<hr>
 
109
<div class="refsect2" lang="en">
 
110
<a name="id377523"></a><h3>
 
111
<a name="empathy-irc-network-new"></a>empathy_irc_network_new ()</h3>
 
112
<a class="indexterm" name="id377535"></a><pre class="programlisting"><a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a>*  empathy_irc_network_new             (const gchar *name);</pre>
 
113
<p>
 
114
Creates a new <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>.</p>
 
115
<p>
 
116
 
 
117
</p>
 
118
<div class="variablelist"><table border="0">
 
119
<col align="left" valign="top">
 
120
<tbody>
 
121
<tr>
 
122
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
 
123
<td> the name of the network
 
124
</td>
 
125
</tr>
 
126
<tr>
 
127
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
128
<td> a new <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>
 
129
</td>
 
130
</tr>
 
131
</tbody>
 
132
</table></div>
 
133
</div>
 
134
<hr>
 
135
<div class="refsect2" lang="en">
 
136
<a name="id392389"></a><h3>
 
137
<a name="empathy-irc-network-get-servers"></a>empathy_irc_network_get_servers ()</h3>
 
138
<a class="indexterm" name="id392401"></a><pre class="programlisting">GSList*             empathy_irc_network_get_servers     (<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);</pre>
 
139
<p>
 
140
Get the list of <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a> that belongs to this network.
 
141
These servers are sorted according their priority.
 
142
So the first one will be the first used when trying to connect to
 
143
the network.</p>
 
144
<p>
 
145
 
 
146
</p>
 
147
<div class="variablelist"><table border="0">
 
148
<col align="left" valign="top">
 
149
<tbody>
 
150
<tr>
 
151
<td><p><span class="term"><em class="parameter"><code>network</code></em>&#160;:</span></p></td>
 
152
<td> an <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>
 
153
</td>
 
154
</tr>
 
155
<tr>
 
156
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
157
<td> a new <span class="type">GSList</span> of refed <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a>.
 
158
</td>
 
159
</tr>
 
160
</tbody>
 
161
</table></div>
 
162
</div>
 
163
<hr>
 
164
<div class="refsect2" lang="en">
 
165
<a name="id392490"></a><h3>
 
166
<a name="empathy-irc-network-append-server"></a>empathy_irc_network_append_server ()</h3>
 
167
<a class="indexterm" name="id392502"></a><pre class="programlisting">void                empathy_irc_network_append_server   (<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network,
 
168
                                                         <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer">EmpathyIrcServer</a> *server);</pre>
 
169
<p>
 
170
Add an <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a> to the given <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>. The server
 
171
is added at the last position in network's servers list.</p>
 
172
<p>
 
173
 
 
174
</p>
 
175
<div class="variablelist"><table border="0">
 
176
<col align="left" valign="top">
 
177
<tbody>
 
178
<tr>
 
179
<td><p><span class="term"><em class="parameter"><code>network</code></em>&#160;:</span></p></td>
 
180
<td> an <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>
 
181
</td>
 
182
</tr>
 
183
<tr>
 
184
<td><p><span class="term"><em class="parameter"><code>server</code></em>&#160;:</span></p></td>
 
185
<td> the <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a> to add
 
186
</td>
 
187
</tr>
 
188
</tbody>
 
189
</table></div>
 
190
</div>
 
191
<hr>
 
192
<div class="refsect2" lang="en">
 
193
<a name="id392599"></a><h3>
 
194
<a name="empathy-irc-network-remove-server"></a>empathy_irc_network_remove_server ()</h3>
 
195
<a class="indexterm" name="id392612"></a><pre class="programlisting">void                empathy_irc_network_remove_server   (<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network,
 
196
                                                         <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer">EmpathyIrcServer</a> *server);</pre>
 
197
<p>
 
198
Remove an <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a> from the servers list of the
 
199
given <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>.</p>
 
200
<p>
 
201
 
 
202
</p>
 
203
<div class="variablelist"><table border="0">
 
204
<col align="left" valign="top">
 
205
<tbody>
 
206
<tr>
 
207
<td><p><span class="term"><em class="parameter"><code>network</code></em>&#160;:</span></p></td>
 
208
<td> an <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>
 
209
</td>
 
210
</tr>
 
211
<tr>
 
212
<td><p><span class="term"><em class="parameter"><code>server</code></em>&#160;:</span></p></td>
 
213
<td> the <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a> to remove
 
214
</td>
 
215
</tr>
 
216
</tbody>
 
217
</table></div>
 
218
</div>
 
219
<hr>
 
220
<div class="refsect2" lang="en">
 
221
<a name="id392709"></a><h3>
 
222
<a name="empathy-irc-network-set-server-position"></a>empathy_irc_network_set_server_position ()</h3>
 
223
<a class="indexterm" name="id392721"></a><pre class="programlisting">void                empathy_irc_network_set_server_position
 
224
                                                        (<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network,
 
225
                                                         <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer">EmpathyIrcServer</a> *server,
 
226
                                                         gint pos);</pre>
 
227
<p>
 
228
Move an <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a> in the servers list of the given
 
229
<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>.</p>
 
230
<p>
 
231
 
 
232
</p>
 
233
<div class="variablelist"><table border="0">
 
234
<col align="left" valign="top">
 
235
<tbody>
 
236
<tr>
 
237
<td><p><span class="term"><em class="parameter"><code>network</code></em>&#160;:</span></p></td>
 
238
<td> an <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>
 
239
</td>
 
240
</tr>
 
241
<tr>
 
242
<td><p><span class="term"><em class="parameter"><code>server</code></em>&#160;:</span></p></td>
 
243
<td> the <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a> to move
 
244
</td>
 
245
</tr>
 
246
<tr>
 
247
<td><p><span class="term"><em class="parameter"><code>pos</code></em>&#160;:</span></p></td>
 
248
<td> the position to move the server. If this is negative, or is larger than
 
249
the number of servers in the list, the server is moved to the end of the
 
250
list.
 
251
</td>
 
252
</tr>
 
253
</tbody>
 
254
</table></div>
 
255
</div>
 
256
</div>
 
257
<div class="refsect1" lang="en">
 
258
<a name="id392841"></a><h2>Property Details</h2>
 
259
<div class="refsect2" lang="en">
 
260
<a name="id392852"></a><h3>
 
261
<a name="EmpathyIrcNetwork--charset"></a>The <code class="literal">"charset"</code> property</h3>
 
262
<a class="indexterm" name="id392867"></a><pre class="programlisting">  "charset"                  gchararray            : Read / Write / Construct</pre>
 
263
<p>The charset to use on this network.</p>
 
264
<p>Default value: "UTF-8"</p>
 
265
</div>
 
266
<hr>
 
267
<div class="refsect2" lang="en">
 
268
<a name="id392892"></a><h3>
 
269
<a name="EmpathyIrcNetwork--name"></a>The <code class="literal">"name"</code> property</h3>
 
270
<a class="indexterm" name="id392907"></a><pre class="programlisting">  "name"                     gchararray            : Read / Write</pre>
 
271
<p>The displayed name of this network.</p>
 
272
<p>Default value: NULL</p>
 
273
</div>
 
274
</div>
 
275
<div class="refsect1" lang="en">
 
276
<a name="id392934"></a><h2>Signal Details</h2>
 
277
<div class="refsect2" lang="en">
 
278
<a name="id392944"></a><h3>
 
279
<a name="EmpathyIrcNetwork-modified"></a>The <code class="literal">"modified"</code> signal</h3>
 
280
<a class="indexterm" name="id392959"></a><pre class="programlisting">void                user_function                      (<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network,
 
281
                                                        gpointer           user_data)      : Run Last / Has Details</pre>
 
282
<p>
 
283
Emitted when either a property or a server of the network is modified.</p>
 
284
<p>
 
285
 
 
286
</p>
 
287
<div class="variablelist"><table border="0">
 
288
<col align="left" valign="top">
 
289
<tbody>
 
290
<tr>
 
291
<td><p><span class="term"><em class="parameter"><code>network</code></em>&#160;:</span></p></td>
 
292
<td> the object that received the signal
 
293
</td>
 
294
</tr>
 
295
<tr>
 
296
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
 
297
<td>user data set when the signal handler was connected.</td>
 
298
</tr>
 
299
</tbody>
 
300
</table></div>
 
301
</div>
 
302
</div>
 
303
<div class="refsect1" lang="en">
 
304
<a name="id393028"></a><div class="refsect2" lang="en"><a name="id393029"></a></div>
 
305
<hr>
 
306
<div class="refsect2" lang="en"><a name="id393030"></a></div>
 
307
</div>
 
308
</div>
 
309
</body>
 
310
</html>