src/eric7/Documentation/Source/eric7.UI.LogView.html

branch
eric7
changeset 10479
856476537696
parent 10433
328f3ec4b77a
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.UI.LogView</h1> 9 <h1>eric7.UI.LogView</h1>
10
11 <p> 10 <p>
12 Module implementing the log viewer widget and the log widget. 11 Module implementing the log viewer widget and the log widget.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#LogViewer">LogViewer</a></td> 22 <td><a href="#LogViewer">LogViewer</a></td>
25 <td>Class implementing the containing widget for the log viewer.</td> 23 <td>Class implementing the containing widget for the log viewer.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#LogViewerEdit">LogViewerEdit</a></td> 26 <td><a href="#LogViewerEdit">LogViewerEdit</a></td>
29 <td>Class providing a specialized text edit for displaying logging information.</td> 27 <td>Class providing a specialized text edit for displaying logging information.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33 32 <table>
34 <table> 33 <tr><td>None</td></tr>
35 <tr><td>None</td></tr> 34 </table>
36 </table> 35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="LogViewer" ID="LogViewer"></a> 38 <a NAME="LogViewer" ID="LogViewer"></a>
40 <h2>LogViewer</h2> 39 <h2>LogViewer</h2>
41
42 <p> 40 <p>
43 Class implementing the containing widget for the log viewer. 41 Class implementing the containing widget for the log viewer.
44 </p> 42 </p>
43
45 <h3>Derived from</h3> 44 <h3>Derived from</h3>
46 QWidget 45 QWidget
47 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
48 47 <table>
49 <table> 48 <tr><td>None</td></tr>
50 <tr><td>None</td></tr> 49 </table>
51 </table> 50
52 <h3>Class Methods</h3> 51 <h3>Class Methods</h3>
53 52 <table>
54 <table> 53 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 54 </table>
56 </table> 55
57 <h3>Methods</h3> 56 <h3>Methods</h3>
58 57 <table>
59 <table>
60
61 <tr> 58 <tr>
62 <td><a href="#LogViewer.__init__">LogViewer</a></td> 59 <td><a href="#LogViewer.__init__">LogViewer</a></td>
63 <td>Constructor</td> 60 <td>Constructor</td>
64 </tr> 61 </tr>
65 <tr> 62 <tr>
77 <tr> 74 <tr>
78 <td><a href="#LogViewer.showFind">showFind</a></td> 75 <td><a href="#LogViewer.showFind">showFind</a></td>
79 <td>Public method to display the search widget.</td> 76 <td>Public method to display the search widget.</td>
80 </tr> 77 </tr>
81 </table> 78 </table>
79
82 <h3>Static Methods</h3> 80 <h3>Static Methods</h3>
83 81 <table>
84 <table> 82 <tr><td>None</td></tr>
85 <tr><td>None</td></tr> 83 </table>
86 </table> 84
87 85
88 <a NAME="LogViewer.__init__" ID="LogViewer.__init__"></a> 86 <a NAME="LogViewer.__init__" ID="LogViewer.__init__"></a>
89 <h4>LogViewer (Constructor)</h4> 87 <h4>LogViewer (Constructor)</h4>
90 <b>LogViewer</b>(<i>ui, parent=None</i>) 88 <b>LogViewer</b>(<i>ui, parent=None</i>)
91
92 <p> 89 <p>
93 Constructor 90 Constructor
94 </p> 91 </p>
92
95 <dl> 93 <dl>
96 94
97 <dt><i>ui</i> (UserInterface)</dt> 95 <dt><i>ui</i> (UserInterface)</dt>
98 <dd> 96 <dd>
99 reference to the main window 97 reference to the main window
104 </dd> 102 </dd>
105 </dl> 103 </dl>
106 <a NAME="LogViewer.appendToStderr" ID="LogViewer.appendToStderr"></a> 104 <a NAME="LogViewer.appendToStderr" ID="LogViewer.appendToStderr"></a>
107 <h4>LogViewer.appendToStderr</h4> 105 <h4>LogViewer.appendToStderr</h4>
108 <b>appendToStderr</b>(<i>txt</i>) 106 <b>appendToStderr</b>(<i>txt</i>)
109
110 <p> 107 <p>
111 Public slot to appand text to the "stderr" tab. 108 Public slot to appand text to the "stderr" tab.
112 </p> 109 </p>
110
113 <dl> 111 <dl>
114 112
115 <dt><i>txt</i> (str)</dt> 113 <dt><i>txt</i> (str)</dt>
116 <dd> 114 <dd>
117 text to be appended 115 text to be appended
118 </dd> 116 </dd>
119 </dl> 117 </dl>
120 <a NAME="LogViewer.appendToStdout" ID="LogViewer.appendToStdout"></a> 118 <a NAME="LogViewer.appendToStdout" ID="LogViewer.appendToStdout"></a>
121 <h4>LogViewer.appendToStdout</h4> 119 <h4>LogViewer.appendToStdout</h4>
122 <b>appendToStdout</b>(<i>txt</i>) 120 <b>appendToStdout</b>(<i>txt</i>)
123
124 <p> 121 <p>
125 Public slot to appand text to the "stdout" tab. 122 Public slot to appand text to the "stdout" tab.
126 </p> 123 </p>
124
127 <dl> 125 <dl>
128 126
129 <dt><i>txt</i> (str)</dt> 127 <dt><i>txt</i> (str)</dt>
130 <dd> 128 <dd>
131 text to be appended 129 text to be appended
132 </dd> 130 </dd>
133 </dl> 131 </dl>
134 <a NAME="LogViewer.preferencesChanged" ID="LogViewer.preferencesChanged"></a> 132 <a NAME="LogViewer.preferencesChanged" ID="LogViewer.preferencesChanged"></a>
135 <h4>LogViewer.preferencesChanged</h4> 133 <h4>LogViewer.preferencesChanged</h4>
136 <b>preferencesChanged</b>(<i></i>) 134 <b>preferencesChanged</b>(<i></i>)
137
138 <p> 135 <p>
139 Public slot to handle a change of the preferences. 136 Public slot to handle a change of the preferences.
140 </p> 137 </p>
138
141 <a NAME="LogViewer.showFind" ID="LogViewer.showFind"></a> 139 <a NAME="LogViewer.showFind" ID="LogViewer.showFind"></a>
142 <h4>LogViewer.showFind</h4> 140 <h4>LogViewer.showFind</h4>
143 <b>showFind</b>(<i>txt=""</i>) 141 <b>showFind</b>(<i>txt=""</i>)
144
145 <p> 142 <p>
146 Public method to display the search widget. 143 Public method to display the search widget.
147 </p> 144 </p>
145
148 <dl> 146 <dl>
149 147
150 <dt><i>txt</i> (str)</dt> 148 <dt><i>txt</i> (str)</dt>
151 <dd> 149 <dd>
152 text to be shown in the combo 150 text to be shown in the combo
155 <div align="right"><a href="#top">Up</a></div> 153 <div align="right"><a href="#top">Up</a></div>
156 <hr /> 154 <hr />
157 <hr /> 155 <hr />
158 <a NAME="LogViewerEdit" ID="LogViewerEdit"></a> 156 <a NAME="LogViewerEdit" ID="LogViewerEdit"></a>
159 <h2>LogViewerEdit</h2> 157 <h2>LogViewerEdit</h2>
160
161 <p> 158 <p>
162 Class providing a specialized text edit for displaying logging information. 159 Class providing a specialized text edit for displaying logging information.
163 </p> 160 </p>
161
164 <h3>Signals</h3> 162 <h3>Signals</h3>
165 <dl> 163 <dl>
166 164
167 <dt>searchStringFound(found)</dt> 165 <dt>searchStringFound(found)</dt>
168 <dd> 166 <dd>
171 </dd> 169 </dd>
172 </dl> 170 </dl>
173 <h3>Derived from</h3> 171 <h3>Derived from</h3>
174 QTextEdit 172 QTextEdit
175 <h3>Class Attributes</h3> 173 <h3>Class Attributes</h3>
176 174 <table>
177 <table> 175 <tr><td>None</td></tr>
178 <tr><td>None</td></tr> 176 </table>
179 </table> 177
180 <h3>Class Methods</h3> 178 <h3>Class Methods</h3>
181 179 <table>
182 <table> 180 <tr><td>None</td></tr>
183 <tr><td>None</td></tr> 181 </table>
184 </table> 182
185 <h3>Methods</h3> 183 <h3>Methods</h3>
186 184 <table>
187 <table>
188
189 <tr> 185 <tr>
190 <td><a href="#LogViewerEdit.__init__">LogViewerEdit</a></td> 186 <td><a href="#LogViewerEdit.__init__">LogViewerEdit</a></td>
191 <td>Constructor</td> 187 <td>Constructor</td>
192 </tr> 188 </tr>
193 <tr> 189 <tr>
233 <tr> 229 <tr>
234 <td><a href="#LogViewerEdit.searchPrev">searchPrev</a></td> 230 <td><a href="#LogViewerEdit.searchPrev">searchPrev</a></td>
235 <td>Public method to search the previous occurrence of the given text.</td> 231 <td>Public method to search the previous occurrence of the given text.</td>
236 </tr> 232 </tr>
237 </table> 233 </table>
234
238 <h3>Static Methods</h3> 235 <h3>Static Methods</h3>
239 236 <table>
240 <table> 237 <tr><td>None</td></tr>
241 <tr><td>None</td></tr> 238 </table>
242 </table> 239
243 240
244 <a NAME="LogViewerEdit.__init__" ID="LogViewerEdit.__init__"></a> 241 <a NAME="LogViewerEdit.__init__" ID="LogViewerEdit.__init__"></a>
245 <h4>LogViewerEdit (Constructor)</h4> 242 <h4>LogViewerEdit (Constructor)</h4>
246 <b>LogViewerEdit</b>(<i>parent=None</i>) 243 <b>LogViewerEdit</b>(<i>parent=None</i>)
247
248 <p> 244 <p>
249 Constructor 245 Constructor
250 </p> 246 </p>
247
251 <dl> 248 <dl>
252 249
253 <dt><i>parent</i> (QWidget)</dt> 250 <dt><i>parent</i> (QWidget)</dt>
254 <dd> 251 <dd>
255 reference to the parent widget 252 reference to the parent widget
256 </dd> 253 </dd>
257 </dl> 254 </dl>
258 <a NAME="LogViewerEdit.__appendText" ID="LogViewerEdit.__appendText"></a> 255 <a NAME="LogViewerEdit.__appendText" ID="LogViewerEdit.__appendText"></a>
259 <h4>LogViewerEdit.__appendText</h4> 256 <h4>LogViewerEdit.__appendText</h4>
260 <b>__appendText</b>(<i>txt, isErrorMessage=False</i>) 257 <b>__appendText</b>(<i>txt, isErrorMessage=False</i>)
261
262 <p> 258 <p>
263 Private method to append text to the end. 259 Private method to append text to the end.
264 </p> 260 </p>
261
265 <dl> 262 <dl>
266 263
267 <dt><i>txt</i> (str)</dt> 264 <dt><i>txt</i> (str)</dt>
268 <dd> 265 <dd>
269 text to insert 266 text to insert
274 </dd> 271 </dd>
275 </dl> 272 </dl>
276 <a NAME="LogViewerEdit.__configure" ID="LogViewerEdit.__configure"></a> 273 <a NAME="LogViewerEdit.__configure" ID="LogViewerEdit.__configure"></a>
277 <h4>LogViewerEdit.__configure</h4> 274 <h4>LogViewerEdit.__configure</h4>
278 <b>__configure</b>(<i></i>) 275 <b>__configure</b>(<i></i>)
279
280 <p> 276 <p>
281 Private method to open the configuration dialog. 277 Private method to open the configuration dialog.
282 </p> 278 </p>
279
283 <a NAME="LogViewerEdit.__filterMessage" ID="LogViewerEdit.__filterMessage"></a> 280 <a NAME="LogViewerEdit.__filterMessage" ID="LogViewerEdit.__filterMessage"></a>
284 <h4>LogViewerEdit.__filterMessage</h4> 281 <h4>LogViewerEdit.__filterMessage</h4>
285 <b>__filterMessage</b>(<i>message, isErrorMessage=False</i>) 282 <b>__filterMessage</b>(<i>message, isErrorMessage=False</i>)
286
287 <p> 283 <p>
288 Private method to filter messages. 284 Private method to filter messages.
289 </p> 285 </p>
286
290 <dl> 287 <dl>
291 288
292 <dt><i>message</i> (str)</dt> 289 <dt><i>message</i> (str)</dt>
293 <dd> 290 <dd>
294 message to be checked 291 message to be checked
311 </dd> 308 </dd>
312 </dl> 309 </dl>
313 <a NAME="LogViewerEdit.__find" ID="LogViewerEdit.__find"></a> 310 <a NAME="LogViewerEdit.__find" ID="LogViewerEdit.__find"></a>
314 <h4>LogViewerEdit.__find</h4> 311 <h4>LogViewerEdit.__find</h4>
315 <b>__find</b>(<i></i>) 312 <b>__find</b>(<i></i>)
316
317 <p> 313 <p>
318 Private slot to show the find widget. 314 Private slot to show the find widget.
319 </p> 315 </p>
316
320 <a NAME="LogViewerEdit.__handleShowContextMenu" ID="LogViewerEdit.__handleShowContextMenu"></a> 317 <a NAME="LogViewerEdit.__handleShowContextMenu" ID="LogViewerEdit.__handleShowContextMenu"></a>
321 <h4>LogViewerEdit.__handleShowContextMenu</h4> 318 <h4>LogViewerEdit.__handleShowContextMenu</h4>
322 <b>__handleShowContextMenu</b>(<i>coord</i>) 319 <b>__handleShowContextMenu</b>(<i>coord</i>)
323
324 <p> 320 <p>
325 Private slot to show the context menu. 321 Private slot to show the context menu.
326 </p> 322 </p>
323
327 <dl> 324 <dl>
328 325
329 <dt><i>coord</i> (QPoint)</dt> 326 <dt><i>coord</i> (QPoint)</dt>
330 <dd> 327 <dd>
331 the position of the mouse pointer 328 the position of the mouse pointer
332 </dd> 329 </dd>
333 </dl> 330 </dl>
334 <a NAME="LogViewerEdit.appendToStderr" ID="LogViewerEdit.appendToStderr"></a> 331 <a NAME="LogViewerEdit.appendToStderr" ID="LogViewerEdit.appendToStderr"></a>
335 <h4>LogViewerEdit.appendToStderr</h4> 332 <h4>LogViewerEdit.appendToStderr</h4>
336 <b>appendToStderr</b>(<i>txt</i>) 333 <b>appendToStderr</b>(<i>txt</i>)
337
338 <p> 334 <p>
339 Public slot to append text to the "stderr" tab. 335 Public slot to append text to the "stderr" tab.
340 </p> 336 </p>
337
341 <dl> 338 <dl>
342 339
343 <dt><i>txt</i> (str)</dt> 340 <dt><i>txt</i> (str)</dt>
344 <dd> 341 <dd>
345 text to be appended 342 text to be appended
358 </dd> 355 </dd>
359 </dl> 356 </dl>
360 <a NAME="LogViewerEdit.appendToStdout" ID="LogViewerEdit.appendToStdout"></a> 357 <a NAME="LogViewerEdit.appendToStdout" ID="LogViewerEdit.appendToStdout"></a>
361 <h4>LogViewerEdit.appendToStdout</h4> 358 <h4>LogViewerEdit.appendToStdout</h4>
362 <b>appendToStdout</b>(<i>txt</i>) 359 <b>appendToStdout</b>(<i>txt</i>)
363
364 <p> 360 <p>
365 Public slot to append text to the "stdout" tab. 361 Public slot to append text to the "stdout" tab.
366 </p> 362 </p>
363
367 <dl> 364 <dl>
368 365
369 <dt><i>txt</i> (str)</dt> 366 <dt><i>txt</i> (str)</dt>
370 <dd> 367 <dd>
371 text to be appended 368 text to be appended
384 </dd> 381 </dd>
385 </dl> 382 </dl>
386 <a NAME="LogViewerEdit.keyPressEvent" ID="LogViewerEdit.keyPressEvent"></a> 383 <a NAME="LogViewerEdit.keyPressEvent" ID="LogViewerEdit.keyPressEvent"></a>
387 <h4>LogViewerEdit.keyPressEvent</h4> 384 <h4>LogViewerEdit.keyPressEvent</h4>
388 <b>keyPressEvent</b>(<i>evt</i>) 385 <b>keyPressEvent</b>(<i>evt</i>)
389
390 <p> 386 <p>
391 Protected method handling key press events. 387 Protected method handling key press events.
392 </p> 388 </p>
389
393 <dl> 390 <dl>
394 391
395 <dt><i>evt</i> (QKeyEvent)</dt> 392 <dt><i>evt</i> (QKeyEvent)</dt>
396 <dd> 393 <dd>
397 key press event 394 key press event
398 </dd> 395 </dd>
399 </dl> 396 </dl>
400 <a NAME="LogViewerEdit.preferencesChanged" ID="LogViewerEdit.preferencesChanged"></a> 397 <a NAME="LogViewerEdit.preferencesChanged" ID="LogViewerEdit.preferencesChanged"></a>
401 <h4>LogViewerEdit.preferencesChanged</h4> 398 <h4>LogViewerEdit.preferencesChanged</h4>
402 <b>preferencesChanged</b>(<i></i>) 399 <b>preferencesChanged</b>(<i></i>)
403
404 <p> 400 <p>
405 Public slot to handle a change of the preferences. 401 Public slot to handle a change of the preferences.
406 </p> 402 </p>
403
407 <a NAME="LogViewerEdit.searchNext" ID="LogViewerEdit.searchNext"></a> 404 <a NAME="LogViewerEdit.searchNext" ID="LogViewerEdit.searchNext"></a>
408 <h4>LogViewerEdit.searchNext</h4> 405 <h4>LogViewerEdit.searchNext</h4>
409 <b>searchNext</b>(<i>txt, caseSensitive, wholeWord, regexp</i>) 406 <b>searchNext</b>(<i>txt, caseSensitive, wholeWord, regexp</i>)
410
411 <p> 407 <p>
412 Public method to search the next occurrence of the given text. 408 Public method to search the next occurrence of the given text.
413 </p> 409 </p>
410
414 <dl> 411 <dl>
415 412
416 <dt><i>txt</i> (str)</dt> 413 <dt><i>txt</i> (str)</dt>
417 <dd> 414 <dd>
418 text to search for 415 text to search for
431 </dd> 428 </dd>
432 </dl> 429 </dl>
433 <a NAME="LogViewerEdit.searchPrev" ID="LogViewerEdit.searchPrev"></a> 430 <a NAME="LogViewerEdit.searchPrev" ID="LogViewerEdit.searchPrev"></a>
434 <h4>LogViewerEdit.searchPrev</h4> 431 <h4>LogViewerEdit.searchPrev</h4>
435 <b>searchPrev</b>(<i>txt, caseSensitive, wholeWord, regexp</i>) 432 <b>searchPrev</b>(<i>txt, caseSensitive, wholeWord, regexp</i>)
436
437 <p> 433 <p>
438 Public method to search the previous occurrence of the given text. 434 Public method to search the previous occurrence of the given text.
439 </p> 435 </p>
436
440 <dl> 437 <dl>
441 438
442 <dt><i>txt</i> (str)</dt> 439 <dt><i>txt</i> (str)</dt>
443 <dd> 440 <dd>
444 text to search for 441 text to search for

eric ide

mercurial