ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcChannelEditDialog.html

changeset 3
51c2c37bde76
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcChannelEditDialog.html	Sun Apr 20 11:08:39 2025 +0200
@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Extension_Irc.ExtensionIrc.IrcChannelEditDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Extension_Irc.ExtensionIrc.IrcChannelEditDialog</h1>
+<p>
+Module implementing a dialog to edit channel data.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#IrcChannelEditDialog">IrcChannelEditDialog</a></td>
+<td>Class implementing a dialog to edit channel data.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="IrcChannelEditDialog" ID="IrcChannelEditDialog"></a>
+<h2>IrcChannelEditDialog</h2>
+<p>
+    Class implementing a dialog to edit channel data.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_IrcChannelEditDialog
+<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="#IrcChannelEditDialog.__init__">IrcChannelEditDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#IrcChannelEditDialog.getData">getData</a></td>
+<td>Public method to get the channel data.</td>
+</tr>
+<tr>
+<td><a href="#IrcChannelEditDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
+<td>Private slot to handle changes of the given name.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="IrcChannelEditDialog.__init__" ID="IrcChannelEditDialog.__init__"></a>
+<h4>IrcChannelEditDialog (Constructor)</h4>
+<b>IrcChannelEditDialog</b>(<i>name, key, autoJoin, edit, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+channel name
+</dd>
+<dt><i>key</i> (str)</dt>
+<dd>
+channel key
+</dd>
+<dt><i>autoJoin</i> (bool)</dt>
+<dd>
+flag indicating, that the channel should
+            be joined automatically
+</dd>
+<dt><i>edit</i> (bool)</dt>
+<dd>
+flag indicating an edit of an existing
+            channel
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="IrcChannelEditDialog.getData" ID="IrcChannelEditDialog.getData"></a>
+<h4>IrcChannelEditDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to get the channel data.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple giving the channel name, channel key and a flag
+            indicating, that the channel should be joined automatically
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str, bool)
+</dd>
+</dl>
+<a NAME="IrcChannelEditDialog.on_nameEdit_textChanged" ID="IrcChannelEditDialog.on_nameEdit_textChanged"></a>
+<h4>IrcChannelEditDialog.on_nameEdit_textChanged</h4>
+<b>on_nameEdit_textChanged</b>(<i>txt</i>)
+<p>
+        Private slot to handle changes of the given name.
+</p>
+
+<dl>
+
+<dt><i>txt</i> (str)</dt>
+<dd>
+text of the edit
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial