ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcNetworkEditDialog.html

changeset 3
51c2c37bde76
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcNetworkEditDialog.html	Sun Apr 20 11:08:39 2025 +0200
@@ -0,0 +1,302 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkEditDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkEditDialog</h1>
+<p>
+Module implementing a dialog for editing IRC network definitions.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#IrcNetworkEditDialog">IrcNetworkEditDialog</a></td>
+<td>Class implementing a dialog for editing IRC network definitions.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="IrcNetworkEditDialog" ID="IrcNetworkEditDialog"></a>
+<h2>IrcNetworkEditDialog</h2>
+<p>
+    Class implementing a dialog for editing IRC network definitions.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_IrcNetworkEditDialog
+<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="#IrcNetworkEditDialog.__init__">IrcNetworkEditDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.__editChannel">__editChannel</a></td>
+<td>Private method to edit a channel.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.__refreshIdentityCombo">__refreshIdentityCombo</a></td>
+<td>Private method to refresh the identity combo.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.__updateOkButton">__updateOkButton</a></td>
+<td>Private method to update the OK button state.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.getNetwork">getNetwork</a></td>
+<td>Public method to get the network object.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_addChannelButton_clicked">on_addChannelButton_clicked</a></td>
+<td>Private slot to add a channel.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_channelList_itemActivated">on_channelList_itemActivated</a></td>
+<td>Private slot to handle the activation of a channel entry.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_channelList_itemSelectionChanged">on_channelList_itemSelectionChanged</a></td>
+<td>Private slot to handle changes of the selection of channels.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_deleteChannelButton_clicked">on_deleteChannelButton_clicked</a></td>
+<td>Private slot to delete the selected channel.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_editChannelButton_clicked">on_editChannelButton_clicked</a></td>
+<td>Private slot to edit the selected channel.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_editIdentitiesButton_clicked">on_editIdentitiesButton_clicked</a></td>
+<td>Private slot to edit the identities.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_editServerButton_clicked">on_editServerButton_clicked</a></td>
+<td>Private slot to edit the server configuration.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_identityCombo_currentTextChanged">on_identityCombo_currentTextChanged</a></td>
+<td>Private slot to handle the selection of an identity.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_networkEdit_textChanged">on_networkEdit_textChanged</a></td>
+<td>Private slot to handle changes of the network name.</td>
+</tr>
+<tr>
+<td><a href="#IrcNetworkEditDialog.on_serverEdit_textChanged">on_serverEdit_textChanged</a></td>
+<td>Private slot to handle changes of the server name.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="IrcNetworkEditDialog.__init__" ID="IrcNetworkEditDialog.__init__"></a>
+<h4>IrcNetworkEditDialog (Constructor)</h4>
+<b>IrcNetworkEditDialog</b>(<i>manager, networkName, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>manager</i> (IrcNetworkManager)</dt>
+<dd>
+reference to the IRC network manager object
+</dd>
+<dt><i>networkName</i> (str)</dt>
+<dd>
+name of the network to work on
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="IrcNetworkEditDialog.__editChannel" ID="IrcNetworkEditDialog.__editChannel"></a>
+<h4>IrcNetworkEditDialog.__editChannel</h4>
+<b>__editChannel</b>(<i>itm</i>)
+<p>
+        Private method to edit a channel.
+</p>
+
+<dl>
+
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the item to be edited
+</dd>
+</dl>
+<a NAME="IrcNetworkEditDialog.__refreshIdentityCombo" ID="IrcNetworkEditDialog.__refreshIdentityCombo"></a>
+<h4>IrcNetworkEditDialog.__refreshIdentityCombo</h4>
+<b>__refreshIdentityCombo</b>(<i>currentIdentity</i>)
+<p>
+        Private method to refresh the identity combo.
+</p>
+
+<dl>
+
+<dt><i>currentIdentity</i> (str)</dt>
+<dd>
+name of the identity to select
+</dd>
+</dl>
+<a NAME="IrcNetworkEditDialog.__updateOkButton" ID="IrcNetworkEditDialog.__updateOkButton"></a>
+<h4>IrcNetworkEditDialog.__updateOkButton</h4>
+<b>__updateOkButton</b>(<i></i>)
+<p>
+        Private method to update the OK button state.
+</p>
+
+<a NAME="IrcNetworkEditDialog.getNetwork" ID="IrcNetworkEditDialog.getNetwork"></a>
+<h4>IrcNetworkEditDialog.getNetwork</h4>
+<b>getNetwork</b>(<i></i>)
+<p>
+        Public method to get the network object.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+edited network object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+IrcNetwork
+</dd>
+</dl>
+<a NAME="IrcNetworkEditDialog.on_addChannelButton_clicked" ID="IrcNetworkEditDialog.on_addChannelButton_clicked"></a>
+<h4>IrcNetworkEditDialog.on_addChannelButton_clicked</h4>
+<b>on_addChannelButton_clicked</b>(<i></i>)
+<p>
+        Private slot to add a channel.
+</p>
+
+<a NAME="IrcNetworkEditDialog.on_channelList_itemActivated" ID="IrcNetworkEditDialog.on_channelList_itemActivated"></a>
+<h4>IrcNetworkEditDialog.on_channelList_itemActivated</h4>
+<b>on_channelList_itemActivated</b>(<i>item, _column</i>)
+<p>
+        Private slot to handle the activation of a channel entry.
+</p>
+
+<dl>
+
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the activated item
+</dd>
+<dt><i>_column</i> (int)</dt>
+<dd>
+column the activation occurred in (unused)
+</dd>
+</dl>
+<a NAME="IrcNetworkEditDialog.on_channelList_itemSelectionChanged" ID="IrcNetworkEditDialog.on_channelList_itemSelectionChanged"></a>
+<h4>IrcNetworkEditDialog.on_channelList_itemSelectionChanged</h4>
+<b>on_channelList_itemSelectionChanged</b>(<i></i>)
+<p>
+        Private slot to handle changes of the selection of channels.
+</p>
+
+<a NAME="IrcNetworkEditDialog.on_deleteChannelButton_clicked" ID="IrcNetworkEditDialog.on_deleteChannelButton_clicked"></a>
+<h4>IrcNetworkEditDialog.on_deleteChannelButton_clicked</h4>
+<b>on_deleteChannelButton_clicked</b>(<i></i>)
+<p>
+        Private slot to delete the selected channel.
+</p>
+
+<a NAME="IrcNetworkEditDialog.on_editChannelButton_clicked" ID="IrcNetworkEditDialog.on_editChannelButton_clicked"></a>
+<h4>IrcNetworkEditDialog.on_editChannelButton_clicked</h4>
+<b>on_editChannelButton_clicked</b>(<i></i>)
+<p>
+        Private slot to edit the selected channel.
+</p>
+
+<a NAME="IrcNetworkEditDialog.on_editIdentitiesButton_clicked" ID="IrcNetworkEditDialog.on_editIdentitiesButton_clicked"></a>
+<h4>IrcNetworkEditDialog.on_editIdentitiesButton_clicked</h4>
+<b>on_editIdentitiesButton_clicked</b>(<i></i>)
+<p>
+        Private slot to edit the identities.
+</p>
+
+<a NAME="IrcNetworkEditDialog.on_editServerButton_clicked" ID="IrcNetworkEditDialog.on_editServerButton_clicked"></a>
+<h4>IrcNetworkEditDialog.on_editServerButton_clicked</h4>
+<b>on_editServerButton_clicked</b>(<i></i>)
+<p>
+        Private slot to edit the server configuration.
+</p>
+
+<a NAME="IrcNetworkEditDialog.on_identityCombo_currentTextChanged" ID="IrcNetworkEditDialog.on_identityCombo_currentTextChanged"></a>
+<h4>IrcNetworkEditDialog.on_identityCombo_currentTextChanged</h4>
+<b>on_identityCombo_currentTextChanged</b>(<i>identity</i>)
+<p>
+        Private slot to handle the selection of an identity.
+</p>
+
+<dl>
+
+<dt><i>identity</i> (str)</dt>
+<dd>
+selected identity
+</dd>
+</dl>
+<a NAME="IrcNetworkEditDialog.on_networkEdit_textChanged" ID="IrcNetworkEditDialog.on_networkEdit_textChanged"></a>
+<h4>IrcNetworkEditDialog.on_networkEdit_textChanged</h4>
+<b>on_networkEdit_textChanged</b>(<i>_txt</i>)
+<p>
+        Private slot to handle changes of the network name.
+</p>
+
+<dl>
+
+<dt><i>_txt</i> (str)</dt>
+<dd>
+text entered into the network name edit (unused)
+</dd>
+</dl>
+<a NAME="IrcNetworkEditDialog.on_serverEdit_textChanged" ID="IrcNetworkEditDialog.on_serverEdit_textChanged"></a>
+<h4>IrcNetworkEditDialog.on_serverEdit_textChanged</h4>
+<b>on_serverEdit_textChanged</b>(<i>_txt</i>)
+<p>
+        Private slot to handle changes of the server name.
+</p>
+
+<dl>
+
+<dt><i>_txt</i> (str)</dt>
+<dd>
+text entered into the server name edit (unused)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial