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

changeset 2266
f885a0bc2ccc
child 2367
78f6c8193d37
diff -r 72e6f479987b -r f885a0bc2ccc Documentation/Source/eric5.Network.IRC.IrcMessageEdit.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Network.IRC.IrcMessageEdit.html	Sat Dec 15 18:20:39 2012 +0100
@@ -0,0 +1,156 @@
+<?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.IrcMessageEdit</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.IrcMessageEdit</h1>
+<p>
+Module implementing a specialized line edit for entering IRC messages.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#IrcMessageEdit">IrcMessageEdit</a></td>
+<td>Class implementing a specialized line edit for entering IRC messages.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="IrcMessageEdit" ID="IrcMessageEdit"></a>
+<h2>IrcMessageEdit</h2>
+<p>
+    Class implementing a specialized line edit for entering IRC messages.
+</p>
+<h3>Derived from</h3>
+E5ClearableLineEdit
+<h3>Class Attributes</h3>
+<table>
+<tr><td>MaxHistory</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#IrcMessageEdit.__init__">IrcMessageEdit</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#IrcMessageEdit.__addHistory">__addHistory</a></td>
+<td>Private method to add an entry to the history.</td>
+</tr><tr>
+<td><a href="#IrcMessageEdit.__getHistory">__getHistory</a></td>
+<td>Private method to move in the history.</td>
+</tr><tr>
+<td><a href="#IrcMessageEdit.keyPressEvent">keyPressEvent</a></td>
+<td>Protected method implementing special key handling.</td>
+</tr><tr>
+<td><a href="#IrcMessageEdit.setText">setText</a></td>
+<td>Public method to set the text.</td>
+</tr><tr>
+<td><a href="#IrcMessageEdit.wheelEvent">wheelEvent</a></td>
+<td>Protected slot to support wheel events.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="IrcMessageEdit.__init__" ID="IrcMessageEdit.__init__"></a>
+<h4>IrcMessageEdit (Constructor)</h4>
+<b>IrcMessageEdit</b>(<i>parent=None, inactiveText="", side=E5LineEdit.RightSide</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd><dt><i>inactiveText=</i></dt>
+<dd>
+text to be shown on inactivity (string)
+</dd><dt><i>side=</i></dt>
+<dd>
+side the clear button should be shown at (E5LineEdit.RightSide,
+            E5LineEdit.LeftSide)
+</dd>
+</dl><a NAME="IrcMessageEdit.__addHistory" ID="IrcMessageEdit.__addHistory"></a>
+<h4>IrcMessageEdit.__addHistory</h4>
+<b>__addHistory</b>(<i>txt</i>)
+<p>
+        Private method to add an entry to the history.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+text to be added to the history (string)
+</dd>
+</dl><a NAME="IrcMessageEdit.__getHistory" ID="IrcMessageEdit.__getHistory"></a>
+<h4>IrcMessageEdit.__getHistory</h4>
+<b>__getHistory</b>(<i>up</i>)
+<p>
+        Private method to move in the history.
+</p><dl>
+<dt><i>up</i></dt>
+<dd>
+flag indicating the direction (boolean)
+</dd>
+</dl><a NAME="IrcMessageEdit.keyPressEvent" ID="IrcMessageEdit.keyPressEvent"></a>
+<h4>IrcMessageEdit.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>evt</i>)
+<p>
+        Protected method implementing special key handling.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+reference to the event (QKeyEvent)
+</dd>
+</dl><a NAME="IrcMessageEdit.setText" ID="IrcMessageEdit.setText"></a>
+<h4>IrcMessageEdit.setText</h4>
+<b>setText</b>(<i>text</i>)
+<p>
+        Public method to set the text.
+</p><p>
+        Note: This reimplementation ensures, that the cursor is at the end of the text.
+</p><dl>
+<dt><i>text</i></dt>
+<dd>
+text to be set (string)
+</dd>
+</dl><a NAME="IrcMessageEdit.wheelEvent" ID="IrcMessageEdit.wheelEvent"></a>
+<h4>IrcMessageEdit.wheelEvent</h4>
+<b>wheelEvent</b>(<i>evt</i>)
+<p>
+        Protected slot to support wheel events.
+</p><dl>
+<dt><i>reference</i></dt>
+<dd>
+to the wheel event (QWheelEvent)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial