Mercurial Repositories > IRC client / file comparison
comparison: ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcMessageEdit.html
ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcMessageEdit.html
- changeset 3
- 51c2c37bde76
equal
deleted
inserted
replaced
| 2:5b635dc8895f | 3:51c2c37bde76 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Extension_Irc.ExtensionIrc.IrcMessageEdit</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_Extension_Irc.ExtensionIrc.IrcMessageEdit</h1> | |
| 10 <p> | |
| 11 Module implementing a specialized line edit for entering IRC messages. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#IrcMessageEdit">IrcMessageEdit</a></td> | |
| 23 <td>Class implementing a specialized line edit for entering IRC messages.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 | |
| 27 <h3>Functions</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 | |
| 32 <hr /> | |
| 33 <hr /> | |
| 34 <a NAME="IrcMessageEdit" ID="IrcMessageEdit"></a> | |
| 35 <h2>IrcMessageEdit</h2> | |
| 36 <p> | |
| 37 Class implementing a specialized line edit for entering IRC messages. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Derived from</h3> | |
| 41 QLineEdit | |
| 42 <h3>Class Attributes</h3> | |
| 43 <table> | |
| 44 <tr><td>MaxHistory</td></tr> | |
| 45 </table> | |
| 46 | |
| 47 <h3>Class Methods</h3> | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 | |
| 52 <h3>Methods</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#IrcMessageEdit.__init__">IrcMessageEdit</a></td> | |
| 56 <td>Constructor</td> | |
| 57 </tr> | |
| 58 <tr> | |
| 59 <td><a href="#IrcMessageEdit.__addHistory">__addHistory</a></td> | |
| 60 <td>Private method to add an entry to the history.</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#IrcMessageEdit.__getHistory">__getHistory</a></td> | |
| 64 <td>Private method to move in the history.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#IrcMessageEdit.keyPressEvent">keyPressEvent</a></td> | |
| 68 <td>Protected method implementing special key handling.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#IrcMessageEdit.setText">setText</a></td> | |
| 72 <td>Public method to set the text.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#IrcMessageEdit.wheelEvent">wheelEvent</a></td> | |
| 76 <td>Protected slot to support wheel events.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 | |
| 80 <h3>Static Methods</h3> | |
| 81 <table> | |
| 82 <tr><td>None</td></tr> | |
| 83 </table> | |
| 84 | |
| 85 | |
| 86 <a NAME="IrcMessageEdit.__init__" ID="IrcMessageEdit.__init__"></a> | |
| 87 <h4>IrcMessageEdit (Constructor)</h4> | |
| 88 <b>IrcMessageEdit</b>(<i>parent=None</i>) | |
| 89 <p> | |
| 90 Constructor | |
| 91 </p> | |
| 92 | |
| 93 <dl> | |
| 94 | |
| 95 <dt><i>parent</i> (QWidget)</dt> | |
| 96 <dd> | |
| 97 reference to the parent widget | |
| 98 </dd> | |
| 99 </dl> | |
| 100 <a NAME="IrcMessageEdit.__addHistory" ID="IrcMessageEdit.__addHistory"></a> | |
| 101 <h4>IrcMessageEdit.__addHistory</h4> | |
| 102 <b>__addHistory</b>(<i>txt</i>) | |
| 103 <p> | |
| 104 Private method to add an entry to the history. | |
| 105 </p> | |
| 106 | |
| 107 <dl> | |
| 108 | |
| 109 <dt><i>txt</i> (str)</dt> | |
| 110 <dd> | |
| 111 text to be added to the history | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <a NAME="IrcMessageEdit.__getHistory" ID="IrcMessageEdit.__getHistory"></a> | |
| 115 <h4>IrcMessageEdit.__getHistory</h4> | |
| 116 <b>__getHistory</b>(<i>up</i>) | |
| 117 <p> | |
| 118 Private method to move in the history. | |
| 119 </p> | |
| 120 | |
| 121 <dl> | |
| 122 | |
| 123 <dt><i>up</i> (bool)</dt> | |
| 124 <dd> | |
| 125 flag indicating the direction | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <a NAME="IrcMessageEdit.keyPressEvent" ID="IrcMessageEdit.keyPressEvent"></a> | |
| 129 <h4>IrcMessageEdit.keyPressEvent</h4> | |
| 130 <b>keyPressEvent</b>(<i>evt</i>) | |
| 131 <p> | |
| 132 Protected method implementing special key handling. | |
| 133 </p> | |
| 134 | |
| 135 <dl> | |
| 136 | |
| 137 <dt><i>evt</i> (QKeyEvent)</dt> | |
| 138 <dd> | |
| 139 reference to the event | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <a NAME="IrcMessageEdit.setText" ID="IrcMessageEdit.setText"></a> | |
| 143 <h4>IrcMessageEdit.setText</h4> | |
| 144 <b>setText</b>(<i>text</i>) | |
| 145 <p> | |
| 146 Public method to set the text. | |
| 147 </p> | |
| 148 <p> | |
| 149 Note: This reimplementation ensures, that the cursor is at the end of | |
| 150 the text. | |
| 151 </p> | |
| 152 | |
| 153 <dl> | |
| 154 | |
| 155 <dt><i>text</i> (str)</dt> | |
| 156 <dd> | |
| 157 text to be set | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <a NAME="IrcMessageEdit.wheelEvent" ID="IrcMessageEdit.wheelEvent"></a> | |
| 161 <h4>IrcMessageEdit.wheelEvent</h4> | |
| 162 <b>wheelEvent</b>(<i>evt</i>) | |
| 163 <p> | |
| 164 Protected slot to support wheel events. | |
| 165 </p> | |
| 166 | |
| 167 <dl> | |
| 168 | |
| 169 <dt><i>evt</i> (QWheelEvent)</dt> | |
| 170 <dd> | |
| 171 reference to the wheel event | |
| 172 </dd> | |
| 173 </dl> | |
| 174 <div align="right"><a href="#top">Up</a></div> | |
| 175 <hr /> | |
| 176 </body></html> |
