← Back to branch summary

~bcurtiswx/ubuntu/precise/empathy/3.4.2.1-0ubuntu1

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Laurent Bigonville
  • Date: 2009-11-16 23:40:52 UTC
  • mfrom: (1.1.39 upstream)
  • mto: (6.3.7 experimental)
  • mto: This revision was merged to the branch mainline in revision 80.
  • Revision ID: james.westby@ubuntu.com-20091116234052-7hhwrpeln4mwdyw7
Tags: upstream-2.29.2
Import upstream version 2.29.2

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=UTF-8">
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="EmpathyIdle.html" title="EmpathyIdle">
10
 
<link rel="next" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="pt01.html" title="Part I. libempathy Overview">
14
 
<link rel="part" href="pt02.html" title="Part II. 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="EmpathyIdle.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="EmpathyIrcNetwork.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
27
 
</tr>
28
 
<tr><td colspan="5" class="shortcuts">
29
 
<a href="#EmpathyIrcNetworkManager.synopsis" class="shortcut">Top</a>
30
 
                 | 
31
 
                <a href="#EmpathyIrcNetworkManager.description" class="shortcut">Description</a>
32
 
                 | 
33
 
                <a href="#EmpathyIrcNetworkManager.object-hierarchy" class="shortcut">Object Hierarchy</a>
34
 
                 | 
35
 
                <a href="#EmpathyIrcNetworkManager.properties" class="shortcut">Properties</a>
36
 
</td></tr>
37
 
</table>
38
 
<div class="refentry" lang="en">
39
 
<a name="EmpathyIrcNetworkManager"></a><div class="titlepage"></div>
40
 
<div class="refnamediv"><table width="100%"><tr>
41
 
<td valign="top">
42
 
<h2><span class="refentrytitle"><a name="EmpathyIrcNetworkManager.top_of_page"></a>EmpathyIrcNetworkManager</span></h2>
43
 
<p>EmpathyIrcNetworkManager</p>
44
 
</td>
45
 
<td valign="top" align="right"></td>
46
 
</tr></table></div>
47
 
<div class="refsynopsisdiv">
48
 
<a name="EmpathyIrcNetworkManager.synopsis"></a><h2>Synopsis</h2>
49
 
<pre class="synopsis">
50
 
                    <a class="link" href="EmpathyIrcNetworkManager.html#EmpathyIrcNetworkManager-struct" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a>;
51
 
<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> * <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-new" title="empathy_irc_network_manager_new ()">empathy_irc_network_manager_new</a>
52
 
                                                        (const <a
53
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
54
 
>gchar</a> *global_file,
55
 
                                                         const <a
56
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
57
 
>gchar</a> *user_file);
58
 
void                <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-add" title="empathy_irc_network_manager_add ()">empathy_irc_network_manager_add</a>     (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
59
 
                                                         <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);
60
 
void                <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-remove" title="empathy_irc_network_manager_remove ()">empathy_irc_network_manager_remove</a>  (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
61
 
                                                         <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);
62
 
<a
63
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
64
 
>GSList</a> *            <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-get-networks" title="empathy_irc_network_manager_get_networks ()">empathy_irc_network_manager_get_networks</a>
65
 
                                                        (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager);
66
 
<a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> * <a class="link" href="EmpathyIrcNetworkManager.html#empathy-irc-network-manager-find-network-by-address" title="empathy_irc_network_manager_find_network_by_address ()">empathy_irc_network_manager_find_network_by_address</a>
67
 
                                                        (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
68
 
                                                         const <a
69
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
70
 
>gchar</a> *address);
71
 
</pre>
72
 
</div>
73
 
<div class="refsect1" lang="en">
74
 
<a name="EmpathyIrcNetworkManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
75
 
<pre class="synopsis">
76
 
  <a
77
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
78
 
>GObject</a>
79
 
   +----EmpathyIrcNetworkManager
80
 
</pre>
81
 
</div>
82
 
<div class="refsect1" lang="en">
83
 
<a name="EmpathyIrcNetworkManager.properties"></a><h2>Properties</h2>
84
 
