ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcNetworkManager.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkManager</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkManager</h1>
<p>
Module implementing the IRC data structures and their manager.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#IrcChannel">IrcChannel</a></td>
<td>Class implementing the IRC channel object.</td>
</tr>
<tr>
<td><a href="#IrcIdentity">IrcIdentity</a></td>
<td>Class implementing the IRC identity object.</td>
</tr>
<tr>
<td><a href="#IrcNetwork">IrcNetwork</a></td>
<td>Class implementing the IRC network object.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager">IrcNetworkManager</a></td>
<td>Class implementing the IRC identity object.</td>
</tr>
<tr>
<td><a href="#IrcServer">IrcServer</a></td>
<td>Class implementing the IRC identity object.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="IrcChannel" ID="IrcChannel"></a>
<h2>IrcChannel</h2>
<p>
    Class implementing the IRC channel object.
</p>

<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#IrcChannel.__init__">IrcChannel</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#IrcChannel.autoJoin">autoJoin</a></td>
<td>Public method to check the auto join status.</td>
</tr>
<tr>
<td><a href="#IrcChannel.getKey">getKey</a></td>
<td>Public method to get the channel key.</td>
</tr>
<tr>
<td><a href="#IrcChannel.getName">getName</a></td>
<td>Public method to get the channel name.</td>
</tr>
<tr>
<td><a href="#IrcChannel.load">load</a></td>
<td>Public method to load the network data.</td>
</tr>
<tr>
<td><a href="#IrcChannel.save">save</a></td>
<td>Public method to save the channel data.</td>
</tr>
<tr>
<td><a href="#IrcChannel.setAutoJoin">setAutoJoin</a></td>
<td>Public method to set the auto join status of the channel.</td>
</tr>
<tr>
<td><a href="#IrcChannel.setKey">setKey</a></td>
<td>Public method to set a new channel key.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="IrcChannel.__init__" ID="IrcChannel.__init__"></a>
<h4>IrcChannel (Constructor)</h4>
<b>IrcChannel</b>(<i>name</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
name of the network
</dd>
</dl>
<a NAME="IrcChannel.autoJoin" ID="IrcChannel.autoJoin"></a>
<h4>IrcChannel.autoJoin</h4>
<b>autoJoin</b>(<i></i>)
<p>
        Public method to check the auto join status.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating if the channel should be
            joined automatically
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="IrcChannel.getKey" ID="IrcChannel.getKey"></a>
<h4>IrcChannel.getKey</h4>
<b>getKey</b>(<i></i>)
<p>
        Public method to get the channel key.
</p>

<dl>
<dt>Return:</dt>
<dd>
channel key
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcChannel.getName" ID="IrcChannel.getName"></a>
<h4>IrcChannel.getName</h4>
<b>getName</b>(<i></i>)
<p>
        Public method to get the channel name.
</p>

<dl>
<dt>Return:</dt>
<dd>
channel name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcChannel.load" ID="IrcChannel.load"></a>
<h4>IrcChannel.load</h4>
<b>load</b>(<i>settings</i>)
<p>
        Public method to load the network data.
</p>

<dl>

<dt><i>settings</i> (QSettings)</dt>
<dd>
reference to the settings object
</dd>
</dl>
<a NAME="IrcChannel.save" ID="IrcChannel.save"></a>
<h4>IrcChannel.save</h4>
<b>save</b>(<i>settings</i>)
<p>
        Public method to save the channel data.
</p>

<dl>

<dt><i>settings</i> (QSettings)</dt>
<dd>
reference to the settings object
</dd>
</dl>
<a NAME="IrcChannel.setAutoJoin" ID="IrcChannel.setAutoJoin"></a>
<h4>IrcChannel.setAutoJoin</h4>
<b>setAutoJoin</b>(<i>enable</i>)
<p>
        Public method to set the auto join status of the channel.
</p>

<dl>

<dt><i>enable</i> (bool)</dt>
<dd>
flag indicating if the channel should be
            joined automatically
</dd>
</dl>
<a NAME="IrcChannel.setKey" ID="IrcChannel.setKey"></a>
<h4>IrcChannel.setKey</h4>
<b>setKey</b>(<i>key</i>)
<p>
        Public method to set a new channel key.
</p>

<dl>

<dt><i>key</i> (str)</dt>
<dd>
channel key to set
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="IrcIdentity" ID="IrcIdentity"></a>
<h2>IrcIdentity</h2>
<p>
    Class implementing the IRC identity object.
</p>

<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
<table>
<tr><td>DefaultAwayMessage</td></tr>
<tr><td>DefaultIdentityDisplay</td></tr>
<tr><td>DefaultIdentityName</td></tr>
<tr><td>DefaultPartMessage</td></tr>
<tr><td>DefaultQuitMessage</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr>
<td><a href="#IrcIdentity.createDefaultIdentity">createDefaultIdentity</a></td>
<td>Class method to create the default identity.</td>
</tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#IrcIdentity.__init__">IrcIdentity</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#IrcIdentity.getAwayMessage">getAwayMessage</a></td>
<td>Public method to get the AWAY message.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.getIdent">getIdent</a></td>
<td>Public method to get the real identity name.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.getName">getName</a></td>
<td>Public method to get the identity name.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.getNickNames">getNickNames</a></td>
<td>Public method to get the nick names.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.getPartMessage">getPartMessage</a></td>
<td>Public method to get the PART message.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.getPassword">getPassword</a></td>
<td>Public method to get the password.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.getQuitMessage">getQuitMessage</a></td>
<td>Public method to get the QUIT message.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.getRealName">getRealName</a></td>
<td>Public method to get the real name.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.getServiceName">getServiceName</a></td>
<td>Public method to get the service name of the identity used for identification.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.load">load</a></td>
<td>Public method to load the identity data.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.rememberAwayPosition">rememberAwayPosition</a></td>
<td>Public method to get a flag indicating to remember the chat position upon AWAY.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.save">save</a></td>
<td>Public method to save the identity data.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setAwayMessage">setAwayMessage</a></td>
<td>Public method to set the AWAY message.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setIdent">setIdent</a></td>
<td>Public method to set the real identity name.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setName">setName</a></td>
<td>Public method to set the identity name.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setNickNames">setNickNames</a></td>
<td>Public method to set the nick names of the identity.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setPartMessage">setPartMessage</a></td>
<td>Public method to set the PART message.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setPassword">setPassword</a></td>
<td>Public method to set a new password.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setQuitMessage">setQuitMessage</a></td>
<td>Public method to set the QUIT message.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setRealName">setRealName</a></td>
<td>Public method to set the real name of the identity.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setRememberAwayPosition">setRememberAwayPosition</a></td>
<td>Public method to set to remember the chat position upon AWAY.</td>
</tr>
<tr>
<td><a href="#IrcIdentity.setServiceName">setServiceName</a></td>
<td>Public method to set the service name of the identity used for identification.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="IrcIdentity.createDefaultIdentity" ID="IrcIdentity.createDefaultIdentity"></a>
<h4>IrcIdentity.createDefaultIdentity (class method)</h4>
<b>createDefaultIdentity</b>(<i></i>)
<p>
        Class method to create the default identity.
</p>

<dl>
<dt>Return:</dt>
<dd>
default identity
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
IrcIdentity
</dd>
</dl>
<a NAME="IrcIdentity.__init__" ID="IrcIdentity.__init__"></a>
<h4>IrcIdentity (Constructor)</h4>
<b>IrcIdentity</b>(<i>name</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
name of the identity
</dd>
</dl>
<a NAME="IrcIdentity.getAwayMessage" ID="IrcIdentity.getAwayMessage"></a>
<h4>IrcIdentity.getAwayMessage</h4>
<b>getAwayMessage</b>(<i></i>)
<p>
        Public method to get the AWAY message.
</p>

<dl>
<dt>Return:</dt>
<dd>
AWAY message
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcIdentity.getIdent" ID="IrcIdentity.getIdent"></a>
<h4>IrcIdentity.getIdent</h4>
<b>getIdent</b>(<i></i>)
<p>
        Public method to get the real identity name.
</p>

<dl>
<dt>Return:</dt>
<dd>
real identity name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcIdentity.getName" ID="IrcIdentity.getName"></a>
<h4>IrcIdentity.getName</h4>
<b>getName</b>(<i></i>)
<p>
        Public method to get the identity name.
</p>

<dl>
<dt>Return:</dt>
<dd>
identity name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcIdentity.getNickNames" ID="IrcIdentity.getNickNames"></a>
<h4>IrcIdentity.getNickNames</h4>
<b>getNickNames</b>(<i></i>)
<p>
        Public method to get the nick names.
</p>

<dl>
<dt>Return:</dt>
<dd>
nick names
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="IrcIdentity.getPartMessage" ID="IrcIdentity.getPartMessage"></a>
<h4>IrcIdentity.getPartMessage</h4>
<b>getPartMessage</b>(<i></i>)
<p>
        Public method to get the PART message.
</p>

<dl>
<dt>Return:</dt>
<dd>
PART message
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcIdentity.getPassword" ID="IrcIdentity.getPassword"></a>
<h4>IrcIdentity.getPassword</h4>
<b>getPassword</b>(<i></i>)
<p>
        Public method to get the password.
</p>

<dl>
<dt>Return:</dt>
<dd>
password
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcIdentity.getQuitMessage" ID="IrcIdentity.getQuitMessage"></a>
<h4>IrcIdentity.getQuitMessage</h4>
<b>getQuitMessage</b>(<i></i>)
<p>
        Public method to get the QUIT message.
</p>

<dl>
<dt>Return:</dt>
<dd>
QUIT message
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcIdentity.getRealName" ID="IrcIdentity.getRealName"></a>
<h4>IrcIdentity.getRealName</h4>
<b>getRealName</b>(<i></i>)
<p>
        Public method to get the real name.
</p>

<dl>
<dt>Return:</dt>
<dd>
real name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcIdentity.getServiceName" ID="IrcIdentity.getServiceName"></a>
<h4>IrcIdentity.getServiceName</h4>
<b>getServiceName</b>(<i></i>)
<p>
        Public method to get the service name of the identity used for
        identification.
</p>

<dl>
<dt>Return:</dt>
<dd>
service name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcIdentity.load" ID="IrcIdentity.load"></a>
<h4>IrcIdentity.load</h4>
<b>load</b>(<i>settings</i>)
<p>
        Public method to load the identity data.
</p>

<dl>

<dt><i>settings</i> (QSettings)</dt>
<dd>
reference to the settings object
</dd>
</dl>
<a NAME="IrcIdentity.rememberAwayPosition" ID="IrcIdentity.rememberAwayPosition"></a>
<h4>IrcIdentity.rememberAwayPosition</h4>
<b>rememberAwayPosition</b>(<i></i>)
<p>
        Public method to get a flag indicating to remember the chat position
        upon AWAY.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating to remember the chat position
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="IrcIdentity.save" ID="IrcIdentity.save"></a>
<h4>IrcIdentity.save</h4>
<b>save</b>(<i>settings</i>)
<p>
        Public method to save the identity data.
</p>

<dl>

<dt><i>settings</i> (QSettings)</dt>
<dd>
reference to the settings object
</dd>
</dl>
<a NAME="IrcIdentity.setAwayMessage" ID="IrcIdentity.setAwayMessage"></a>
<h4>IrcIdentity.setAwayMessage</h4>
<b>setAwayMessage</b>(<i>message</i>)
<p>
        Public method to set the AWAY message.
</p>

<dl>

<dt><i>message</i> (str)</dt>
<dd>
AWAY message
</dd>
</dl>
<a NAME="IrcIdentity.setIdent" ID="IrcIdentity.setIdent"></a>
<h4>IrcIdentity.setIdent</h4>
<b>setIdent</b>(<i>name</i>)
<p>
        Public method to set the real identity name.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
real identity name
</dd>
</dl>
<a NAME="IrcIdentity.setName" ID="IrcIdentity.setName"></a>
<h4>IrcIdentity.setName</h4>
<b>setName</b>(<i>name</i>)
<p>
        Public method to set the identity name.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
identity name
</dd>
</dl>
<a NAME="IrcIdentity.setNickNames" ID="IrcIdentity.setNickNames"></a>
<h4>IrcIdentity.setNickNames</h4>
<b>setNickNames</b>(<i>names</i>)
<p>
        Public method to set the nick names of the identity.
</p>

<dl>

<dt><i>names</i> (list of str)</dt>
<dd>
nick names
</dd>
</dl>
<a NAME="IrcIdentity.setPartMessage" ID="IrcIdentity.setPartMessage"></a>
<h4>IrcIdentity.setPartMessage</h4>
<b>setPartMessage</b>(<i>message</i>)
<p>
        Public method to set the PART message.
</p>

<dl>

<dt><i>message</i> (str)</dt>
<dd>
PART message
</dd>
</dl>
<a NAME="IrcIdentity.setPassword" ID="IrcIdentity.setPassword"></a>
<h4>IrcIdentity.setPassword</h4>
<b>setPassword</b>(<i>password</i>)
<p>
        Public method to set a new password.
</p>

<dl>

<dt><i>password</i> (str)</dt>
<dd>
password to set
</dd>
</dl>
<a NAME="IrcIdentity.setQuitMessage" ID="IrcIdentity.setQuitMessage"></a>
<h4>IrcIdentity.setQuitMessage</h4>
<b>setQuitMessage</b>(<i>message</i>)
<p>
        Public method to set the QUIT message.
</p>

<dl>

<dt><i>message</i> (str)</dt>
<dd>
QUIT message
</dd>
</dl>
<a NAME="IrcIdentity.setRealName" ID="IrcIdentity.setRealName"></a>
<h4>IrcIdentity.setRealName</h4>
<b>setRealName</b>(<i>name</i>)
<p>
        Public method to set the real name of the identity.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
real name
</dd>
</dl>
<a NAME="IrcIdentity.setRememberAwayPosition" ID="IrcIdentity.setRememberAwayPosition"></a>
<h4>IrcIdentity.setRememberAwayPosition</h4>
<b>setRememberAwayPosition</b>(<i>remember</i>)
<p>
        Public method to set to remember the chat position upon AWAY.
</p>

<dl>

<dt><i>remember</i> (bool)</dt>
<dd>
flag indicating to remember the chat position
</dd>
</dl>
<a NAME="IrcIdentity.setServiceName" ID="IrcIdentity.setServiceName"></a>
<h4>IrcIdentity.setServiceName</h4>
<b>setServiceName</b>(<i>name</i>)
<p>
        Public method to set the service name of the identity used for
        identification.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
service name
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="IrcNetwork" ID="IrcNetwork"></a>
<h2>IrcNetwork</h2>
<p>
    Class implementing the IRC network object.
</p>

<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr>
<td><a href="#IrcNetwork.createDefaultNetwork">createDefaultNetwork</a></td>
<td>Class method to create the default network.</td>
</tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#IrcNetwork.__init__">IrcNetwork</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#IrcNetwork.addChannel">addChannel</a></td>
<td>Public method to add a channel.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.autoConnect">autoConnect</a></td>
<td>Public method to check, if the network should be connected to at start-up.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.deleteChannel">deleteChannel</a></td>
<td>Public method to delete the given channel.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.getChannel">getChannel</a></td>
<td>Public method to get a channel.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.getChannelNames">getChannelNames</a></td>
<td>Public method to get the list of channels.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.getChannels">getChannels</a></td>
<td>Public method to get the channels.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.getIdentityName">getIdentityName</a></td>
<td>Public method to get the name of the identity.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.getName">getName</a></td>
<td>Public method to get the network name.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.getServer">getServer</a></td>
<td>Public method to get the server object.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.getServerName">getServerName</a></td>
<td>Public method to get the server name.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.load">load</a></td>
<td>Public method to load the network data.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.save">save</a></td>
<td>Public method to save the network data.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.setAutoConnect">setAutoConnect</a></td>
<td>Public method to set the auto connect flag.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.setChannel">setChannel</a></td>
<td>Public method to set a channel.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.setChannels">setChannels</a></td>
<td>Public method to set the list of channels.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.setIdentityName">setIdentityName</a></td>
<td>Public method to set the name of the identity.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.setName">setName</a></td>
<td>Public method to set the network name.</td>
</tr>
<tr>
<td><a href="#IrcNetwork.setServer">setServer</a></td>
<td>Public method to set the server.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="IrcNetwork.createDefaultNetwork" ID="IrcNetwork.createDefaultNetwork"></a>
<h4>IrcNetwork.createDefaultNetwork (class method)</h4>
<b>createDefaultNetwork</b>(<i>ssl=False</i>)
<p>
        Class method to create the default network.
</p>

<dl>

<dt><i>ssl</i> (bool)</dt>
<dd>
flag indicating to create a SSL network configuration
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
default network object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
IrcNetwork
</dd>
</dl>
<a NAME="IrcNetwork.__init__" ID="IrcNetwork.__init__"></a>
<h4>IrcNetwork (Constructor)</h4>
<b>IrcNetwork</b>(<i>name</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
name of the network
</dd>
</dl>
<a NAME="IrcNetwork.addChannel" ID="IrcNetwork.addChannel"></a>
<h4>IrcNetwork.addChannel</h4>
<b>addChannel</b>(<i>channel</i>)
<p>
        Public method to add a channel.
</p>

<dl>

<dt><i>channel</i> (IrcChannel)</dt>
<dd>
channel object to add
</dd>
</dl>
<a NAME="IrcNetwork.autoConnect" ID="IrcNetwork.autoConnect"></a>
<h4>IrcNetwork.autoConnect</h4>
<b>autoConnect</b>(<i></i>)
<p>
        Public method to check, if the network should be connected to at
        start-up.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating an auto connect
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="IrcNetwork.deleteChannel" ID="IrcNetwork.deleteChannel"></a>
<h4>IrcNetwork.deleteChannel</h4>
<b>deleteChannel</b>(<i>channelName</i>)
<p>
        Public method to delete the given channel.
</p>

<dl>

<dt><i>channelName</i> (str)</dt>
<dd>
name of the channel to be deleted
</dd>
</dl>
<a NAME="IrcNetwork.getChannel" ID="IrcNetwork.getChannel"></a>
<h4>IrcNetwork.getChannel</h4>
<b>getChannel</b>(<i>channelName</i>)
<p>
        Public method to get a channel.
</p>

<dl>

<dt><i>channelName</i> (str)</dt>
<dd>
name of the channel to retrieve
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the channel
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
IrcChannel
</dd>
</dl>
<a NAME="IrcNetwork.getChannelNames" ID="IrcNetwork.getChannelNames"></a>
<h4>IrcNetwork.getChannelNames</h4>
<b>getChannelNames</b>(<i></i>)
<p>
        Public method to get the list of channels.
</p>

<dl>
<dt>Return:</dt>
<dd>
list of channel names
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="IrcNetwork.getChannels" ID="IrcNetwork.getChannels"></a>
<h4>IrcNetwork.getChannels</h4>
<b>getChannels</b>(<i></i>)
<p>
        Public method to get the channels.
</p>

<dl>
<dt>Return:</dt>
<dd>
list of channels for the network
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of IrcChannel
</dd>
</dl>
<a NAME="IrcNetwork.getIdentityName" ID="IrcNetwork.getIdentityName"></a>
<h4>IrcNetwork.getIdentityName</h4>
<b>getIdentityName</b>(<i></i>)
<p>
        Public method to get the name of the identity.
</p>

<dl>
<dt>Return:</dt>
<dd>
identity name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcNetwork.getName" ID="IrcNetwork.getName"></a>
<h4>IrcNetwork.getName</h4>
<b>getName</b>(<i></i>)
<p>
        Public method to get the network name.
</p>

<dl>
<dt>Return:</dt>
<dd>
network name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcNetwork.getServer" ID="IrcNetwork.getServer"></a>
<h4>IrcNetwork.getServer</h4>
<b>getServer</b>(<i></i>)
<p>
        Public method to get the server object.
</p>

<dl>
<dt>Return:</dt>
<dd>
reference to the server
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
IrcServer
</dd>
</dl>
<a NAME="IrcNetwork.getServerName" ID="IrcNetwork.getServerName"></a>
<h4>IrcNetwork.getServerName</h4>
<b>getServerName</b>(<i></i>)
<p>
        Public method to get the server name.
</p>

<dl>
<dt>Return:</dt>
<dd>
server name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcNetwork.load" ID="IrcNetwork.load"></a>
<h4>IrcNetwork.load</h4>
<b>load</b>(<i>settings</i>)
<p>
        Public method to load the network data.
</p>

<dl>

<dt><i>settings</i> (QSettings)</dt>
<dd>
reference to the settings object
</dd>
</dl>
<a NAME="IrcNetwork.save" ID="IrcNetwork.save"></a>
<h4>IrcNetwork.save</h4>
<b>save</b>(<i>settings</i>)
<p>
        Public method to save the network data.
</p>

<dl>

<dt><i>settings</i> (QSettings)</dt>
<dd>
reference to the settings object
</dd>
</dl>
<a NAME="IrcNetwork.setAutoConnect" ID="IrcNetwork.setAutoConnect"></a>
<h4>IrcNetwork.setAutoConnect</h4>
<b>setAutoConnect</b>(<i>enable</i>)
<p>
        Public method to set the auto connect flag.
</p>

<dl>

<dt><i>enable</i> (bool)</dt>
<dd>
flag indicate to connect to the network at start-up
</dd>
</dl>
<a NAME="IrcNetwork.setChannel" ID="IrcNetwork.setChannel"></a>
<h4>IrcNetwork.setChannel</h4>
<b>setChannel</b>(<i>channel</i>)
<p>
        Public method to set a channel.
</p>

<dl>

<dt><i>channel</i> (IrcChannel)</dt>
<dd>
channel object to set
</dd>
</dl>
<a NAME="IrcNetwork.setChannels" ID="IrcNetwork.setChannels"></a>
<h4>IrcNetwork.setChannels</h4>
<b>setChannels</b>(<i>channels</i>)
<p>
        Public method to set the list of channels.
</p>

<dl>

<dt><i>channels</i> (list of IrcChannel)</dt>
<dd>
list of channels for the network
</dd>
</dl>
<a NAME="IrcNetwork.setIdentityName" ID="IrcNetwork.setIdentityName"></a>
<h4>IrcNetwork.setIdentityName</h4>
<b>setIdentityName</b>(<i>name</i>)
<p>
        Public method to set the name of the identity.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
identity name
</dd>
</dl>
<a NAME="IrcNetwork.setName" ID="IrcNetwork.setName"></a>
<h4>IrcNetwork.setName</h4>
<b>setName</b>(<i>name</i>)
<p>
        Public method to set the network name.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
network name
</dd>
</dl>
<a NAME="IrcNetwork.setServer" ID="IrcNetwork.setServer"></a>
<h4>IrcNetwork.setServer</h4>
<b>setServer</b>(<i>server</i>)
<p>
        Public method to set the server.
</p>

<dl>

<dt><i>server</i> (IrcServer)</dt>
<dd>
server object to set
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="IrcNetworkManager" ID="IrcNetworkManager"></a>
<h2>IrcNetworkManager</h2>
<p>
    Class implementing the IRC identity object.
</p>

<h3>Signals</h3>
<dl>

<dt>dataChanged()</dt>
<dd>
emitted after some data has changed
</dd>
<dt>identitiesChanged()</dt>
<dd>
emitted after an identity object has changed
</dd>
<dt>networksChanged()</dt>
<dd>
emitted after a network object has changed
</dd>
</dl>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#IrcNetworkManager.__init__">IrcNetworkManager</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.__load">__load</a></td>
<td>Private slot to load the IRC data.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.__loadDefaults">__loadDefaults</a></td>
<td>Private method to load default values.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.addIdentity">addIdentity</a></td>
<td>Public method to add a new identity.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.addNetwork">addNetwork</a></td>
<td>Public method to add a network.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.close">close</a></td>
<td>Public method to close the open search engines manager.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.deleteIdentity">deleteIdentity</a></td>
<td>Public method to delete the given identity.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.deleteNetwork">deleteNetwork</a></td>
<td>Public method to delete the given network.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.getIdentities">getIdentities</a></td>
<td>Public method to get a copy of all identities.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.getIdentity">getIdentity</a></td>
<td>Public method to get an identity object.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.getIdentityNames">getIdentityNames</a></td>
<td>Public method to get the names of all identities.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.getNetwork">getNetwork</a></td>
<td>Public method to get a network object.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.getNetworkNames">getNetworkNames</a></td>
<td>Public method to get a list of all known network names.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.identityChanged">identityChanged</a></td>
<td>Public method to indicate a change of an identity object.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.networkChanged">networkChanged</a></td>
<td>Public method to indicate a change of a network object.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.renameIdentity">renameIdentity</a></td>
<td>Public method to rename an identity.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.save">save</a></td>
<td>Public slot to save the IRC data.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.setIdentities">setIdentities</a></td>
<td>Public method to set the identities.</td>
</tr>
<tr>
<td><a href="#IrcNetworkManager.setNetwork">setNetwork</a></td>
<td>Public method to set a network.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="IrcNetworkManager.__init__" ID="IrcNetworkManager.__init__"></a>
<h4>IrcNetworkManager (Constructor)</h4>
<b>IrcNetworkManager</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QObject)</dt>
<dd>
reference to the parent object
</dd>
</dl>
<a NAME="IrcNetworkManager.__load" ID="IrcNetworkManager.__load"></a>
<h4>IrcNetworkManager.__load</h4>
<b>__load</b>(<i></i>)
<p>
        Private slot to load the IRC data.
</p>

<a NAME="IrcNetworkManager.__loadDefaults" ID="IrcNetworkManager.__loadDefaults"></a>
<h4>IrcNetworkManager.__loadDefaults</h4>
<b>__loadDefaults</b>(<i>identityOnly=False</i>)
<p>
        Private method to load default values.
</p>

<dl>

<dt><i>identityOnly</i> (bool)</dt>
<dd>
flag indicating to just load the default
            identity
</dd>
</dl>
<a NAME="IrcNetworkManager.addIdentity" ID="IrcNetworkManager.addIdentity"></a>
<h4>IrcNetworkManager.addIdentity</h4>
<b>addIdentity</b>(<i>identity</i>)
<p>
        Public method to add a new identity.
</p>

<dl>

<dt><i>identity</i> (IrcIdentity)</dt>
<dd>
reference to the identity to add
</dd>
</dl>
<a NAME="IrcNetworkManager.addNetwork" ID="IrcNetworkManager.addNetwork"></a>
<h4>IrcNetworkManager.addNetwork</h4>
<b>addNetwork</b>(<i>network</i>)
<p>
        Public method to add a network.
</p>

<dl>

<dt><i>network</i> (IrcNetwork)</dt>
<dd>
network object to add
</dd>
</dl>
<a NAME="IrcNetworkManager.close" ID="IrcNetworkManager.close"></a>
<h4>IrcNetworkManager.close</h4>
<b>close</b>(<i></i>)
<p>
        Public method to close the open search engines manager.
</p>

<a NAME="IrcNetworkManager.deleteIdentity" ID="IrcNetworkManager.deleteIdentity"></a>
<h4>IrcNetworkManager.deleteIdentity</h4>
<b>deleteIdentity</b>(<i>name</i>)
<p>
        Public method to delete the given identity.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
name of the identity to delete
</dd>
</dl>
<a NAME="IrcNetworkManager.deleteNetwork" ID="IrcNetworkManager.deleteNetwork"></a>
<h4>IrcNetworkManager.deleteNetwork</h4>
<b>deleteNetwork</b>(<i>name</i>)
<p>
        Public method to delete the given network.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
name of the network to delete
</dd>
</dl>
<a NAME="IrcNetworkManager.getIdentities" ID="IrcNetworkManager.getIdentities"></a>
<h4>IrcNetworkManager.getIdentities</h4>
<b>getIdentities</b>(<i></i>)
<p>
        Public method to get a copy of all identities.
</p>

<dl>
<dt>Return:</dt>
<dd>
dictionary of all identities
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict of IrcIdentity
</dd>
</dl>
<a NAME="IrcNetworkManager.getIdentity" ID="IrcNetworkManager.getIdentity"></a>
<h4>IrcNetworkManager.getIdentity</h4>
<b>getIdentity</b>(<i>name, create=False</i>)
<p>
        Public method to get an identity object.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
name of the identity to get
</dd>
<dt><i>create</i> (bool)</dt>
<dd>
flag indicating to create a new object,
            if none exists
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the identity
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
IrcIdentity
</dd>
</dl>
<a NAME="IrcNetworkManager.getIdentityNames" ID="IrcNetworkManager.getIdentityNames"></a>
<h4>IrcNetworkManager.getIdentityNames</h4>
<b>getIdentityNames</b>(<i></i>)
<p>
        Public method to get the names of all identities.
</p>

<dl>
<dt>Return:</dt>
<dd>
names of all identities
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of string)
</dd>
</dl>
<a NAME="IrcNetworkManager.getNetwork" ID="IrcNetworkManager.getNetwork"></a>
<h4>IrcNetworkManager.getNetwork</h4>
<b>getNetwork</b>(<i>name</i>)
<p>
        Public method to get a network object.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
name of the network
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the network object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
IrcNetwork
</dd>
</dl>
<a NAME="IrcNetworkManager.getNetworkNames" ID="IrcNetworkManager.getNetworkNames"></a>
<h4>IrcNetworkManager.getNetworkNames</h4>
<b>getNetworkNames</b>(<i></i>)
<p>
        Public method to get a list of all known network names.
</p>

<dl>
<dt>Return:</dt>
<dd>
list of network names
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="IrcNetworkManager.identityChanged" ID="IrcNetworkManager.identityChanged"></a>
<h4>IrcNetworkManager.identityChanged</h4>
<b>identityChanged</b>(<i></i>)
<p>
        Public method to indicate a change of an identity object.
</p>

<a NAME="IrcNetworkManager.networkChanged" ID="IrcNetworkManager.networkChanged"></a>
<h4>IrcNetworkManager.networkChanged</h4>
<b>networkChanged</b>(<i></i>)
<p>
        Public method to indicate a change of a network object.
</p>

<a NAME="IrcNetworkManager.renameIdentity" ID="IrcNetworkManager.renameIdentity"></a>
<h4>IrcNetworkManager.renameIdentity</h4>
<b>renameIdentity</b>(<i>oldName, newName</i>)
<p>
        Public method to rename an identity.
</p>

<dl>

<dt><i>oldName</i> (str)</dt>
<dd>
old name of the identity
</dd>
<dt><i>newName</i> (str)</dt>
<dd>
new name of the identity
</dd>
</dl>
<a NAME="IrcNetworkManager.save" ID="IrcNetworkManager.save"></a>
<h4>IrcNetworkManager.save</h4>
<b>save</b>(<i></i>)
<p>
        Public slot to save the IRC data.
</p>

<a NAME="IrcNetworkManager.setIdentities" ID="IrcNetworkManager.setIdentities"></a>
<h4>IrcNetworkManager.setIdentities</h4>
<b>setIdentities</b>(<i>identities</i>)
<p>
        Public method to set the identities.
</p>

<dl>

<dt><i>identities</i> (dict of IrcIdentity)</dt>
<dd>
dictionary of all identities
</dd>
</dl>
<a NAME="IrcNetworkManager.setNetwork" ID="IrcNetworkManager.setNetwork"></a>
<h4>IrcNetworkManager.setNetwork</h4>
<b>setNetwork</b>(<i>network, networkName=""</i>)
<p>
        Public method to set a network.
</p>

<dl>

<dt><i>network</i> (IrcNetwork)</dt>
<dd>
network object to set
</dd>
<dt><i>networkName</i> (str)</dt>
<dd>
name the network was known for
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="IrcServer" ID="IrcServer"></a>
<h2>IrcServer</h2>
<p>
    Class implementing the IRC identity object.
</p>

<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
<table>
<tr><td>DefaultPort</td></tr>
<tr><td>DefaultSslPort</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#IrcServer.__init__">IrcServer</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#IrcServer.getName">getName</a></td>
<td>Public method to get the server name.</td>
</tr>
<tr>
<td><a href="#IrcServer.getPassword">getPassword</a></td>
<td>Public method to get the password.</td>
</tr>
<tr>
<td><a href="#IrcServer.getPort">getPort</a></td>
<td>Public method to get the server port number.</td>
</tr>
<tr>
<td><a href="#IrcServer.load">load</a></td>
<td>Public method to load the server data.</td>
</tr>
<tr>
<td><a href="#IrcServer.save">save</a></td>
<td>Public method to save the server data.</td>
</tr>
<tr>
<td><a href="#IrcServer.setName">setName</a></td>
<td>Public method to set the server name.</td>
</tr>
<tr>
<td><a href="#IrcServer.setPassword">setPassword</a></td>
<td>Public method to set a new password.</td>
</tr>
<tr>
<td><a href="#IrcServer.setPort">setPort</a></td>
<td>Public method to set the server port number.</td>
</tr>
<tr>
<td><a href="#IrcServer.setUseSSL">setUseSSL</a></td>
<td>Public method to set the SSL usage.</td>
</tr>
<tr>
<td><a href="#IrcServer.useSSL">useSSL</a></td>
<td>Public method to check for SSL usage.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="IrcServer.__init__" ID="IrcServer.__init__"></a>
<h4>IrcServer (Constructor)</h4>
<b>IrcServer</b>(<i>name</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
name of the server
</dd>
</dl>
<a NAME="IrcServer.getName" ID="IrcServer.getName"></a>
<h4>IrcServer.getName</h4>
<b>getName</b>(<i></i>)
<p>
        Public method to get the server name.
</p>

<dl>
<dt>Return:</dt>
<dd>
server name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcServer.getPassword" ID="IrcServer.getPassword"></a>
<h4>IrcServer.getPassword</h4>
<b>getPassword</b>(<i></i>)
<p>
        Public method to get the password.
</p>

<dl>
<dt>Return:</dt>
<dd>
password
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IrcServer.getPort" ID="IrcServer.getPort"></a>
<h4>IrcServer.getPort</h4>
<b>getPort</b>(<i></i>)
<p>
        Public method to get the server port number.
</p>

<dl>
<dt>Return:</dt>
<dd>
port number
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<a NAME="IrcServer.load" ID="IrcServer.load"></a>
<h4>IrcServer.load</h4>
<b>load</b>(<i>settings</i>)
<p>
        Public method to load the server data.
</p>

<dl>

<dt><i>settings</i> (QSettings)</dt>
<dd>
reference to the settings object
</dd>
</dl>
<a NAME="IrcServer.save" ID="IrcServer.save"></a>
<h4>IrcServer.save</h4>
<b>save</b>(<i>settings</i>)
<p>
        Public method to save the server data.
</p>

<dl>

<dt><i>settings</i> (QSettings)</dt>
<dd>
reference to the settings object
</dd>
</dl>
<a NAME="IrcServer.setName" ID="IrcServer.setName"></a>
<h4>IrcServer.setName</h4>
<b>setName</b>(<i>name</i>)
<p>
        Public method to set the server name.
</p>

<dl>

<dt><i>name</i> (str)</dt>
<dd>
server name
</dd>
</dl>
<a NAME="IrcServer.setPassword" ID="IrcServer.setPassword"></a>
<h4>IrcServer.setPassword</h4>
<b>setPassword</b>(<i>password</i>)
<p>
        Public method to set a new password.
</p>

<dl>

<dt><i>password</i> (str)</dt>
<dd>
password to set
</dd>
</dl>
<a NAME="IrcServer.setPort" ID="IrcServer.setPort"></a>
<h4>IrcServer.setPort</h4>
<b>setPort</b>(<i>port</i>)
<p>
        Public method to set the server port number.
</p>

<dl>

<dt><i>port</i> (int)</dt>
<dd>
server port number
</dd>
</dl>
<a NAME="IrcServer.setUseSSL" ID="IrcServer.setUseSSL"></a>
<h4>IrcServer.setUseSSL</h4>
<b>setUseSSL</b>(<i>on</i>)
<p>
        Public method to set the SSL usage.
</p>

<dl>

<dt><i>on</i> (bool)</dt>
<dd>
flag indicating SSL usage
</dd>
</dl>
<a NAME="IrcServer.useSSL" ID="IrcServer.useSSL"></a>
<h4>IrcServer.useSSL</h4>
<b>useSSL</b>(<i></i>)
<p>
        Public method to check for SSL usage.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating SSL usage
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>