<?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" id="EmpathyIrcNetwork.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 id="EmpathyIrcNetwork.synopsis" 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 id="EmpathyIrcNetwork.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----EmpathyIrcNetwork
</synopsis>

</refsect1>





<refsect1 id="EmpathyIrcNetwork.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="EmpathyIrcNetwork--charset">charset</link>&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct
  &quot;<link linkend="EmpathyIrcNetwork--name">name</link>&quot;                     <link linkend="gchar">gchar</link>*                : Read / Write
</synopsis>
</refsect1>

<refsect1 id="EmpathyIrcNetwork.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="EmpathyIrcNetwork-modified">modified</link>&quot;                                       : Run Last / Has Details
</synopsis>
</refsect1>


<refsect1 id="EmpathyIrcNetwork.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="EmpathyIrcNetwork.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="EmpathyIrcNetwork-struct" role="struct">
<title>EmpathyIrcNetwork</title>
<indexterm zone="EmpathyIrcNetwork-struct"><primary>EmpathyIrcNetwork</primary></indexterm><programlisting>typedef struct _EmpathyIrcNetwork EmpathyIrcNetwork;</programlisting>
<para>

</para></refsect2>
<refsect2 id="empathy-irc-network-new" role="function">
<title>empathy_irc_network_new ()</title>
<indexterm zone="empathy-irc-network-new"><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>&nbsp;:</term>
<listitem><simpara> the name of the network
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-irc-network-get-servers" role="function">
<title>empathy_irc_network_get_servers ()</title>
<indexterm zone="empathy-irc-network-get-servers"><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>&nbsp;:</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
<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>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-irc-network-append-server" role="function">
<title>empathy_irc_network_append_server ()</title>
<indexterm zone="empathy-irc-network-append-server"><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>&nbsp;:</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>server</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to add
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-irc-network-remove-server" role="function">
<title>empathy_irc_network_remove_server ()</title>
<indexterm zone="empathy-irc-network-remove-server"><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>&nbsp;:</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>server</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to remove
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-irc-network-set-server-position" role="function">
<title>empathy_irc_network_set_server_position ()</title>
<indexterm zone="empathy-irc-network-set-server-position"><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>&nbsp;:</term>
<listitem><simpara> an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>server</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link> to move
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter>&nbsp;:</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 id="EmpathyIrcNetwork.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="EmpathyIrcNetwork--charset"><title>The <literal>&quot;charset&quot;</literal> property</title>
<indexterm zone="EmpathyIrcNetwork--charset"><primary>EmpathyIrcNetwork:charset</primary></indexterm><programlisting>  &quot;charset&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
<para>The charset to use on this network.</para><para>Default value: "UTF-8"</para>
</refsect2>
<refsect2 id="EmpathyIrcNetwork--name"><title>The <literal>&quot;name&quot;</literal> property</title>
<indexterm zone="EmpathyIrcNetwork--name"><primary>EmpathyIrcNetwork:name</primary></indexterm><programlisting>  &quot;name&quot;                     <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>The displayed name of this network.</para><para>Default value: NULL</para>
</refsect2>

</refsect1>

<refsect1 id="EmpathyIrcNetwork.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="EmpathyIrcNetwork-modified"><title>The <literal>&quot;modified&quot;</literal> signal</title>
<indexterm zone="EmpathyIrcNetwork-modified"><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>&nbsp;:</term>
<listitem><simpara> the object that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>
