← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/libempathy/html/EmpathyIrcNetworkManager.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/EmpathyIrcNetworkManager.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>EmpathyIrcNetworkManager</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="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">
 
10
<link rel="next" href="EmpathyLogManager.html" title="EmpathyLogManager">
 
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="EmpathyIrcNetwork.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="EmpathyLogManager.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="#id365096" class="shortcut">Top</a>
 
29
                  &#160;|&#160;
 
30
                  <a href="#id353908" class="shortcut">Description</a>
 
31
                  &#160;|&#160;
 
32
                  <a href="#id384950" class="shortcut">Object Hierarchy</a>
 
33
                  &#160;|&#160;
 
34
                  <a href="#id353867" class="shortcut">Properties</a></nobr></td></tr>
 
35
</table>
 
36
<div class="refentry" lang="en">
 
37
<a name="EmpathyIrcNetworkManager"></a><div class="titlepage"></div>
 
38
<div class="refnamediv"><table width="100%"><tr>
 
39
<td valign="top">
 
40
<h2>
 
41
<a name="id365096"></a><span class="refentrytitle">EmpathyIrcNetworkManager</span>
 
42
</h2>
 
43
<p>EmpathyIrcNetworkManager</p>
 
44
</td>
 
45
<td valign="top" align="right"></td>
 
46
</tr></table></div>
 
47
<div class="refsynopsisdiv">
 
48
<h2>Synopsis</h2>
 
49
<pre class="synopsis">
 
50
 
 
51
 
 
52
 
 
53
                    <a class="link" href="EmpathyIrcNetworkManager.html#EmpathyIrcNetworkManager-struct">EmpathyIrcNetworkManager</a>;
 
54
<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a>* <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-new">empathy_irc_network_manager_new</a>
 
55
                                                        (const gchar *global_file,
 
56
                                                         const gchar *user_file);
 
57
void                <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-add">empathy_irc_network_manager_add</a>     (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
 
58
                                                         <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);
 
59
void                <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-remove">empathy_irc_network_manager_remove</a>  (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
 
60
                                                         <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);
 
61
GSList*             <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-get-networks">empathy_irc_network_manager_get_networks</a>
 
62
                                                        (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager);
 
63
<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a>*  <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-find-network-by-address">empathy_irc_network_manager_find_network_by_address</a>
 
64
                                                        (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
 
65
                                                         const gchar *address);
 
66
 
 
67
</pre>
 
68
</div>
 
69
<div class="refsect1" lang="en">
 
70
<a name="id384950"></a><h2>Object Hierarchy</h2>
 
71
<pre class="synopsis">
 
72
 
 
73
  GObject
 
74
   +----EmpathyIrcNetworkManager
 
75
</pre>
 
76
</div>
 
77
<div class="refsect1" lang="en">
 
78
<a name="id353867"></a><h2>Properties</h2>
 
79
<pre class="synopsis">
 
80
 
 
81
  "<a class="link" href="EmpathyIrcNetworkManager.html#EmpathyIrcNetworkManager--global-file">global-file</a>"              gchararray            : Read / Write / Construct Only
 
82
  "<a class="link" href="EmpathyIrcNetworkManager.html#EmpathyIrcNetworkManager--user-file">user-file</a>"                gchararray            : Read / Write / Construct Only
 
83
</pre>
 
84
</div>
 
85
<div class="refsect1" lang="en">
 
86
<a name="id353908"></a><h2>Description</h2>
 
87
<p>
 
88
 
 
89
</p>
 
90
</div>
 
91
<div class="refsect1" lang="en">
 
92
<a name="id353924"></a><h2>Details</h2>
 
93
<div class="refsect2" lang="en">
 
94
<a name="id384508"></a><h3>
 
95
<a name="EmpathyIrcNetworkManager-struct"></a>EmpathyIrcNetworkManager</h3>
 
