ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcServerEditDialog.html

changeset 3
51c2c37bde76
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcServerEditDialog.html	Sun Apr 20 11:08:39 2025 +0200
@@ -0,0 +1,139 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Extension_Irc.ExtensionIrc.IrcServerEditDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Extension_Irc.ExtensionIrc.IrcServerEditDialog</h1>
+<p>
+Module implementing a dialog for editing the IRC server configuration.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#IrcServerEditDialog">IrcServerEditDialog</a></td>
+<td>Class implementing a dialog for editing the IRC server configuration.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="IrcServerEditDialog" ID="IrcServerEditDialog"></a>
+<h2>IrcServerEditDialog</h2>
+<p>
+    Class implementing a dialog for editing the IRC server configuration.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_IrcServerEditDialog
+<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="#IrcServerEditDialog.__init__">IrcServerEditDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#IrcServerEditDialog.__updateOkButton">__updateOkButton</a></td>
+<td>Private method to update the OK button state.</td>
+</tr>
+<tr>
+<td><a href="#IrcServerEditDialog.getServer">getServer</a></td>
+<td>Public method to create a server object from the data entered into the dialog.</td>
+</tr>
+<tr>
+<td><a href="#IrcServerEditDialog.on_serverEdit_textChanged">on_serverEdit_textChanged</a></td>
+<td>Private slot handling changes of the server name.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="IrcServerEditDialog.__init__" ID="IrcServerEditDialog.__init__"></a>
+<h4>IrcServerEditDialog (Constructor)</h4>
+<b>IrcServerEditDialog</b>(<i>server, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>server</i> (IrcServer)</dt>
+<dd>
+reference to the IRC server object
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="IrcServerEditDialog.__updateOkButton" ID="IrcServerEditDialog.__updateOkButton"></a>
+<h4>IrcServerEditDialog.__updateOkButton</h4>
+<b>__updateOkButton</b>(<i></i>)
+<p>
+        Private method to update the OK button state.
+</p>
+
+<a NAME="IrcServerEditDialog.getServer" ID="IrcServerEditDialog.getServer"></a>
+<h4>IrcServerEditDialog.getServer</h4>
+<b>getServer</b>(<i></i>)
+<p>
+        Public method to create a server object from the data entered into
+        the dialog.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+server object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+IrcServer
+</dd>
+</dl>
+<a NAME="IrcServerEditDialog.on_serverEdit_textChanged" ID="IrcServerEditDialog.on_serverEdit_textChanged"></a>
+<h4>IrcServerEditDialog.on_serverEdit_textChanged</h4>
+<b>on_serverEdit_textChanged</b>(<i>_name</i>)
+<p>
+        Private slot handling changes of the server name.
+</p>
+
+<dl>
+
+<dt><i>_name</i> (str)</dt>
+<dd>
+current name of the server (unused)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial