Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Network.IRC.IrcMessageEdit.html
eric6/Documentation/Source/eric6.Network.IRC.IrcMessageEdit.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7900
- 72b88fb20261
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Network.IRC.IrcMessageEdit</h1> | 23 <h1>eric6.Network.IRC.IrcMessageEdit</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a specialized line edit for entering IRC messages. | 26 Module implementing a specialized line edit for entering IRC messages. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#IrcMessageEdit">IrcMessageEdit</a></td> | 38 <td><a href="#IrcMessageEdit">IrcMessageEdit</a></td> |
| 34 <td>Class implementing a specialized line edit for entering IRC messages.</td> | 39 <td>Class implementing a specialized line edit for entering IRC messages.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 39 <tr><td>None</td></tr> | 44 <table> |
| 40 </table> | 45 <tr><td>None</td></tr> |
| 41 <hr /><hr /> | 46 </table> |
| 47 <hr /> | |
| 48 <hr /> | |
| 42 <a NAME="IrcMessageEdit" ID="IrcMessageEdit"></a> | 49 <a NAME="IrcMessageEdit" ID="IrcMessageEdit"></a> |
| 43 <h2>IrcMessageEdit</h2> | 50 <h2>IrcMessageEdit</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a specialized line edit for entering IRC messages. | 53 Class implementing a specialized line edit for entering IRC messages. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 E5ClearableLineEdit | 56 E5ClearableLineEdit |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>MaxHistory</td></tr> | 60 <tr><td>MaxHistory</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 58 <table> | 68 |
| 69 <table> | |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#IrcMessageEdit.__init__">IrcMessageEdit</a></td> | 72 <td><a href="#IrcMessageEdit.__init__">IrcMessageEdit</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#IrcMessageEdit.__addHistory">__addHistory</a></td> | 76 <td><a href="#IrcMessageEdit.__addHistory">__addHistory</a></td> |
| 64 <td>Private method to add an entry to the history.</td> | 77 <td>Private method to add an entry to the history.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#IrcMessageEdit.__getHistory">__getHistory</a></td> | 80 <td><a href="#IrcMessageEdit.__getHistory">__getHistory</a></td> |
| 67 <td>Private method to move in the history.</td> | 81 <td>Private method to move in the history.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#IrcMessageEdit.keyPressEvent">keyPressEvent</a></td> | 84 <td><a href="#IrcMessageEdit.keyPressEvent">keyPressEvent</a></td> |
| 70 <td>Protected method implementing special key handling.</td> | 85 <td>Protected method implementing special key handling.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#IrcMessageEdit.setText">setText</a></td> | 88 <td><a href="#IrcMessageEdit.setText">setText</a></td> |
| 73 <td>Public method to set the text.</td> | 89 <td>Public method to set the text.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#IrcMessageEdit.wheelEvent">wheelEvent</a></td> | 92 <td><a href="#IrcMessageEdit.wheelEvent">wheelEvent</a></td> |
| 76 <td>Protected slot to support wheel events.</td> | 93 <td>Protected slot to support wheel events.</td> |
| 77 </tr> | 94 </tr> |
| 78 </table> | 95 </table> |
| 79 <h3>Static Methods</h3> | 96 <h3>Static Methods</h3> |
| 80 <table> | 97 |
| 81 <tr><td>None</td></tr> | 98 <table> |
| 82 </table> | 99 <tr><td>None</td></tr> |
| 100 </table> | |
| 101 | |
| 83 <a NAME="IrcMessageEdit.__init__" ID="IrcMessageEdit.__init__"></a> | 102 <a NAME="IrcMessageEdit.__init__" ID="IrcMessageEdit.__init__"></a> |
| 84 <h4>IrcMessageEdit (Constructor)</h4> | 103 <h4>IrcMessageEdit (Constructor)</h4> |
| 85 <b>IrcMessageEdit</b>(<i>parent=None, inactiveText="", side=E5LineEdit.RightSide</i>) | 104 <b>IrcMessageEdit</b>(<i>parent=None, inactiveText="", side=E5LineEdit.RightSide</i>) |
| 105 | |
| 86 <p> | 106 <p> |
| 87 Constructor | 107 Constructor |
| 88 </p><dl> | 108 </p> |
| 109 <dl> | |
| 110 | |
| 89 <dt><i>parent</i></dt> | 111 <dt><i>parent</i></dt> |
| 90 <dd> | 112 <dd> |
| 91 reference to the parent widget (QWidget) | 113 reference to the parent widget (QWidget) |
| 92 </dd><dt><i>inactiveText=</i></dt> | 114 </dd> |
| 115 <dt><i>inactiveText=</i></dt> | |
| 93 <dd> | 116 <dd> |
| 94 text to be shown on inactivity (string) | 117 text to be shown on inactivity (string) |
| 95 </dd><dt><i>side=</i></dt> | 118 </dd> |
| 119 <dt><i>side=</i></dt> | |
| 96 <dd> | 120 <dd> |
| 97 side the clear button should be shown at | 121 side the clear button should be shown at |
| 98 (E5LineEdit.RightSide, E5LineEdit.LeftSide) | 122 (E5LineEdit.RightSide, E5LineEdit.LeftSide) |
| 99 </dd> | 123 </dd> |
| 100 </dl><a NAME="IrcMessageEdit.__addHistory" ID="IrcMessageEdit.__addHistory"></a> | 124 </dl> |
| 125 <a NAME="IrcMessageEdit.__addHistory" ID="IrcMessageEdit.__addHistory"></a> | |
| 101 <h4>IrcMessageEdit.__addHistory</h4> | 126 <h4>IrcMessageEdit.__addHistory</h4> |
| 102 <b>__addHistory</b>(<i>txt</i>) | 127 <b>__addHistory</b>(<i>txt</i>) |
| 128 | |
| 103 <p> | 129 <p> |
| 104 Private method to add an entry to the history. | 130 Private method to add an entry to the history. |
| 105 </p><dl> | 131 </p> |
| 132 <dl> | |
| 133 | |
| 106 <dt><i>txt</i></dt> | 134 <dt><i>txt</i></dt> |
| 107 <dd> | 135 <dd> |
| 108 text to be added to the history (string) | 136 text to be added to the history (string) |
| 109 </dd> | 137 </dd> |
| 110 </dl><a NAME="IrcMessageEdit.__getHistory" ID="IrcMessageEdit.__getHistory"></a> | 138 </dl> |
| 139 <a NAME="IrcMessageEdit.__getHistory" ID="IrcMessageEdit.__getHistory"></a> | |
| 111 <h4>IrcMessageEdit.__getHistory</h4> | 140 <h4>IrcMessageEdit.__getHistory</h4> |
| 112 <b>__getHistory</b>(<i>up</i>) | 141 <b>__getHistory</b>(<i>up</i>) |
| 142 | |
| 113 <p> | 143 <p> |
| 114 Private method to move in the history. | 144 Private method to move in the history. |
| 115 </p><dl> | 145 </p> |
| 146 <dl> | |
| 147 | |
| 116 <dt><i>up</i></dt> | 148 <dt><i>up</i></dt> |
| 117 <dd> | 149 <dd> |
| 118 flag indicating the direction (boolean) | 150 flag indicating the direction (boolean) |
| 119 </dd> | 151 </dd> |
| 120 </dl><a NAME="IrcMessageEdit.keyPressEvent" ID="IrcMessageEdit.keyPressEvent"></a> | 152 </dl> |
| 153 <a NAME="IrcMessageEdit.keyPressEvent" ID="IrcMessageEdit.keyPressEvent"></a> | |
| 121 <h4>IrcMessageEdit.keyPressEvent</h4> | 154 <h4>IrcMessageEdit.keyPressEvent</h4> |
| 122 <b>keyPressEvent</b>(<i>evt</i>) | 155 <b>keyPressEvent</b>(<i>evt</i>) |
| 156 | |
| 123 <p> | 157 <p> |
| 124 Protected method implementing special key handling. | 158 Protected method implementing special key handling. |
| 125 </p><dl> | 159 </p> |
| 160 <dl> | |
| 161 | |
| 126 <dt><i>evt</i></dt> | 162 <dt><i>evt</i></dt> |
| 127 <dd> | 163 <dd> |
| 128 reference to the event (QKeyEvent) | 164 reference to the event (QKeyEvent) |
| 129 </dd> | 165 </dd> |
| 130 </dl><a NAME="IrcMessageEdit.setText" ID="IrcMessageEdit.setText"></a> | 166 </dl> |
| 167 <a NAME="IrcMessageEdit.setText" ID="IrcMessageEdit.setText"></a> | |
| 131 <h4>IrcMessageEdit.setText</h4> | 168 <h4>IrcMessageEdit.setText</h4> |
| 132 <b>setText</b>(<i>text</i>) | 169 <b>setText</b>(<i>text</i>) |
| 170 | |
| 133 <p> | 171 <p> |
| 134 Public method to set the text. | 172 Public method to set the text. |
| 135 </p><p> | 173 </p> |
| 174 <p> | |
| 136 Note: This reimplementation ensures, that the cursor is at the end of | 175 Note: This reimplementation ensures, that the cursor is at the end of |
| 137 the text. | 176 the text. |
| 138 </p><dl> | 177 </p> |
| 178 <dl> | |
| 179 | |
| 139 <dt><i>text</i></dt> | 180 <dt><i>text</i></dt> |
| 140 <dd> | 181 <dd> |
| 141 text to be set (string) | 182 text to be set (string) |
| 142 </dd> | 183 </dd> |
| 143 </dl><a NAME="IrcMessageEdit.wheelEvent" ID="IrcMessageEdit.wheelEvent"></a> | 184 </dl> |
| 185 <a NAME="IrcMessageEdit.wheelEvent" ID="IrcMessageEdit.wheelEvent"></a> | |
| 144 <h4>IrcMessageEdit.wheelEvent</h4> | 186 <h4>IrcMessageEdit.wheelEvent</h4> |
| 145 <b>wheelEvent</b>(<i>evt</i>) | 187 <b>wheelEvent</b>(<i>evt</i>) |
| 188 | |
| 146 <p> | 189 <p> |
| 147 Protected slot to support wheel events. | 190 Protected slot to support wheel events. |
| 148 </p><dl> | 191 </p> |
| 192 <dl> | |
| 193 | |
| 149 <dt><i>evt</i></dt> | 194 <dt><i>evt</i></dt> |
| 150 <dd> | 195 <dd> |
| 151 reference to the wheel event (QWheelEvent) | 196 reference to the wheel event (QWheelEvent) |
| 152 </dd> | 197 </dd> |
| 153 </dl> | 198 </dl> |
