Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.UI.LogView.html
src/eric7/Documentation/Source/eric7.UI.LogView.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10433
- 328f3ec4b77a
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.UI.LogView</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>eric7.UI.LogView</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the log viewer widget and the log widget. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#LogViewer">LogViewer</a></td> | |
| 25 <td>Class implementing the containing widget for the log viewer.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#LogViewerEdit">LogViewerEdit</a></td> | |
| 29 <td>Class providing a specialized text edit for displaying logging information.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="LogViewer" ID="LogViewer"></a> | |
| 40 <h2>LogViewer</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing the containing widget for the log viewer. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 QWidget | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#LogViewer.__init__">LogViewer</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#LogViewer.appendToStderr">appendToStderr</a></td> | |
| 67 <td>Public slot to appand text to the "stderr" tab.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#LogViewer.appendToStdout">appendToStdout</a></td> | |
| 71 <td>Public slot to appand text to the "stdout" tab.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#LogViewer.preferencesChanged">preferencesChanged</a></td> | |
| 75 <td>Public slot to handle a change of the preferences.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#LogViewer.showFind">showFind</a></td> | |
| 79 <td>Public method to display the search widget.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 | |
| 84 <table> | |
| 85 <tr><td>None</td></tr> | |
| 86 </table> | |
| 87 | |
| 88 <a NAME="LogViewer.__init__" ID="LogViewer.__init__"></a> | |
| 89 <h4>LogViewer (Constructor)</h4> | |
| 90 <b>LogViewer</b>(<i>ui, parent=None</i>) | |
| 91 | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p> | |
| 95 <dl> | |
| 96 | |
| 97 <dt><i>ui</i></dt> | |
| 98 <dd> | |
| 99 reference to the main window (UserInterface) | |
| 100 </dd> | |
| 101 <dt><i>parent</i></dt> | |
| 102 <dd> | |
| 103 reference to the parent widget (QWidget) | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <a NAME="LogViewer.appendToStderr" ID="LogViewer.appendToStderr"></a> | |
| 107 <h4>LogViewer.appendToStderr</h4> | |
| 108 <b>appendToStderr</b>(<i>txt</i>) | |
| 109 | |
| 110 <p> | |
| 111 Public slot to appand text to the "stderr" tab. | |
| 112 </p> | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>txt</i></dt> | |
| 116 <dd> | |
| 117 text to be appended (string) | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="LogViewer.appendToStdout" ID="LogViewer.appendToStdout"></a> | |
| 121 <h4>LogViewer.appendToStdout</h4> | |
| 122 <b>appendToStdout</b>(<i>txt</i>) | |
| 123 | |
| 124 <p> | |
| 125 Public slot to appand text to the "stdout" tab. | |
| 126 </p> | |
| 127 <dl> | |
| 128 | |
| 129 <dt><i>txt</i></dt> | |
| 130 <dd> | |
| 131 text to be appended (string) | |
| 132 </dd> | |
| 133 </dl> | |
| 134 <a NAME="LogViewer.preferencesChanged" ID="LogViewer.preferencesChanged"></a> | |
| 135 <h4>LogViewer.preferencesChanged</h4> | |
| 136 <b>preferencesChanged</b>(<i></i>) | |
| 137 | |
| 138 <p> | |
| 139 Public slot to handle a change of the preferences. | |
| 140 </p> | |
| 141 <a NAME="LogViewer.showFind" ID="LogViewer.showFind"></a> | |
| 142 <h4>LogViewer.showFind</h4> | |
| 143 <b>showFind</b>(<i>txt=""</i>) | |
| 144 | |
| 145 <p> | |
| 146 Public method to display the search widget. | |
| 147 </p> | |
| 148 <dl> | |
| 149 | |
| 150 <dt><i>txt</i></dt> | |
| 151 <dd> | |
| 152 text to be shown in the combo (string) | |
| 153 </dd> | |
| 154 </dl> | |
| 155 <div align="right"><a href="#top">Up</a></div> | |
| 156 <hr /> | |
| 157 <hr /> | |
| 158 <a NAME="LogViewerEdit" ID="LogViewerEdit"></a> | |
| 159 <h2>LogViewerEdit</h2> | |
| 160 | |
| 161 <p> | |
| 162 Class providing a specialized text edit for displaying logging information. | |
| 163 </p> | |
| 164 <h3>Signals</h3> | |
| 165 <dl> | |
| 166 | |
| 167 <dt>searchStringFound(found)</dt> | |
| 168 <dd> | |
| 169 emitted to indicate the search result | |
| 170 (boolean) | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <h3>Derived from</h3> | |
| 174 QTextEdit | |
| 175 <h3>Class Attributes</h3> | |
| 176 | |
| 177 <table> | |
| 178 <tr><td>None</td></tr> | |
| 179 </table> | |
| 180 <h3>Class Methods</h3> | |
| 181 | |
| 182 <table> | |
| 183 <tr><td>None</td></tr> | |
| 184 </table> | |
| 185 <h3>Methods</h3> | |
| 186 | |
| 187 <table> | |
| 188 | |
| 189 <tr> | |
| 190 <td><a href="#LogViewerEdit.__init__">LogViewerEdit</a></td> | |
| 191 <td>Constructor</td> | |
| 192 </tr> | |
| 193 <tr> | |
| 194 <td><a href="#LogViewerEdit.__appendText">__appendText</a></td> | |
| 195 <td>Private method to append text to the end.</td> | |
| 196 </tr> | |
| 197 <tr> | |
| 198 <td><a href="#LogViewerEdit.__configure">__configure</a></td> | |
| 199 <td>Private method to open the configuration dialog.</td> | |
| 200 </tr> | |
| 201 <tr> | |
| 202 <td><a href="#LogViewerEdit.__filterMessage">__filterMessage</a></td> | |
| 203 <td>Private method to filter messages.</td> | |
| 204 </tr> | |
| 205 <tr> | |
| 206 <td><a href="#LogViewerEdit.__find">__find</a></td> | |
| 207 <td>Private slot to show the find widget.</td> | |
| 208 </tr> | |
| 209 <tr> | |
| 210 <td><a href="#LogViewerEdit.__handleShowContextMenu">__handleShowContextMenu</a></td> | |
| 211 <td>Private slot to show the context menu.</td> | |
| 212 </tr> | |
| 213 <tr> | |
| 214 <td><a href="#LogViewerEdit.appendToStderr">appendToStderr</a></td> | |
| 215 <td>Public slot to appand text to the "stderr" tab.</td> | |
| 216 </tr> | |
| 217 <tr> | |
| 218 <td><a href="#LogViewerEdit.appendToStdout">appendToStdout</a></td> | |
| 219 <td>Public slot to appand text to the "stdout" tab.</td> | |
| 220 </tr> | |
| 221 <tr> | |
| 222 <td><a href="#LogViewerEdit.keyPressEvent">keyPressEvent</a></td> | |
| 223 <td>Protected method handling key press events.</td> | |
| 224 </tr> | |
| 225 <tr> | |
| 226 <td><a href="#LogViewerEdit.preferencesChanged">preferencesChanged</a></td> | |
| 227 <td>Public slot to handle a change of the preferences.</td> | |
| 228 </tr> | |
| 229 <tr> | |
| 230 <td><a href="#LogViewerEdit.searchNext">searchNext</a></td> | |
| 231 <td>Public method to search the next occurrence of the given text.</td> | |
| 232 </tr> | |
| 233 <tr> | |
| 234 <td><a href="#LogViewerEdit.searchPrev">searchPrev</a></td> | |
| 235 <td>Public method to search the previous occurrence of the given text.</td> | |
| 236 </tr> | |
| 237 </table> | |
| 238 <h3>Static Methods</h3> | |
| 239 | |
| 240 <table> | |
| 241 <tr><td>None</td></tr> | |
| 242 </table> | |
| 243 | |
| 244 <a NAME="LogViewerEdit.__init__" ID="LogViewerEdit.__init__"></a> | |
| 245 <h4>LogViewerEdit (Constructor)</h4> | |
| 246 <b>LogViewerEdit</b>(<i>parent=None</i>) | |
| 247 | |
| 248 <p> | |
| 249 Constructor | |
| 250 </p> | |
| 251 <dl> | |
| 252 | |
| 253 <dt><i>parent</i></dt> | |
| 254 <dd> | |
| 255 reference to the parent widget (QWidget) | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <a NAME="LogViewerEdit.__appendText" ID="LogViewerEdit.__appendText"></a> | |
| 259 <h4>LogViewerEdit.__appendText</h4> | |
| 260 <b>__appendText</b>(<i>txt, isErrorMessage=False</i>) | |
| 261 | |
| 262 <p> | |
| 263 Private method to append text to the end. | |
| 264 </p> | |
| 265 <dl> | |
| 266 | |
| 267 <dt><i>txt</i></dt> | |
| 268 <dd> | |
| 269 text to insert (string) | |
| 270 </dd> | |
| 271 <dt><i>isErrorMessage</i></dt> | |
| 272 <dd> | |
| 273 flag indicating to insert error text (boolean) | |
| 274 </dd> | |
| 275 </dl> | |
| 276 <a NAME="LogViewerEdit.__configure" ID="LogViewerEdit.__configure"></a> | |
| 277 <h4>LogViewerEdit.__configure</h4> | |
| 278 <b>__configure</b>(<i></i>) | |
| 279 | |
| 280 <p> | |
| 281 Private method to open the configuration dialog. | |
| 282 </p> | |
| 283 <a NAME="LogViewerEdit.__filterMessage" ID="LogViewerEdit.__filterMessage"></a> | |
| 284 <h4>LogViewerEdit.__filterMessage</h4> | |
| 285 <b>__filterMessage</b>(<i>message, isErrorMessage=False</i>) | |
| 286 | |
| 287 <p> | |
| 288 Private method to filter messages. | |
| 289 </p> | |
| 290 <dl> | |
| 291 | |
| 292 <dt><i>message</i></dt> | |
| 293 <dd> | |
| 294 message to be checked (string) | |
| 295 </dd> | |
| 296 <dt><i>isErrorMessage</i></dt> | |
| 297 <dd> | |
| 298 flag indicating to check an error message | |
| 299 (boolean) | |
| 300 </dd> | |
| 301 </dl> | |
| 302 <dl> | |
| 303 <dt>Return:</dt> | |
| 304 <dd> | |
| 305 flag indicating that the message should be filtered out | |
| 306 (boolean) | |
| 307 </dd> | |
| 308 </dl> | |
| 309 <a NAME="LogViewerEdit.__find" ID="LogViewerEdit.__find"></a> | |
| 310 <h4>LogViewerEdit.__find</h4> | |
| 311 <b>__find</b>(<i></i>) | |
| 312 | |
| 313 <p> | |
| 314 Private slot to show the find widget. | |
| 315 </p> | |
| 316 <a NAME="LogViewerEdit.__handleShowContextMenu" ID="LogViewerEdit.__handleShowContextMenu"></a> | |
| 317 <h4>LogViewerEdit.__handleShowContextMenu</h4> | |
| 318 <b>__handleShowContextMenu</b>(<i>coord</i>) | |
| 319 | |
| 320 <p> | |
| 321 Private slot to show the context menu. | |
| 322 </p> | |
| 323 <dl> | |
| 324 | |
| 325 <dt><i>coord</i></dt> | |
| 326 <dd> | |
| 327 the position of the mouse pointer (QPoint) | |
| 328 </dd> | |
| 329 </dl> | |
| 330 <a NAME="LogViewerEdit.appendToStderr" ID="LogViewerEdit.appendToStderr"></a> | |
| 331 <h4>LogViewerEdit.appendToStderr</h4> | |
| 332 <b>appendToStderr</b>(<i>txt</i>) | |
| 333 | |
| 334 <p> | |
| 335 Public slot to appand text to the "stderr" tab. | |
| 336 </p> | |
| 337 <dl> | |
| 338 | |
| 339 <dt><i>txt</i></dt> | |
| 340 <dd> | |
| 341 text to be appended (string) | |
| 342 </dd> | |
| 343 </dl> | |
| 344 <dl> | |
| 345 <dt>Return:</dt> | |
| 346 <dd> | |
| 347 flag indicating text was appended (boolean) | |
| 348 </dd> | |
| 349 </dl> | |
| 350 <a NAME="LogViewerEdit.appendToStdout" ID="LogViewerEdit.appendToStdout"></a> | |
| 351 <h4>LogViewerEdit.appendToStdout</h4> | |
| 352 <b>appendToStdout</b>(<i>txt</i>) | |
| 353 | |
| 354 <p> | |
| 355 Public slot to appand text to the "stdout" tab. | |
| 356 </p> | |
| 357 <dl> | |
| 358 | |
| 359 <dt><i>txt</i></dt> | |
| 360 <dd> | |
| 361 text to be appended (string) | |
| 362 </dd> | |
| 363 </dl> | |
| 364 <dl> | |
| 365 <dt>Return:</dt> | |
| 366 <dd> | |
| 367 flag indicating text was appended (boolean) | |
| 368 </dd> | |
| 369 </dl> | |
| 370 <a NAME="LogViewerEdit.keyPressEvent" ID="LogViewerEdit.keyPressEvent"></a> | |
| 371 <h4>LogViewerEdit.keyPressEvent</h4> | |
| 372 <b>keyPressEvent</b>(<i>evt</i>) | |
| 373 | |
| 374 <p> | |
| 375 Protected method handling key press events. | |
| 376 </p> | |
| 377 <dl> | |
| 378 | |
| 379 <dt><i>evt</i></dt> | |
| 380 <dd> | |
| 381 key press event (QKeyEvent) | |
| 382 </dd> | |
| 383 </dl> | |
| 384 <a NAME="LogViewerEdit.preferencesChanged" ID="LogViewerEdit.preferencesChanged"></a> | |
| 385 <h4>LogViewerEdit.preferencesChanged</h4> | |
| 386 <b>preferencesChanged</b>(<i></i>) | |
| 387 | |
| 388 <p> | |
| 389 Public slot to handle a change of the preferences. | |
| 390 </p> | |
| 391 <a NAME="LogViewerEdit.searchNext" ID="LogViewerEdit.searchNext"></a> | |
| 392 <h4>LogViewerEdit.searchNext</h4> | |
| 393 <b>searchNext</b>(<i>txt, caseSensitive, wholeWord, regexp</i>) | |
| 394 | |
| 395 <p> | |
| 396 Public method to search the next occurrence of the given text. | |
| 397 </p> | |
| 398 <dl> | |
| 399 | |
| 400 <dt><i>txt</i> (str)</dt> | |
| 401 <dd> | |
| 402 text to search for | |
| 403 </dd> | |
| 404 <dt><i>caseSensitive</i> (bool)</dt> | |
| 405 <dd> | |
| 406 flag indicating to perform a case sensitive | |
| 407 search | |
| 408 </dd> | |
| 409 <dt><i>wholeWord</i> (bool)</dt> | |
| 410 <dd> | |
| 411 flag indicating to search for whole words | |
| 412 only | |
| 413 </dd> | |
| 414 <dt><i>regexp</i> (bool)</dt> | |
| 415 <dd> | |
| 416 flag indicating a regular expression search | |
| 417 </dd> | |
| 418 </dl> | |
| 419 <a NAME="LogViewerEdit.searchPrev" ID="LogViewerEdit.searchPrev"></a> | |
| 420 <h4>LogViewerEdit.searchPrev</h4> | |
| 421 <b>searchPrev</b>(<i>txt, caseSensitive, wholeWord, regexp</i>) | |
| 422 | |
| 423 <p> | |
| 424 Public method to search the previous occurrence of the given text. | |
| 425 </p> | |
| 426 <dl> | |
| 427 | |
| 428 <dt><i>txt</i> (str)</dt> | |
| 429 <dd> | |
| 430 text to search for | |
| 431 </dd> | |
| 432 <dt><i>caseSensitive</i> (bool)</dt> | |
| 433 <dd> | |
| 434 flag indicating to perform a case sensitive | |
| 435 search | |
| 436 </dd> | |
| 437 <dt><i>wholeWord</i> (bool)</dt> | |
| 438 <dd> | |
| 439 flag indicating to search for whole words | |
| 440 only | |
| 441 </dd> | |
| 442 <dt><i>regexp</i> (bool)</dt> | |
| 443 <dd> | |
| 444 flag indicating a regular expression search | |
| 445 </dd> | |
| 446 </dl> | |
| 447 <div align="right"><a href="#top">Up</a></div> | |
| 448 <hr /> | |
| 449 </body></html> |
