## EmpathyIrcNetwork

EmpathyIrcNetwork

## Synopsis

                        EmpathyIrcNetwork;
    EmpathyIrcNetwork * empathy_irc_network_new             (const gchar *name);
    GSList *            empathy_irc_network_get_servers     (EmpathyIrcNetwork *network);
    void                empathy_irc_network_append_server   (EmpathyIrcNetwork *network,
                                                             EmpathyIrcServer *server);
    void                empathy_irc_network_remove_server   (EmpathyIrcNetwork *network,
                                                             EmpathyIrcServer *server);
    void                empathy_irc_network_set_server_position
                                                            (EmpathyIrcNetwork *network,
                                                             EmpathyIrcServer *server,
                                                             gint pos);

## Object Hierarchy

      GObject
       +----EmpathyIrcNetwork

## Properties

      "charset"                  gchar*                : Read / Write / Construct
      "name"                     gchar*                : Read / Write

## Signals

      "modified"                                       : Run Last / Has Details

## Description

## Details

### EmpathyIrcNetwork

    typedef struct _EmpathyIrcNetwork EmpathyIrcNetwork;

### empathy_irc_network_new ()

    EmpathyIrcNetwork * empathy_irc_network_new             (const gchar *name);

Creates a new EmpathyIrcNetwork.

`name` : | the name of the network
Returns : | a new EmpathyIrcNetwork

### empathy_irc_network_get_servers ()

    GSList *            empathy_irc_network_get_servers     (EmpathyIrcNetwork *network);

Get the list of EmpathyIrcServer 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.

`network` : | an EmpathyIrcNetwork
Returns : | a new GSList of refed EmpathyIrcServer.

### empathy_irc_network_append_server ()

    void                empathy_irc_network_append_server   (EmpathyIrcNetwork *network,
                                                             EmpathyIrcServer *server);

Add an EmpathyIrcServer to the given EmpathyIrcNetwork. The server is added at the last position in network's servers list.

`network` : | an EmpathyIrcNetwork
`server` : | the EmpathyIrcServer to add

### empathy_irc_network_remove_server ()

    void                empathy_irc_network_remove_server   (EmpathyIrcNetwork *network,
                                                             EmpathyIrcServer *server);

Remove an EmpathyIrcServer from the servers list of the given EmpathyIrcNetwork.

`network` : | an EmpathyIrcNetwork
`server` : | the EmpathyIrcServer to remove

### empathy_irc_network_set_server_position ()

    void                empathy_irc_network_set_server_position
                                                            (EmpathyIrcNetwork *network,
                                                             EmpathyIrcServer *server,
                                                             gint pos);

Move an EmpathyIrcServer in the servers list of the given EmpathyIrcNetwork.

`network` : | an EmpathyIrcNetwork
`server` : | the EmpathyIrcServer to move
`pos` : | 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.

## Property Details

### The `"charset"` property

      "charset"                  gchar*                : Read / Write / Construct

The charset to use on this network.

Default value: "UTF-8"

### The `"name"` property

      "name"                     gchar*                : Read / Write

The displayed name of this network.

Default value: NULL

## Signal Details

### The `"modified"` signal

    void                user_function                      (EmpathyIrcNetwork *network,
                                                            gpointer           user_data)      : Run Last / Has Details

Emitted when either a property or a server of the network is modified.

`network` : | the object that received the signal
`user_data` : | user data set when the signal handler was connected.