Documentation/Source/eric5.Network.IRC.IrcChannelEditDialog.html

changeset 2266
f885a0bc2ccc
child 2367
78f6c8193d37
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Network.IRC.IrcChannelEditDialog.html	Sat Dec 15 18:20:39 2012 +0100
@@ -0,0 +1,119 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Network.IRC.IrcChannelEditDialog</title>
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Network.IRC.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></dt>
+<dd>
+channel name (string)
+</dd><dt><i>key</i></dt>
+<dd>
+channel key (string)
+</dd><dt><i>autoJoin</i></dt>
+<dd>
+flag indicating, that the channel should
+            be joined automatically (boolean)
+</dd><dt><i>edit</i></dt>
+<dd>
+flag indicating an edit of an existing
+            channel (boolean)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</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>Returns:</dt>
+<dd>
+tuple giving the channel name, channel key and a flag
+            indicating, that the channel should be joined automatically
+            (string, string, boolean)
+</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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial