Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.UI.LogView.html

changeset 6942
2602857055c5
parent 6573
ccac2d1f6858
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.UI.LogView</h1>
23 <p>
24 Module implementing the log viewer widget and the log widget.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#LogViewer">LogViewer</a></td>
34 <td>Class implementing the containing widget for the log viewer.</td>
35 </tr><tr>
36 <td><a href="#LogViewerEdit">LogViewerEdit</a></td>
37 <td>Class providing a specialized text edit for displaying logging information.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="LogViewer" ID="LogViewer"></a>
46 <h2>LogViewer</h2>
47 <p>
48 Class implementing the containing widget for the log viewer.
49 </p>
50 <h3>Derived from</h3>
51 QWidget
52 <h3>Class Attributes</h3>
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#LogViewer.__init__">LogViewer</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#LogViewer.appendToStderr">appendToStderr</a></td>
67 <td>Public slot to appand text to the "stderr" tab.</td>
68 </tr><tr>
69 <td><a href="#LogViewer.appendToStdout">appendToStdout</a></td>
70 <td>Public slot to appand text to the "stdout" tab.</td>
71 </tr><tr>
72 <td><a href="#LogViewer.preferencesChanged">preferencesChanged</a></td>
73 <td>Public slot to handle a change of the preferences.</td>
74 </tr><tr>
75 <td><a href="#LogViewer.showFind">showFind</a></td>
76 <td>Public method to display the search widget.</td>
77 </tr>
78 </table>
79 <h3>Static Methods</h3>
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83 <a NAME="LogViewer.__init__" ID="LogViewer.__init__"></a>
84 <h4>LogViewer (Constructor)</h4>
85 <b>LogViewer</b>(<i>ui, parent=None</i>)
86 <p>
87 Constructor
88 </p><dl>
89 <dt><i>ui</i></dt>
90 <dd>
91 reference to the main window (UserInterface)
92 </dd><dt><i>parent</i></dt>
93 <dd>
94 reference to the parent widget (QWidget)
95 </dd>
96 </dl><a NAME="LogViewer.appendToStderr" ID="LogViewer.appendToStderr"></a>
97 <h4>LogViewer.appendToStderr</h4>
98 <b>appendToStderr</b>(<i>txt</i>)
99 <p>
100 Public slot to appand text to the "stderr" tab.
101 </p><dl>
102 <dt><i>txt</i></dt>
103 <dd>
104 text to be appended (string)
105 </dd>
106 </dl><a NAME="LogViewer.appendToStdout" ID="LogViewer.appendToStdout"></a>
107 <h4>LogViewer.appendToStdout</h4>
108 <b>appendToStdout</b>(<i>txt</i>)
109 <p>
110 Public slot to appand text to the "stdout" tab.
111 </p><dl>
112 <dt><i>txt</i></dt>
113 <dd>
114 text to be appended (string)
115 </dd>
116 </dl><a NAME="LogViewer.preferencesChanged" ID="LogViewer.preferencesChanged"></a>
117 <h4>LogViewer.preferencesChanged</h4>
118 <b>preferencesChanged</b>(<i></i>)
119 <p>
120 Public slot to handle a change of the preferences.
121 </p><a NAME="LogViewer.showFind" ID="LogViewer.showFind"></a>
122 <h4>LogViewer.showFind</h4>
123 <b>showFind</b>(<i>txt=""</i>)
124 <p>
125 Public method to display the search widget.
126 </p><dl>
127 <dt><i>txt</i></dt>
128 <dd>
129 text to be shown in the combo (string)
130 </dd>
131 </dl>
132 <div align="right"><a href="#top">Up</a></div>
133 <hr /><hr />
134 <a NAME="LogViewerEdit" ID="LogViewerEdit"></a>
135 <h2>LogViewerEdit</h2>
136 <p>
137 Class providing a specialized text edit for displaying logging information.
138 </p><h3>Signals</h3>
139 <dl>
140 <dt>searchStringFound(found)</dt>
141 <dd>
142 emitted to indicate the search result
143 (boolean)
144 </dd>
145 </dl>
146 <h3>Derived from</h3>
147 QTextEdit
148 <h3>Class Attributes</h3>
149 <table>
150 <tr><td>None</td></tr>
151 </table>
152 <h3>Class Methods</h3>
153 <table>
154 <tr><td>None</td></tr>
155 </table>
156 <h3>Methods</h3>
157 <table>
158 <tr>
159 <td><a href="#LogViewerEdit.__init__">LogViewerEdit</a></td>
160 <td>Constructor</td>
161 </tr><tr>
162 <td><a href="#LogViewerEdit.__appendText">__appendText</a></td>
163 <td>Private method to append text to the end.</td>
164 </tr><tr>
165 <td><a href="#LogViewerEdit.__configure">__configure</a></td>
166 <td>Private method to open the configuration dialog.</td>
167 </tr><tr>
168 <td><a href="#LogViewerEdit.__filterMessage">__filterMessage</a></td>
169 <td>Private method to filter messages.</td>
170 </tr><tr>
171 <td><a href="#LogViewerEdit.__find">__find</a></td>
172 <td>Private slot to show the find widget.</td>
173 </tr><tr>
174 <td><a href="#LogViewerEdit.__handleShowContextMenu">__handleShowContextMenu</a></td>
175 <td>Private slot to show the context menu.</td>
176 </tr><tr>
177 <td><a href="#LogViewerEdit.appendToStderr">appendToStderr</a></td>
178 <td>Public slot to appand text to the "stderr" tab.</td>
179 </tr><tr>
180 <td><a href="#LogViewerEdit.appendToStdout">appendToStdout</a></td>
181 <td>Public slot to appand text to the "stdout" tab.</td>
182 </tr><tr>
183 <td><a href="#LogViewerEdit.keyPressEvent">keyPressEvent</a></td>
184 <td>Protected method handling key press events.</td>
185 </tr><tr>
186 <td><a href="#LogViewerEdit.preferencesChanged">preferencesChanged</a></td>
187 <td>Public slot to handle a change of the preferences.</td>
188 </tr><tr>
189 <td><a href="#LogViewerEdit.searchNext">searchNext</a></td>
190 <td>Public method to search the next occurrence of the given text.</td>
191 </tr><tr>
192 <td><a href="#LogViewerEdit.searchPrev">searchPrev</a></td>
193 <td>Public method to search the previous occurrence of the given text.</td>
194 </tr>
195 </table>
196 <h3>Static Methods</h3>
197 <table>
198 <tr><td>None</td></tr>
199 </table>
200 <a NAME="LogViewerEdit.__init__" ID="LogViewerEdit.__init__"></a>
201 <h4>LogViewerEdit (Constructor)</h4>
202 <b>LogViewerEdit</b>(<i>parent=None</i>)
203 <p>
204 Constructor
205 </p><dl>
206 <dt><i>parent</i></dt>
207 <dd>
208 reference to the parent widget (QWidget)
209 </dd>
210 </dl><a NAME="LogViewerEdit.__appendText" ID="LogViewerEdit.__appendText"></a>
211 <h4>LogViewerEdit.__appendText</h4>
212 <b>__appendText</b>(<i>txt, isErrorMessage=False</i>)
213 <p>
214 Private method to append text to the end.
215 </p><dl>
216 <dt><i>txt</i></dt>
217 <dd>
218 text to insert (string)
219 </dd><dt><i>isErrorMessage</i></dt>
220 <dd>
221 flag indicating to insert error text (boolean)
222 </dd>
223 </dl><a NAME="LogViewerEdit.__configure" ID="LogViewerEdit.__configure"></a>
224 <h4>LogViewerEdit.__configure</h4>
225 <b>__configure</b>(<i></i>)
226 <p>
227 Private method to open the configuration dialog.
228 </p><a NAME="LogViewerEdit.__filterMessage" ID="LogViewerEdit.__filterMessage"></a>
229 <h4>LogViewerEdit.__filterMessage</h4>
230 <b>__filterMessage</b>(<i>message, isErrorMessage=False</i>)
231 <p>
232 Private method to filter messages.
233 </p><dl>
234 <dt><i>message</i></dt>
235 <dd>
236 message to be checked (string)
237 </dd><dt><i>isErrorMessage</i></dt>
238 <dd>
239 flag indicating to check an error message
240 (boolean)
241 </dd>
242 </dl><dl>
243 <dt>Returns:</dt>
244 <dd>
245 flag indicating that the message should be filtered out
246 (boolean)
247 </dd>
248 </dl><a NAME="LogViewerEdit.__find" ID="LogViewerEdit.__find"></a>
249 <h4>LogViewerEdit.__find</h4>
250 <b>__find</b>(<i></i>)
251 <p>
252 Private slot to show the find widget.
253 </p><a NAME="LogViewerEdit.__handleShowContextMenu" ID="LogViewerEdit.__handleShowContextMenu"></a>
254 <h4>LogViewerEdit.__handleShowContextMenu</h4>
255 <b>__handleShowContextMenu</b>(<i>coord</i>)
256 <p>
257 Private slot to show the context menu.
258 </p><dl>
259 <dt><i>coord</i></dt>
260 <dd>
261 the position of the mouse pointer (QPoint)
262 </dd>
263 </dl><a NAME="LogViewerEdit.appendToStderr" ID="LogViewerEdit.appendToStderr"></a>
264 <h4>LogViewerEdit.appendToStderr</h4>
265 <b>appendToStderr</b>(<i>txt</i>)
266 <p>
267 Public slot to appand text to the "stderr" tab.
268 </p><dl>
269 <dt><i>txt</i></dt>
270 <dd>
271 text to be appended (string)
272 </dd>
273 </dl><dl>
274 <dt>Returns:</dt>
275 <dd>
276 flag indicating text was appended (boolean)
277 </dd>
278 </dl><a NAME="LogViewerEdit.appendToStdout" ID="LogViewerEdit.appendToStdout"></a>
279 <h4>LogViewerEdit.appendToStdout</h4>
280 <b>appendToStdout</b>(<i>txt</i>)
281 <p>
282 Public slot to appand text to the "stdout" tab.
283 </p><dl>
284 <dt><i>txt</i></dt>
285 <dd>
286 text to be appended (string)
287 </dd>
288 </dl><dl>
289 <dt>Returns:</dt>
290 <dd>
291 flag indicating text was appended (boolean)
292 </dd>
293 </dl><a NAME="LogViewerEdit.keyPressEvent" ID="LogViewerEdit.keyPressEvent"></a>
294 <h4>LogViewerEdit.keyPressEvent</h4>
295 <b>keyPressEvent</b>(<i>evt</i>)
296 <p>
297 Protected method handling key press events.
298 </p><dl>
299 <dt><i>evt</i></dt>
300 <dd>
301 key press event (QKeyEvent)
302 </dd>
303 </dl><a NAME="LogViewerEdit.preferencesChanged" ID="LogViewerEdit.preferencesChanged"></a>
304 <h4>LogViewerEdit.preferencesChanged</h4>
305 <b>preferencesChanged</b>(<i></i>)
306 <p>
307 Public slot to handle a change of the preferences.
308 </p><a NAME="LogViewerEdit.searchNext" ID="LogViewerEdit.searchNext"></a>
309 <h4>LogViewerEdit.searchNext</h4>
310 <b>searchNext</b>(<i>txt, caseSensitive, wholeWord, regexp</i>)
311 <p>
312 Public method to search the next occurrence of the given text.
313 </p><dl>
314 <dt><i>txt</i> (str)</dt>
315 <dd>
316 text to search for
317 </dd><dt><i>caseSensitive</i> (bool)</dt>
318 <dd>
319 flag indicating to perform a case sensitive
320 search
321 </dd><dt><i>wholeWord</i> (bool)</dt>
322 <dd>
323 flag indicating to search for whole words
324 only
325 </dd><dt><i>regexp</i> (bool)</dt>
326 <dd>
327 flag indicating a regular expression search
328 </dd>
329 </dl><a NAME="LogViewerEdit.searchPrev" ID="LogViewerEdit.searchPrev"></a>
330 <h4>LogViewerEdit.searchPrev</h4>
331 <b>searchPrev</b>(<i>txt, caseSensitive, wholeWord, regexp</i>)
332 <p>
333 Public method to search the previous occurrence of the given text.
334 </p><dl>
335 <dt><i>txt</i> (str)</dt>
336 <dd>
337 text to search for
338 </dd><dt><i>caseSensitive</i> (bool)</dt>
339 <dd>
340 flag indicating to perform a case sensitive
341 search
342 </dd><dt><i>wholeWord</i> (bool)</dt>
343 <dd>
344 flag indicating to search for whole words
345 only
346 </dd><dt><i>regexp</i> (bool)</dt>
347 <dd>
348 flag indicating a regular expression search
349 </dd>
350 </dl>
351 <div align="right"><a href="#top">Up</a></div>
352 <hr />
353 </body></html>

Mercurial Repository: eric

eric ide

mercurial