<pre class="synopsis">
85
 
  "<a class="link" href="EmpathyIrcNetworkManager.html#EmpathyIrcNetworkManager--global-file" title='The "global-file" property'>global-file</a>"              <a
86
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
87
 
>gchar</a>*                : Read / Write / Construct Only
88
 
  "<a class="link" href="EmpathyIrcNetworkManager.html#EmpathyIrcNetworkManager--user-file" title='The "user-file" property'>user-file</a>"                <a
89
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
90
 
>gchar</a>*                : Read / Write / Construct Only
91
 
</pre>
92
 
</div>
93
 
<div class="refsect1" lang="en">
94
 
<a name="EmpathyIrcNetworkManager.description"></a><h2>Description</h2>
95
 
<p>
96
 
</p>
97
 
</div>
98
 
<div class="refsect1" lang="en">
99
 
<a name="EmpathyIrcNetworkManager.details"></a><h2>Details</h2>
100
 
<div class="refsect2" lang="en">
101
 
<a name="EmpathyIrcNetworkManager-struct"></a><h3>EmpathyIrcNetworkManager</h3>
102
 
<pre class="programlisting">typedef struct _EmpathyIrcNetworkManager EmpathyIrcNetworkManager;</pre>
103
 
<p>
104
 
</p>
105
 
</div>
106
 
<hr>
107
 
<div class="refsect2" lang="en">
108
 
<a name="empathy-irc-network-manager-new"></a><h3>empathy_irc_network_manager_new ()</h3>
109
 
<pre class="programlisting"><a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> * empathy_irc_network_manager_new
110
 
                                                        (const <a
111
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
112
 
>gchar</a> *global_file,
113
 
                                                         const <a
114
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
115
 
>gchar</a> *user_file);</pre>
116
 
<p>
117
 
Creates a new <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a></p>
118
 
<p>
119
 
</p>
120
 
<div class="variablelist"><table border="0">
121
 
<col align="left" valign="top">
122
 
<tbody>
123
 
<tr>
124
 
<td><p><span class="term"><em class="parameter"><code>global_file</code></em> :</span></p></td>
125
 
<td> the path of the global networks file, or <a
126
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
127
 
><code class="literal">NULL</code></a>
128
 
</td>
129
 
</tr>
130
 
<tr>
131
 
<td><p><span class="term"><em class="parameter"><code>user_file</code></em> :</span></p></td>
132
 
<td> the path of the user networks file, or <a
133
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
134
 
><code class="literal">NULL</code></a>
135
 
</td>
136
 
</tr>
137
 
<tr>
138
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
139
 
<td> a new <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
140
 
</td>
141
 
</tr>
142
 
</tbody>
143
 
</table></div>
144
 
</div>
145
 
<hr>
146
 
<div class="refsect2" lang="en">
147
 
<a name="empathy-irc-network-manager-add"></a><h3>empathy_irc_network_manager_add ()</h3>
148
 
<pre class="programlisting">void                empathy_irc_network_manager_add     (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
149
 
                                                         <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);</pre>
150
 
<p>
151
 
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>
152
 
<p>
153
 
</p>
154
 
<div class="variablelist"><table border="0">
155
 
<col align="left" valign="top">
156
 
<tbody>
157
 
<tr>
158
 
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
159
 
<td> an <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
160
 
</td>
161
 
</tr>
162
 
<tr>
163
 
<td><p><span class="term"><em class="parameter"><code>network</code></em> :</span></p></td>
164
 
<td> the <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a> to add
165
 
</td>
166
 
</tr>
167
 
</tbody>
168
 
</table></div>
169
 
</div>
170
 
<hr>
171
 
<div class="refsect2" lang="en">
172
 
<a name="empathy-irc-network-manager-remove"></a><h3>empathy_irc_network_manager_remove ()</h3>
173
 
<pre class="programlisting">void                empathy_irc_network_manager_remove  (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
174
 
                                                         <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> *network);</pre>
175
 
<p>
176
 
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>
177
 
<p>
178
 
</p>
179
 
<div class="variablelist"><table border="0">
180
 
<col align="left" valign="top">
181
 
<tbody>
182
 
<tr>
183
 
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
184
 
