--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcNetworkListDialog.html Sun Apr 20 11:08:39 2025 +0200 @@ -0,0 +1,268 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkListDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkListDialog</h1> +<p> +Module implementing a dialog to list the configured IRC networks. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#IrcNetworkListDialog">IrcNetworkListDialog</a></td> +<td>Class implementing a dialog to list the configured IRC networks.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="IrcNetworkListDialog" ID="IrcNetworkListDialog"></a> +<h2>IrcNetworkListDialog</h2> +<p> + Class implementing a dialog to list the configured IRC networks. +</p> + +<h3>Derived from</h3> +QDialog, Ui_IrcNetworkListDialog +<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="#IrcNetworkListDialog.__init__">IrcNetworkListDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.__checkButtons">__checkButtons</a></td> +<td>Private slot to set the enabled state of the buttons.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.__refreshNetworkEntry">__refreshNetworkEntry</a></td> +<td>Private method to (re-)set the data of a network entry.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.__refreshNetworksList">__refreshNetworksList</a></td> +<td>Private method to refresh the complete networks list.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.__resizeColumns">__resizeColumns</a></td> +<td>Private slot to resize all columns to their contents.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.__setAutoConnectEntry">__setAutoConnectEntry</a></td> +<td>Private method to set the auto-connect entry of a network item.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.on_autoConnectButton_clicked">on_autoConnectButton_clicked</a></td> +<td>Private slot handling the auto-connect selection.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> +<td>Private slot to delete the selected entry.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.on_editButton_clicked">on_editButton_clicked</a></td> +<td>Private slot to edit the selected network.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.on_editIdentitiesButton_clicked">on_editIdentitiesButton_clicked</a></td> +<td>Private slot to edit the identities.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.on_networksList_itemCollapsed">on_networksList_itemCollapsed</a></td> +<td>Private slot handling the collapse of a top level item.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.on_networksList_itemExpanded">on_networksList_itemExpanded</a></td> +<td>Private slot handling the expansion of a top level item.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.on_networksList_itemSelectionChanged">on_networksList_itemSelectionChanged</a></td> +<td>Private slot to handle changes of the selection of networks.</td> +</tr> +<tr> +<td><a href="#IrcNetworkListDialog.on_newButton_clicked">on_newButton_clicked</a></td> +<td>Private slot to add a new network entry.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="IrcNetworkListDialog.__init__" ID="IrcNetworkListDialog.__init__"></a> +<h4>IrcNetworkListDialog (Constructor)</h4> +<b>IrcNetworkListDialog</b>(<i>manager, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>manager</i> (IrcNetworkManager)</dt> +<dd> +reference to the IRC network manager +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="IrcNetworkListDialog.__checkButtons" ID="IrcNetworkListDialog.__checkButtons"></a> +<h4>IrcNetworkListDialog.__checkButtons</h4> +<b>__checkButtons</b>(<i></i>) +<p> + Private slot to set the enabled state of the buttons. +</p> + +<a NAME="IrcNetworkListDialog.__refreshNetworkEntry" ID="IrcNetworkListDialog.__refreshNetworkEntry"></a> +<h4>IrcNetworkListDialog.__refreshNetworkEntry</h4> +<b>__refreshNetworkEntry</b>(<i>itm</i>) +<p> + Private method to (re-)set the data of a network entry. +</p> + +<dl> + +<dt><i>itm</i> (QTreeWidgetItem)</dt> +<dd> +reference to the network entry +</dd> +</dl> +<a NAME="IrcNetworkListDialog.__refreshNetworksList" ID="IrcNetworkListDialog.__refreshNetworksList"></a> +<h4>IrcNetworkListDialog.__refreshNetworksList</h4> +<b>__refreshNetworksList</b>(<i></i>) +<p> + Private method to refresh the complete networks list. +</p> + +<a NAME="IrcNetworkListDialog.__resizeColumns" ID="IrcNetworkListDialog.__resizeColumns"></a> +<h4>IrcNetworkListDialog.__resizeColumns</h4> +<b>__resizeColumns</b>(<i></i>) +<p> + Private slot to resize all columns to their contents. +</p> + +<a NAME="IrcNetworkListDialog.__setAutoConnectEntry" ID="IrcNetworkListDialog.__setAutoConnectEntry"></a> +<h4>IrcNetworkListDialog.__setAutoConnectEntry</h4> +<b>__setAutoConnectEntry</b>(<i>itm, on</i>) +<p> + Private method to set the auto-connect entry of a network item. +</p> + +<dl> + +<dt><i>itm</i> (QTreeWidgetItem)</dt> +<dd> +reference to the network item +</dd> +<dt><i>on</i> (bool)</dt> +<dd> +flag indicating the auto-connect state +</dd> +</dl> +<a NAME="IrcNetworkListDialog.on_autoConnectButton_clicked" ID="IrcNetworkListDialog.on_autoConnectButton_clicked"></a> +<h4>IrcNetworkListDialog.on_autoConnectButton_clicked</h4> +<b>on_autoConnectButton_clicked</b>(<i>checked</i>) +<p> + Private slot handling the auto-connect selection. +</p> + +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +flag indicating the state of the button +</dd> +</dl> +<a NAME="IrcNetworkListDialog.on_deleteButton_clicked" ID="IrcNetworkListDialog.on_deleteButton_clicked"></a> +<h4>IrcNetworkListDialog.on_deleteButton_clicked</h4> +<b>on_deleteButton_clicked</b>(<i></i>) +<p> + Private slot to delete the selected entry. +</p> + +<a NAME="IrcNetworkListDialog.on_editButton_clicked" ID="IrcNetworkListDialog.on_editButton_clicked"></a> +<h4>IrcNetworkListDialog.on_editButton_clicked</h4> +<b>on_editButton_clicked</b>(<i></i>) +<p> + Private slot to edit the selected network. +</p> + +<a NAME="IrcNetworkListDialog.on_editIdentitiesButton_clicked" ID="IrcNetworkListDialog.on_editIdentitiesButton_clicked"></a> +<h4>IrcNetworkListDialog.on_editIdentitiesButton_clicked</h4> +<b>on_editIdentitiesButton_clicked</b>(<i></i>) +<p> + Private slot to edit the identities. +</p> + +<a NAME="IrcNetworkListDialog.on_networksList_itemCollapsed" ID="IrcNetworkListDialog.on_networksList_itemCollapsed"></a> +<h4>IrcNetworkListDialog.on_networksList_itemCollapsed</h4> +<b>on_networksList_itemCollapsed</b>(<i>_item</i>) +<p> + Private slot handling the collapse of a top level item. +</p> + +<dl> + +<dt><i>_item</i> (QTreeWidgetItem)</dt> +<dd> +reference to the collapsed item (unused) +</dd> +</dl> +<a NAME="IrcNetworkListDialog.on_networksList_itemExpanded" ID="IrcNetworkListDialog.on_networksList_itemExpanded"></a> +<h4>IrcNetworkListDialog.on_networksList_itemExpanded</h4> +<b>on_networksList_itemExpanded</b>(<i>_item</i>) +<p> + Private slot handling the expansion of a top level item. +</p> + +<dl> + +<dt><i>_item</i> (QTreeWidgetItem)</dt> +<dd> +reference to the expanded item (unused) +</dd> +</dl> +<a NAME="IrcNetworkListDialog.on_networksList_itemSelectionChanged" ID="IrcNetworkListDialog.on_networksList_itemSelectionChanged"></a> +<h4>IrcNetworkListDialog.on_networksList_itemSelectionChanged</h4> +<b>on_networksList_itemSelectionChanged</b>(<i></i>) +<p> + Private slot to handle changes of the selection of networks. +</p> + +<a NAME="IrcNetworkListDialog.on_newButton_clicked" ID="IrcNetworkListDialog.on_newButton_clicked"></a> +<h4>IrcNetworkListDialog.on_newButton_clicked</h4> +<b>on_newButton_clicked</b>(<i></i>) +<p> + Private slot to add a new network entry. +</p> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>