1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="EmpathyIrcNetworkManager">
<refmeta>
<refentrytitle role="top_of_page">EmpathyIrcNetworkManager</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>EmpathyIrcNetworkManager</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="EmpathyIrcNetworkManager-struct">EmpathyIrcNetworkManager</link>;
<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link>* <link linkend="empathy-irc-network-manager-new">empathy_irc_network_manager_new</link>
(const <link linkend="gchar">gchar</link> *global_file,
const <link linkend="gchar">gchar</link> *user_file);
<link linkend="void">void</link> <link linkend="empathy-irc-network-manager-add">empathy_irc_network_manager_add</link> (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);
<link linkend="void">void</link> <link linkend="empathy-irc-network-manager-remove">empathy_irc_network_manager_remove</link> (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);
<link linkend="GSList">GSList</link>* <link linkend="empathy-irc-network-manager-get-networks">empathy_irc_network_manager_get_networks</link>
(<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager);
<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link>* <link linkend="empathy-irc-network-manager-find-network-by-address">empathy_irc_network_manager_find_network_by_address</link>
(<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
const <link linkend="gchar">gchar</link> *address);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----EmpathyIrcNetworkManager
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="EmpathyIrcNetworkManager--global-file">global-file</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
"<link linkend="EmpathyIrcNetworkManager--user-file">user-file</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="EmpathyIrcNetworkManager-struct" role="struct"/>EmpathyIrcNetworkManager</title>
<indexterm><primary>EmpathyIrcNetworkManager</primary></indexterm><programlisting>typedef struct _EmpathyIrcNetworkManager EmpathyIrcNetworkManager;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-manager-new" role="function"/>empathy_irc_network_manager_new ()</title>
<indexterm><primary>empathy_irc_network_manager_new</primary></indexterm><programlisting><link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link>* empathy_irc_network_manager_new
(const <link linkend="gchar">gchar</link> *global_file,
const <link linkend="gchar">gchar</link> *user_file);</programlisting>
<para>
Creates a new <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>global_file</parameter> :</term>
<listitem><simpara> the path of the global networks file, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_file</parameter> :</term>
<listitem><simpara> the path of the user networks file, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-manager-add" role="function"/>empathy_irc_network_manager_add ()</title>
<indexterm><primary>empathy_irc_network_manager_add</primary></indexterm><programlisting><link linkend="void">void</link> empathy_irc_network_manager_add (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);</programlisting>
<para>
Add an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> to the given <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>network</parameter> :</term>
<listitem><simpara> the <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> to add
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-manager-remove" role="function"/>empathy_irc_network_manager_remove ()</title>
<indexterm><primary>empathy_irc_network_manager_remove</primary></indexterm><programlisting><link linkend="void">void</link> empathy_irc_network_manager_remove (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);</programlisting>
<para>
Remove an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> from the given <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>network</parameter> :</term>
<listitem><simpara> the <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> to remove
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-manager-get-networks" role="function"/>empathy_irc_network_manager_get_networks ()</title>
<indexterm><primary>empathy_irc_network_manager_get_networks</primary></indexterm><programlisting><link linkend="GSList">GSList</link>* empathy_irc_network_manager_get_networks
(<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager);</programlisting>
<para>
Get the list of <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> associated with the given
manager.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GSList"><type>GSList</type></link> of refed <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-manager-find-network-by-address" role="function"/>empathy_irc_network_manager_find_network_by_address ()</title>
<indexterm><primary>empathy_irc_network_manager_find_network_by_address</primary></indexterm><programlisting><link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link>* empathy_irc_network_manager_find_network_by_address
(<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
const <link linkend="gchar">gchar</link> *address);</programlisting>
<para>
Find the <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> which owns an <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link>
that has the given address.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>address</parameter> :</term>
<listitem><simpara> the server address to look for
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the found <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if not found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="EmpathyIrcNetworkManager--global-file"/>The <literal>"global-file"</literal> property</title>
<indexterm><primary>EmpathyIrcNetworkManager:global-file</primary></indexterm><programlisting> "global-file" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
<para>The path of the system-wide filename from which we have to load the networks list.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="EmpathyIrcNetworkManager--user-file"/>The <literal>"user-file"</literal> property</title>
<indexterm><primary>EmpathyIrcNetworkManager:user-file</primary></indexterm><programlisting> "user-file" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
<para>The path of user's filename from which we have to load the networks list and to which we'll save his modifications.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>
|