96
<a class="indexterm" name="id384521"></a><pre class="programlisting">typedef struct _EmpathyIrcNetworkManager EmpathyIrcNetworkManager;</pre>
 
97
<p>
 
98
 
 
99
</p>
 
100
</div>
 
101
<hr>
 
102
<div class="refsect2" lang="en">
 
103
<a name="id384536"></a><h3>
 
104
<a name="empathy-irc-network-manager-new"></a>empathy_irc_network_manager_new ()</h3>
 
105
<a class="indexterm" name="id384548"></a><pre class="programlisting"><a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a>* empathy_irc_network_manager_new
 
106
                                                        (const gchar *global_file,
 
107
                                                         const gchar *user_file);</pre>
 
108
<p>
 
109
Creates a new <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a></p>
 
110
<p>
 
111
 
 
112
</p>
 
113
<div class="variablelist"><table border="0">
 
114
<col align="left" valign="top">
 
115
<tbody>
 
116
<tr>
 
117
<td><p><span class="term"><em class="parameter"><code>global_file</code></em>&#160;:</span></p></td>
 
118
<td> the path of the global networks file, or <code class="literal">NULL</code>
 
119
</td>
 
120
</tr>
 
121
<tr>
 
122
<td><p><span class="term"><em class="parameter"><code>user_file</code></em>&#160;:</span></p></td>
 
123
<td> the path of the user networks file, or <code class="literal">NULL</code>
 
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="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
 
129
</td>
 
130
</tr>
 
131
</tbody>
 
132
</table></div>
 
133
</div>
 
134
<hr>
 
135
<div class="refsect2" lang="en">
 
136
<a name="id393074"></a><h3>
 
137
<a name="empathy-irc-network-manager-add"></a>empathy_irc_network_manager_add ()</h3>
 
138
<a class="indexterm" name="id393087"></a><pre class="programlisting">void                empathy_irc_network_manager_add     (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
 
139
                                                         <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);</pre>
 
140
<p>
 
141
Add an <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a> to the given <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>.</p>
 
142
<p>
 
143
 
 
144
</p>
 
145
<div class="variablelist"><table border="0">
 
146
<col align="left" valign="top">
 
147
<tbody>
 
148
<tr>
 
149
<td><p><span class="term"><em class="parameter"><code>manager</code></em>&#160;:</span></p></td>
 
150
<td> an <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
 
151
</td>
 
152
</tr>
 
153
<tr>
 
154
<td><p><span class="term"><em class="parameter"><code>network</code></em>&#160;:</span></p></td>
 
155
<td> the <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a> to add
 
156
</td>
 
157
</tr>
 
158
</tbody>
 
159
</table></div>
 
160
</div>
 
161
<hr>
 
162
<div class="refsect2" lang="en">
 
163
<a name="id393184"></a><h3>
 
164
<a name="empathy-irc-network-manager-remove"></a>empathy_irc_network_manager_remove ()</h3>
 
165
<a class="indexterm" name="id393197"></a><pre class="programlisting">void                empathy_irc_network_manager_remove  (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
 
166
                                                         <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);</pre>
 
167
<p>
 
168
Remove an <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a> from the given <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>.</p>
 
169
<p>
 
170
 
 
171
</p>
 
172
<div class="variablelist"><table border="0">
 
173
<col align="left" valign="top">
 
174
<tbody>
 
175
<tr>
 
176
<td><p><span class="term"><em class="parameter"><code>manager</code></em>&#160;:</span></p></td>
 
177
<td> an <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
 
178
</td>
 
179
</tr>
 
180
<tr>
 
181
<td><p><span class="term"><em class="parameter"><code>network</code></em>&#160;:</span></p></td>
 
182
<td> the <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a> to remove
 
183
</td>
 
184
</tr>
 
185
</tbody>
 
186
</table></div>
 
187
</div>
 
188
<hr>
 
189
<div class="refsect2" lang="en">
 
190
<a name="id393294"></a><h3>
 
