ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcMessageEdit.html

changeset 3
51c2c37bde76
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcMessageEdit.html	Sun Apr 20 11:08:39 2025 +0200
@@ -0,0 +1,176 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Extension_Irc.ExtensionIrc.IrcMessageEdit</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Extension_Irc.ExtensionIrc.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>
+QLineEdit
+<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</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</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> (str)</dt>
+<dd>
+text to be added to the history
+</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> (bool)</dt>
+<dd>
+flag indicating the direction
+</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> (QKeyEvent)</dt>
+<dd>
+reference to the event
+</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> (str)</dt>
+<dd>
+text to be set
+</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>evt</i> (QWheelEvent)</dt>
+<dd>
+reference to the wheel event
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial