Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Network.IRC.IrcMessageEdit.html
Documentation/Source/eric5.Network.IRC.IrcMessageEdit.html
- changeset 2266
- f885a0bc2ccc
- child 2367
- 78f6c8193d37
equal
deleted
inserted
replaced
| 2265:72e6f479987b | 2266:f885a0bc2ccc |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Network.IRC.IrcMessageEdit</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Network.IRC.IrcMessageEdit</h1> | |
| 24 <p> | |
| 25 Module implementing a specialized line edit for entering IRC messages. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#IrcMessageEdit">IrcMessageEdit</a></td> | |
| 35 <td>Class implementing a specialized line edit for entering IRC messages.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="IrcMessageEdit" ID="IrcMessageEdit"></a> | |
| 44 <h2>IrcMessageEdit</h2> | |
| 45 <p> | |
| 46 Class implementing a specialized line edit for entering IRC messages. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 E5ClearableLineEdit | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>MaxHistory</td></tr> | |
| 53 </table> | |
| 54 <h3>Class Methods</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 <table> | |
| 60 <tr> | |
| 61 <td><a href="#IrcMessageEdit.__init__">IrcMessageEdit</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#IrcMessageEdit.__addHistory">__addHistory</a></td> | |
| 65 <td>Private method to add an entry to the history.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#IrcMessageEdit.__getHistory">__getHistory</a></td> | |
| 68 <td>Private method to move in the history.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#IrcMessageEdit.keyPressEvent">keyPressEvent</a></td> | |
| 71 <td>Protected method implementing special key handling.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#IrcMessageEdit.setText">setText</a></td> | |
| 74 <td>Public method to set the text.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#IrcMessageEdit.wheelEvent">wheelEvent</a></td> | |
| 77 <td>Protected slot to support wheel events.</td> | |
| 78 </tr> | |
| 79 </table> | |
| 80 <h3>Static Methods</h3> | |
| 81 <table> | |
| 82 <tr><td>None</td></tr> | |
| 83 </table> | |
| 84 <a NAME="IrcMessageEdit.__init__" ID="IrcMessageEdit.__init__"></a> | |
| 85 <h4>IrcMessageEdit (Constructor)</h4> | |
| 86 <b>IrcMessageEdit</b>(<i>parent=None, inactiveText="", side=E5LineEdit.RightSide</i>) | |
| 87 <p> | |
| 88 Constructor | |
| 89 </p><dl> | |
| 90 <dt><i>parent</i></dt> | |
| 91 <dd> | |
| 92 reference to the parent widget (QWidget) | |
| 93 </dd><dt><i>inactiveText=</i></dt> | |
| 94 <dd> | |
| 95 text to be shown on inactivity (string) | |
| 96 </dd><dt><i>side=</i></dt> | |
| 97 <dd> | |
| 98 side the clear button should be shown at (E5LineEdit.RightSide, | |
| 99 E5LineEdit.LeftSide) | |
| 100 </dd> | |
| 101 </dl><a NAME="IrcMessageEdit.__addHistory" ID="IrcMessageEdit.__addHistory"></a> | |
| 102 <h4>IrcMessageEdit.__addHistory</h4> | |
| 103 <b>__addHistory</b>(<i>txt</i>) | |
| 104 <p> | |
| 105 Private method to add an entry to the history. | |
| 106 </p><dl> | |
| 107 <dt><i>txt</i></dt> | |
| 108 <dd> | |
| 109 text to be added to the history (string) | |
| 110 </dd> | |
| 111 </dl><a NAME="IrcMessageEdit.__getHistory" ID="IrcMessageEdit.__getHistory"></a> | |
| 112 <h4>IrcMessageEdit.__getHistory</h4> | |
| 113 <b>__getHistory</b>(<i>up</i>) | |
| 114 <p> | |
| 115 Private method to move in the history. | |
| 116 </p><dl> | |
| 117 <dt><i>up</i></dt> | |
| 118 <dd> | |
| 119 flag indicating the direction (boolean) | |
| 120 </dd> | |
| 121 </dl><a NAME="IrcMessageEdit.keyPressEvent" ID="IrcMessageEdit.keyPressEvent"></a> | |
| 122 <h4>IrcMessageEdit.keyPressEvent</h4> | |
| 123 <b>keyPressEvent</b>(<i>evt</i>) | |
| 124 <p> | |
| 125 Protected method implementing special key handling. | |
| 126 </p><dl> | |
| 127 <dt><i>evt</i></dt> | |
| 128 <dd> | |
| 129 reference to the event (QKeyEvent) | |
| 130 </dd> | |
| 131 </dl><a NAME="IrcMessageEdit.setText" ID="IrcMessageEdit.setText"></a> | |
| 132 <h4>IrcMessageEdit.setText</h4> | |
| 133 <b>setText</b>(<i>text</i>) | |
| 134 <p> | |
| 135 Public method to set the text. | |
| 136 </p><p> | |
| 137 Note: This reimplementation ensures, that the cursor is at the end of the text. | |
| 138 </p><dl> | |
| 139 <dt><i>text</i></dt> | |
| 140 <dd> | |
| 141 text to be set (string) | |
| 142 </dd> | |
| 143 </dl><a NAME="IrcMessageEdit.wheelEvent" ID="IrcMessageEdit.wheelEvent"></a> | |
| 144 <h4>IrcMessageEdit.wheelEvent</h4> | |
| 145 <b>wheelEvent</b>(<i>evt</i>) | |
| 146 <p> | |
| 147 Protected slot to support wheel events. | |
| 148 </p><dl> | |
| 149 <dt><i>reference</i></dt> | |
| 150 <dd> | |
| 151 to the wheel event (QWheelEvent) | |
| 152 </dd> | |
| 153 </dl> | |
| 154 <div align="right"><a href="#top">Up</a></div> | |
| 155 <hr /> | |
| 156 </body></html> |