191
<a name="empathy-irc-network-manager-get-networks"></a>empathy_irc_network_manager_get_networks ()</h3>
 
192
<a class="indexterm" name="id393306"></a><pre class="programlisting">GSList*             empathy_irc_network_manager_get_networks
 
193
                                                        (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager);</pre>
 
194
<p>
 
195
Get the list of <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a> associated with the given
 
196
manager.</p>
 
197
<p>
 
198
 
 
199
</p>
 
200
<div class="variablelist"><table border="0">
 
201
<col align="left" valign="top">
 
202
<tbody>
 
203
<tr>
 
204
<td><p><span class="term"><em class="parameter"><code>manager</code></em>&#160;:</span></p></td>
 
205
<td> an <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
 
206
</td>
 
207
</tr>
 
208
<tr>
 
209
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
210
<td> a new <span class="type">GSList</span> of refed <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>
 
211
</td>
 
212
</tr>
 
213
</tbody>
 
214
</table></div>
 
215
</div>
 
216
<hr>
 
217
<div class="refsect2" lang="en">
 
218
<a name="id393395"></a><h3>
 
219
<a name="empathy-irc-network-manager-find-network-by-address"></a>empathy_irc_network_manager_find_network_by_address ()</h3>
 
220
<a class="indexterm" name="id393406"></a><pre class="programlisting"><a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a>*  empathy_irc_network_manager_find_network_by_address
 
221
                                                        (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
 
222
                                                         const gchar *address);</pre>
 
223
<p>
 
224
Find the <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a> which owns an <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a>
 
225
that has the given address.</p>
 
226
<p>
 
227
 
 
228
</p>
 
229
<div class="variablelist"><table border="0">
 
230
<col align="left" valign="top">
 
231
<tbody>
 
232
<tr>
 
233
<td><p><span class="term"><em class="parameter"><code>manager</code></em>&#160;:</span></p></td>
 
234
<td> an <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
 
235
</td>
 
236
</tr>
 
237
<tr>
 
238
<td><p><span class="term"><em class="parameter"><code>address</code></em>&#160;:</span></p></td>
 
239
<td> the server address to look for
 
240
</td>
 
241
</tr>
 
242
<tr>
 
243
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
244
<td> the found <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>, or <code class="literal">NULL</code> if not found.
 
245
</td>
 
246
</tr>
 
247
</tbody>
 
248
</table></div>
 
249
</div>
 
250
</div>
 
251
<div class="refsect1" lang="en">
 
252
<a name="id393526"></a><h2>Property Details</h2>
 
253
<div class="refsect2" lang="en">
 
254
<a name="id393537"></a><h3>
 
255
<a name="EmpathyIrcNetworkManager--global-file"></a>The <code class="literal">"global-file"</code> property</h3>
 
256
<a class="indexterm" name="id393552"></a><pre class="programlisting">  "global-file"              gchararray            : Read / Write / Construct Only</pre>
 
257
<p>The path of the system-wide filename from which we have to load the networks list.</p>
 
258
<p>Default value: NULL</p>
 
259
</div>
 
260
<hr>
 
261
<div class="refsect2" lang="en">
 
262
<a name="id393577"></a><h3>
 
263
<a name="EmpathyIrcNetworkManager--user-file"></a>The <code class="literal">"user-file"</code> property</h3>
 
264
<a class="indexterm" name="id393592"></a><pre class="programlisting">  "user-file"                gchararray            : Read / Write / Construct Only</pre>
 
265
<p>The path of user's  filename from which we have to load the networks list and to which we'll save his modifications.</p>
 
266
<p>Default value: NULL</p>
 
267
</div>
 
268
</div>
 
269
<div class="refsect1" lang="en">
 
270
<a name="id393619"></a><div class="refsect2" lang="en"><a name="id393620"></a></div>
 
271
<hr>
 
272
<div class="refsect2" lang="en"><a name="id393622"></a></div>
 
273
</div>
 
274
</div>
 
275
</body>
 
276
</html>