← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/libempathy/xml/empathy-irc-network.xml

Tags: upstream-0.22.0
Import upstream version 0.22.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libempathy/xml/empathy-irc-network.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
<!ENTITY version SYSTEM "version.xml">
 
5
]>
 
6
<refentry id="EmpathyIrcNetwork">
 
7
<refmeta>
 
8
<refentrytitle role="top_of_page">EmpathyIrcNetwork</refentrytitle>
 
9
<manvolnum>3</manvolnum>
 
10
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
<refnamediv>
 
14
<refname>EmpathyIrcNetwork</refname>
 
15
<refpurpose></refpurpose>
 
16
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv role="synopsis">
 
20
<title role="synopsis.title">Synopsis</title>
 
21
 
 
22
<synopsis>
 
23
 
 
24
 
 
25
 
 
26
                    <link linkend="EmpathyIrcNetwork-struct">EmpathyIrcNetwork</link>;
 
27
<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link>*  <link linkend="empathy-irc-network-new">empathy_irc_network_new</link>             (const <link linkend="gchar">gchar</link> *name);
 
28
<link linkend="GSList">GSList</link>*             <link linkend="empathy-irc-network-get-servers">empathy_irc_network_get_servers</link>     (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);
 
29
<link linkend="void">void</link>                <link linkend="empathy-irc-network-append-server">empathy_irc_network_append_server</link>   (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
 
30
                                                         <link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server);
 
31
<link linkend="void">void</link>                <link linkend="empathy-irc-network-remove-server">empathy_irc_network_remove_server</link>   (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
 
32
                                                         <link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server);
 
33
<link linkend="void">void</link>                <link linkend="empathy-irc-network-set-server-position">empathy_irc_network_set_server_position</link>
 
34
                                                        (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
 
35
                                                         <link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server,
 
36
                                                         <link linkend="gint">gint</link> pos);
 
37
 
 
38
</synopsis>
 
39
</refsynopsisdiv>
 
40
 
 
41
<refsect1 role="object_hierarchy">
 
42
<title role="object_hierarchy.title">Object Hierarchy</title>
 
43
<synopsis>
 
44
 
 
45
  <link linkend="GObject">GObject</link>
 
46
   +----EmpathyIrcNetwork
 
47
</synopsis>
 
48
 
 
49
</refsect1>
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
<refsect1 role="properties">
 
56
<title role="properties.title">Properties</title>
 
57
<synopsis>
 
58
 
 
59
  &quot;<link linkend="EmpathyIrcNetwork--charset">charset</link>&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
 
60
  &quot;<link linkend="EmpathyIrcNetwork--name">name</link>&quot;                     <link linkend="gchararray">gchararray</link>            : Read / Write
 
61
</synopsis>
 
62
</refsect1>
 
63
 
 
64
<refsect1 role="signal_proto">
 
65
<title role="signal_proto.title">Signals</title>
 
66
<synopsis>
 
67
 
 
68
  &quot;<link linkend="EmpathyIrcNetwork-modified">modified</link>&quot;                                       : Run Last / Has Details
 
69
</synopsis>
 
70
</refsect1>
 
71
 
 
72
 
 
73
<refsect1 role="desc">
 
74
<title role="desc.title">Description</title>
 
75
<para>
 
76
 
 
77
</para>
 
78
</refsect1>
 
79
 
 
80
<refsect1 role="details">
 
81
<title role="details.title">Details</title>
 
82
<refsect2>
 
83
<title><anchor id="EmpathyIrcNetwork-struct" role="struct"/>EmpathyIrcNetwork</title>
 
84
<indexterm><primary>EmpathyIrcNetwork</primary></indexterm><programlisting>typedef struct _EmpathyIrcNetwork EmpathyIrcNetwork;</programlisting>
 
85
<para>
 
86
 
 
87
</para></refsect2>
 
88
<refsect2>
 
89
<title><anchor id="empathy-irc-network-new" role="function"/>empathy_irc_network_new ()</title>
 
90
<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>
 
91
<para>
 
92
Creates a new <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>.</para>
 
93
<para>
 
94
 
 
95
</para><variablelist role="params">
 
96
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
97
<listitem><simpara> the name of the network
 
98
</simpara></listitem></varlistentry>
 
99
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
 
100
</simpara></listitem></varlistentry>
 
101
</variablelist></refsect2>
 
102
<refsect2>
 
103
<title><anchor id="empathy-irc-network-get-servers" role="function"/>empathy_irc_network_get_servers ()</title>
 
104
<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>
 
105
<para>
 
106
Get the list of <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> that belongs to this network.
 
107
These servers are sorted according their priority.
 
108
So the first one will be the first used when trying to connect to
 
109
the network.</para>
 
110
<para>
 
111
 
 
112
</para><variablelist role="params">
 
113
<varlistentry><term><parameter>network</parameter>&nbsp;:</term>
 
114
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
 
115
</simpara></listitem></varlistentry>
 
116
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GSList"><type>GSList</type></link> of refed <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link>.
 