<td> an <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
185
 
</td>
186
 
</tr>
187
 
<tr>
188
 
<td><p><span class="term"><em class="parameter"><code>network</code></em> :</span></p></td>
189
 
<td> the <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a> to remove
190
 
</td>
191
 
</tr>
192
 
</tbody>
193
 
</table></div>
194
 
</div>
195
 
<hr>
196
 
<div class="refsect2" lang="en">
197
 
<a name="empathy-irc-network-manager-get-networks"></a><h3>empathy_irc_network_manager_get_networks ()</h3>
198
 
<pre class="programlisting"><a
199
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
200
 
>GSList</a> *            empathy_irc_network_manager_get_networks
201
 
                                                        (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager);</pre>
202
 
<p>
203
 
Get the list of <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a> associated with the given
204
 
manager.</p>
205
 
<p>
206
 
</p>
207
 
<div class="variablelist"><table border="0">
208
 
<col align="left" valign="top">
209
 
<tbody>
210
 
<tr>
211
 
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
212
 
<td> an <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
213
 
</td>
214
 
</tr>
215
 
<tr>
216
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
217
 
<td> a new <a
218
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
219
 
><span class="type">GSList</span></a> of refed <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>
220
 
</td>
221
 
</tr>
222
 
</tbody>
223
 
</table></div>
224
 
</div>
225
 
<hr>
226
 
<div class="refsect2" lang="en">
227
 
<a name="empathy-irc-network-manager-find-network-by-address"></a><h3>empathy_irc_network_manager_find_network_by_address ()</h3>
228
 
<pre class="programlisting"><a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">EmpathyIrcNetwork</a> * empathy_irc_network_manager_find_network_by_address
229
 
                                                        (<a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</a> *manager,
230
 
                                                         const <a
231
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
232
 
>gchar</a> *address);</pre>
233
 
<p>
234
 
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>
235
 
that has the given address.</p>
236
 
<p>
237
 
</p>
238
 
<div class="variablelist"><table border="0">
239
 
<col align="left" valign="top">
240
 
<tbody>
241
 
<tr>
242
 
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
243
 
<td> an <a class="link" href="EmpathyIrcNetworkManager.html" title="EmpathyIrcNetworkManager"><span class="type">EmpathyIrcNetworkManager</span></a>
244
 
</td>
245
 
</tr>
246
 
<tr>
247
 
<td><p><span class="term"><em class="parameter"><code>address</code></em> :</span></p></td>
248
 
<td> the server address to look for
249
 
</td>
250
 
</tr>
251
 
<tr>
252
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
253
 
<td> the found <a class="link" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork"><span class="type">EmpathyIrcNetwork</span></a>, or <a
254
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
255
 
><code class="literal">NULL</code></a> if not found.
256
 
</td>
257
 
</tr>
258
 
</tbody>
259
 
</table></div>
260
 
</div>
261
 
</div>
262
 
<div class="refsect1" lang="en">
263
 
<a name="EmpathyIrcNetworkManager.property-details"></a><h2>Property Details</h2>
264
 
<div class="refsect2" lang="en">
265
 
<a name="EmpathyIrcNetworkManager--global-file"></a><h3>The <code class="literal">"global-file"</code> property</h3>
266
 
<pre class="programlisting">  "global-file"              <a
267
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
268
 
>gchar</a>*                : Read / Write / Construct Only</pre>
269
 
<p>The path of the system-wide filename from which we have to load the networks list.</p>
270
 
<p>Default value: NULL</p>
271
 
</div>
272
 
<hr>
273
 
<div class="refsect2" lang="en">
274
 
<a name="EmpathyIrcNetworkManager--user-file"></a><h3>The <code class="literal">"user-file"</code> property</h3>
275
 
<pre class="programlisting">  "user-file"                <a
276
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
277
 
>gchar</a>*                : Read / Write / Construct Only</pre>
278
 
<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>
279
 
<p>Default value: NULL</p>
280
 
</div>
281
 
</div>
282
 
</div>
283
 
<div class="footer">
284
 
<hr>
285
 
          Generated by GTK-Doc V1.11</div>
286
 
</body>
287
 
</html>