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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
<?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="EmpathyIrcNetwork">
<refmeta>
<refentrytitle role="top_of_page">EmpathyIrcNetwork</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>EmpathyIrcNetwork</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="EmpathyIrcNetwork-struct">EmpathyIrcNetwork</link>;
<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link>* <link linkend="empathy-irc-network-new">empathy_irc_network_new</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="GSList">GSList</link>* <link linkend="empathy-irc-network-get-servers">empathy_irc_network_get_servers</link> (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);
<link linkend="void">void</link> <link linkend="empathy-irc-network-append-server">empathy_irc_network_append_server</link> (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
<link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server);
<link linkend="void">void</link> <link linkend="empathy-irc-network-remove-server">empathy_irc_network_remove_server</link> (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
<link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server);
<link linkend="void">void</link> <link linkend="empathy-irc-network-set-server-position">empathy_irc_network_set_server_position</link>
(<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
<link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server,
<link linkend="gint">gint</link> pos);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----EmpathyIrcNetwork
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="EmpathyIrcNetwork--charset">charset</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
"<link linkend="EmpathyIrcNetwork--name">name</link>" <link linkend="gchararray">gchararray</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="EmpathyIrcNetwork-modified">modified</link>" : Run Last / Has Details
</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="EmpathyIrcNetwork-struct" role="struct"/>EmpathyIrcNetwork</title>
<indexterm><primary>EmpathyIrcNetwork</primary></indexterm><programlisting>typedef struct _EmpathyIrcNetwork EmpathyIrcNetwork;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-new" role="function"/>empathy_irc_network_new ()</title>
<indexterm><primary>empathy_irc_network_new</primary></indexterm><programlisting><link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link>* empathy_irc_network_new (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Creates a new <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> the name of the network
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-get-servers" role="function"/>empathy_irc_network_get_servers ()</title>
<indexterm><primary>empathy_irc_network_get_servers</primary></indexterm><programlisting><link linkend="GSList">GSList</link>* empathy_irc_network_get_servers (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);</programlisting>
<para>
Get the list of <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> that belongs to this network.
These servers are sorted according their priority.
So the first one will be the first used when trying to connect to
the network.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>network</parameter> :</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</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="EmpathyIrcServer"><type>EmpathyIrcServer</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-append-server" role="function"/>empathy_irc_network_append_server ()</title>
<indexterm><primary>empathy_irc_network_append_server</primary></indexterm><programlisting><link linkend="void">void</link> empathy_irc_network_append_server (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
<link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server);</programlisting>
<para>
Add an <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to the given <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>. The server
is added at the last position in network's servers list.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>network</parameter> :</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara> the <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to add
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-remove-server" role="function"/>empathy_irc_network_remove_server ()</title>
<indexterm><primary>empathy_irc_network_remove_server</primary></indexterm><programlisting><link linkend="void">void</link> empathy_irc_network_remove_server (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
<link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server);</programlisting>
<para>
Remove an <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> from the servers list of the
given <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>network</parameter> :</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara> the <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to remove
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="empathy-irc-network-set-server-position" role="function"/>empathy_irc_network_set_server_position ()</title>
<indexterm><primary>empathy_irc_network_set_server_position</primary></indexterm><programlisting><link linkend="void">void</link> empathy_irc_network_set_server_position
(<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
<link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server,
<link linkend="gint">gint</link> pos);</programlisting>
<para>
Move an <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> in the servers list of the given
<link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>network</parameter> :</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara> the <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to move
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> the position to move the server. If this is negative, or is larger than
the number of servers in the list, the server is moved to the end of the
list.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="EmpathyIrcNetwork--charset"/>The <literal>"charset"</literal> property</title>
<indexterm><primary>EmpathyIrcNetwork:charset</primary></indexterm><programlisting> "charset" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
<para>The charset to use on this network.</para><para>Default value: "UTF-8"</para>
</refsect2>
<refsect2><title><anchor id="EmpathyIrcNetwork--name"/>The <literal>"name"</literal> property</title>
<indexterm><primary>EmpathyIrcNetwork:name</primary></indexterm><programlisting> "name" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>The displayed name of this network.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="EmpathyIrcNetwork-modified"/>The <literal>"modified"</literal> signal</title>
<indexterm><primary>EmpathyIrcNetwork::modified</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Has Details</programlisting>
<para>
Emitted when either a property or a server of the network is modified.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>network</parameter> :</term>
<listitem><simpara> the object that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>
|