117
</simpara></listitem></varlistentry>
 
118
</variablelist></refsect2>
 
119
<refsect2>
 
120
<title><anchor id="empathy-irc-network-append-server" role="function"/>empathy_irc_network_append_server ()</title>
 
121
<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,
 
122
                                                         <link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server);</programlisting>
 
123
<para>
 
124
Add an <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to the given <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>. The server
 
125
is added at the last position in network's servers list.</para>
 
126
<para>
 
127
 
 
128
</para><variablelist role="params">
 
129
<varlistentry><term><parameter>network</parameter>&nbsp;:</term>
 
130
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
 
131
</simpara></listitem></varlistentry>
 
132
<varlistentry><term><parameter>server</parameter>&nbsp;:</term>
 
133
<listitem><simpara> the <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to add
 
134
</simpara></listitem></varlistentry>
 
135
</variablelist></refsect2>
 
136
<refsect2>
 
137
<title><anchor id="empathy-irc-network-remove-server" role="function"/>empathy_irc_network_remove_server ()</title>
 
138
<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,
 
139
                                                         <link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server);</programlisting>
 
140
<para>
 
141
Remove an <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> from the servers list of the
 
142
given <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>.</para>
 
143
<para>
 
144
 
 
145
</para><variablelist role="params">
 
146
<varlistentry><term><parameter>network</parameter>&nbsp;:</term>
 
147
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
 
148
</simpara></listitem></varlistentry>
 
149
<varlistentry><term><parameter>server</parameter>&nbsp;:</term>
 
150
<listitem><simpara> the <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to remove
 
151
</simpara></listitem></varlistentry>
 
152
</variablelist></refsect2>
 
153
<refsect2>
 
154
<title><anchor id="empathy-irc-network-set-server-position" role="function"/>empathy_irc_network_set_server_position ()</title>
 
155
<indexterm><primary>empathy_irc_network_set_server_position</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_irc_network_set_server_position
 
156
                                                        (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
 
157
                                                         <link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server,
 
158
                                                         <link linkend="gint">gint</link> pos);</programlisting>
 
159
<para>
 
160
Move an <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> in the servers list of the given
 
161
<link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>.</para>
 
162
<para>
 
163
 
 
164
</para><variablelist role="params">
 
165
<varlistentry><term><parameter>network</parameter>&nbsp;:</term>
 
166
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
 
167
</simpara></listitem></varlistentry>
 
168
<varlistentry><term><parameter>server</parameter>&nbsp;:</term>
 
169
<listitem><simpara> the <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to move
 
170
</simpara></listitem></varlistentry>
 
171
<varlistentry><term><parameter>pos</parameter>&nbsp;:</term>
 
172
<listitem><simpara> the position to move the server. If this is negative, or is larger than
 
173
the number of servers in the list, the server is moved to the end of the
 
174
list.
 
175
</simpara></listitem></varlistentry>
 
176
</variablelist></refsect2>
 
177
 
 
178
</refsect1>
 
179
<refsect1 role="property_details">
 
180
<title role="property_details.title">Property Details</title>
 
181
<refsect2><title><anchor id="EmpathyIrcNetwork--charset"/>The <literal>&quot;charset&quot;</literal> property</title>
 
182
<indexterm><primary>EmpathyIrcNetwork:charset</primary></indexterm><programlisting>  &quot;charset&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
183
<para>The charset to use on this network.</para><para>Default value: "UTF-8"</para>
 
184
</refsect2>
 
185
<refsect2><title><anchor id="EmpathyIrcNetwork--name"/>The <literal>&quot;name&quot;</literal> property</title>
 
186
<indexterm><primary>EmpathyIrcNetwork:name</primary></indexterm><programlisting>  &quot;name&quot;                     <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
 
187
<para>The displayed name of this network.</para><para>Default value: NULL</para>
 
188
</refsect2>
 
189
 
 
190
</refsect1>
 
191
 
 
192
<refsect1 role="signals">
 
193
<title role="signals.title">Signal Details</title>
 
194
<refsect2><title><anchor id="EmpathyIrcNetwork-modified"/>The <literal>&quot;modified&quot;</literal> signal</title>
 
195
<indexterm><primary>EmpathyIrcNetwork::modified</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network,
 
196
                                                        <link linkend="gpointer">gpointer</link>           user_data)      : Run Last / Has Details</programlisting>
 
197
<para>
 
198
Emitted when either a property or a server of the network is modified.</para>
 
199
<para>
 
200
 
 
201
</para><variablelist role="params">
 
202
<varlistentry><term><parameter>network</parameter>&nbsp;:</term>
 
203
<listitem><simpara> the object that received the signal
 
204
</simpara></listitem></varlistentry>
 
205
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
206
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
207
</variablelist></refsect2>
 
208
</refsect1>
 
209
 
 
210
 
 
211
 
 
212
 
 
213
<refsect1><refsect2 /><refsect2 /></refsect1>
 
214
</refentry>