diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.Network.IRC.IrcNetworkManager.html
--- a/src/eric7/Documentation/Source/eric7.Network.IRC.IrcNetworkManager.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Network.IRC.IrcNetworkManager.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Network.IRC.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>
@@ -41,35 +39,34 @@
<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>
@@ -103,19 +100,20 @@
<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>
@@ -126,10 +124,10 @@
<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>
@@ -146,10 +144,10 @@
<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>
@@ -165,10 +163,10 @@
<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>
@@ -184,10 +182,10 @@
<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>
@@ -198,10 +196,10 @@
<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>
@@ -212,10 +210,10 @@
<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>
@@ -227,10 +225,10 @@
<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>
@@ -243,30 +241,31 @@
<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>
+<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>
@@ -360,19 +359,20 @@
<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>
@@ -388,10 +388,10 @@
<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>
@@ -402,10 +402,10 @@
<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>
@@ -421,10 +421,10 @@
<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>
@@ -440,10 +440,10 @@
<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>
@@ -459,10 +459,10 @@
<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>
@@ -478,10 +478,10 @@
<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>
@@ -497,10 +497,10 @@
<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>
@@ -516,10 +516,10 @@
<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>
@@ -535,10 +535,10 @@
<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>
@@ -554,11 +554,11 @@
<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>
@@ -574,10 +574,10 @@
<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>
@@ -588,11 +588,11 @@
<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>
@@ -608,10 +608,10 @@
<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>
@@ -622,10 +622,10 @@
<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>
@@ -636,10 +636,10 @@
<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>
@@ -650,10 +650,10 @@
<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>
@@ -664,10 +664,10 @@
<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>
@@ -678,10 +678,10 @@
<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>
@@ -692,10 +692,10 @@
<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>
@@ -706,10 +706,10 @@
<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>
@@ -720,10 +720,10 @@
<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>
@@ -734,10 +734,10 @@
<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>
@@ -748,11 +748,11 @@
<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>
@@ -765,30 +765,27 @@
<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>
@@ -866,19 +863,20 @@
<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>
@@ -901,10 +899,10 @@
<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>
@@ -915,10 +913,10 @@
<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>
@@ -929,11 +927,11 @@
<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>
@@ -949,10 +947,10 @@
<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>
@@ -963,10 +961,10 @@
<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>
@@ -989,10 +987,10 @@
<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>
@@ -1008,10 +1006,10 @@
<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>
@@ -1027,10 +1025,10 @@
<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>
@@ -1046,10 +1044,10 @@
<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>
@@ -1065,10 +1063,10 @@
<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>
@@ -1084,10 +1082,10 @@
<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>
@@ -1103,10 +1101,10 @@
<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>
@@ -1117,10 +1115,10 @@
<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>
@@ -1131,10 +1129,10 @@
<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>
@@ -1145,10 +1143,10 @@
<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>
@@ -1159,10 +1157,10 @@
<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>
@@ -1173,10 +1171,10 @@
<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>
@@ -1187,10 +1185,10 @@
<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>
@@ -1201,10 +1199,10 @@
<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>
@@ -1217,10 +1215,10 @@
<hr />
<a NAME="IrcNetworkManager" ID="IrcNetworkManager"></a>
<h2>IrcNetworkManager</h2>
-
<p>
Class implementing the IRC identity object.
</p>
+
<h3>Signals</h3>
<dl>
@@ -1240,19 +1238,17 @@
<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>
@@ -1330,19 +1326,20 @@
<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>
@@ -1353,17 +1350,17 @@
<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>
@@ -1375,10 +1372,10 @@
<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>
@@ -1389,10 +1386,10 @@
<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>
@@ -1403,17 +1400,17 @@
<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>
@@ -1424,10 +1421,10 @@
<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>
@@ -1438,10 +1435,10 @@
<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>
@@ -1457,10 +1454,10 @@
<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>
@@ -1488,10 +1485,10 @@
<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>
@@ -1507,10 +1504,10 @@
<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>
@@ -1533,10 +1530,10 @@
<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>
@@ -1552,24 +1549,24 @@
<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>
@@ -1584,17 +1581,17 @@
<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>
@@ -1605,10 +1602,10 @@
<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>
@@ -1625,26 +1622,25 @@
<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>
-<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>
@@ -1690,19 +1686,20 @@
<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>
@@ -1713,10 +1710,10 @@
<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>
@@ -1732,10 +1729,10 @@
<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>
@@ -1751,10 +1748,10 @@
<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>
@@ -1770,10 +1767,10 @@
<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>
@@ -1784,10 +1781,10 @@
<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>
@@ -1798,10 +1795,10 @@
<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>
@@ -1812,10 +1809,10 @@
<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>
@@ -1826,10 +1823,10 @@
<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>
@@ -1840,10 +1837,10 @@
<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>
@@ -1854,10 +1851,10 @@
<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>
@@ -1872,4 +1869,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
