Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.UI.LogView.html

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

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

Mercurial Repository: eric

eric ide

mercurial