Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.UI.LogView.html

changeset 3673
e26d7d0c1088
child 4087
414a6fefc1f0
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
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>parent=None</i>)
86 <p>
87 Constructor
88 </p><dl>
89 <dt><i>parent</i></dt>
90 <dd>
91 reference to the parent widget (QWidget)
92 </dd>
93 </dl><a NAME="LogViewer.appendToStderr" ID="LogViewer.appendToStderr"></a>
94 <h4>LogViewer.appendToStderr</h4>
95 <b>appendToStderr</b>(<i>txt</i>)
96 <p>
97 Public slot to appand text to the "stderr" tab.
98 </p><dl>
99 <dt><i>txt</i></dt>
100 <dd>
101 text to be appended (string)
102 </dd>
103 </dl><a NAME="LogViewer.appendToStdout" ID="LogViewer.appendToStdout"></a>
104 <h4>LogViewer.appendToStdout</h4>
105 <b>appendToStdout</b>(<i>txt</i>)
106 <p>
107 Public slot to appand text to the "stdout" tab.
108 </p><dl>
109 <dt><i>txt</i></dt>
110 <dd>
111 text to be appended (string)
112 </dd>
113 </dl><a NAME="LogViewer.preferencesChanged" ID="LogViewer.preferencesChanged"></a>
114 <h4>LogViewer.preferencesChanged</h4>
115 <b>preferencesChanged</b>(<i></i>)
116 <p>
117 Public slot to handle a change of the preferences.
118 </p><a NAME="LogViewer.showFind" ID="LogViewer.showFind"></a>
119 <h4>LogViewer.showFind</h4>
120 <b>showFind</b>(<i>txt=""</i>)
121 <p>
122 Public method to display the search widget.
123 </p><dl>
124 <dt><i>txt</i></dt>
125 <dd>
126 text to be shown in the combo (string)
127 </dd>
128 </dl>
129 <div align="right"><a href="#top">Up</a></div>
130 <hr /><hr />
131 <a NAME="LogViewerEdit" ID="LogViewerEdit"></a>
132 <h2>LogViewerEdit</h2>
133 <p>
134 Class providing a specialized text edit for displaying logging information.
135 </p><h3>Signals</h3>
136 <dl>
137 <dt>searchStringFound(found)</dt>
138 <dd>
139 emitted to indicate the search result
140 (boolean)
141 </dd>
142 </dl>
143 <h3>Derived from</h3>
144 QTextEdit
145 <h3>Class Attributes</h3>
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149 <h3>Class Methods</h3>
150 <table>
151 <tr><td>None</td></tr>
152 </table>
153 <h3>Methods</h3>
154 <table>
155 <tr>
156 <td><a href="#LogViewerEdit.__init__">LogViewerEdit</a></td>
157 <td>Constructor</td>
158 </tr><tr>
159 <td><a href="#LogViewerEdit.__appendText">__appendText</a></td>
160 <td>Private method to append text to the end.</td>
161 </tr><tr>
162 <td><a href="#LogViewerEdit.__configure">__configure</a></td>
163 <td>Private method to open the configuration dialog.</td>
164 </tr><tr>
165 <td><a href="#LogViewerEdit.__find">__find</a></td>
166 <td>Private slot to show the find widget.</td>
167 </tr><tr>
168 <td><a href="#LogViewerEdit.__handleShowContextMenu">__handleShowContextMenu</a></td>
169 <td>Private slot to show the context menu.</td>
170 </tr><tr>
171 <td><a href="#LogViewerEdit.appendToStderr">appendToStderr</a></td>
172 <td>Public slot to appand text to the "stderr" tab.</td>
173 </tr><tr>
174 <td><a href="#LogViewerEdit.appendToStdout">appendToStdout</a></td>
175 <td>Public slot to appand text to the "stdout" tab.</td>
176 </tr><tr>
177 <td><a href="#LogViewerEdit.keyPressEvent">keyPressEvent</a></td>
178 <td>Protected method handling key press events.</td>
179 </tr><tr>
180 <td><a href="#LogViewerEdit.preferencesChanged">preferencesChanged</a></td>
181 <td>Public slot to handle a change of the preferences.</td>
182 </tr><tr>
183 <td><a href="#LogViewerEdit.searchNext">searchNext</a></td>
184 <td>Public method to search the next occurrence of the given text.</td>
185 </tr><tr>
186 <td><a href="#LogViewerEdit.searchPrev">searchPrev</a></td>
187 <td>Public method to search the previous occurrence of the given text.</td>
188 </tr>
189 </table>
190 <h3>Static Methods</h3>
191 <table>
192 <tr><td>None</td></tr>
193 </table>
194 <a NAME="LogViewerEdit.__init__" ID="LogViewerEdit.__init__"></a>
195 <h4>LogViewerEdit (Constructor)</h4>
196 <b>LogViewerEdit</b>(<i>parent=None</i>)
197 <p>
198 Constructor
199 </p><dl>
200 <dt><i>parent</i></dt>
201 <dd>
202 reference to the parent widget (QWidget)
203 </dd>
204 </dl><a NAME="LogViewerEdit.__appendText" ID="LogViewerEdit.__appendText"></a>
205 <h4>LogViewerEdit.__appendText</h4>
206 <b>__appendText</b>(<i>txt, error=False</i>)
207 <p>
208 Private method to append text to the end.
209 </p><dl>
210 <dt><i>txt</i></dt>
211 <dd>
212 text to insert (string)
213 </dd><dt><i>error</i></dt>
214 <dd>
215 flag indicating to insert error text (boolean)
216 </dd>
217 </dl><a NAME="LogViewerEdit.__configure" ID="LogViewerEdit.__configure"></a>
218 <h4>LogViewerEdit.__configure</h4>
219 <b>__configure</b>(<i></i>)
220 <p>
221 Private method to open the configuration dialog.
222 </p><a NAME="LogViewerEdit.__find" ID="LogViewerEdit.__find"></a>
223 <h4>LogViewerEdit.__find</h4>
224 <b>__find</b>(<i></i>)
225 <p>
226 Private slot to show the find widget.
227 </p><a NAME="LogViewerEdit.__handleShowContextMenu" ID="LogViewerEdit.__handleShowContextMenu"></a>
228 <h4>LogViewerEdit.__handleShowContextMenu</h4>
229 <b>__handleShowContextMenu</b>(<i>coord</i>)
230 <p>
231 Private slot to show the context menu.
232 </p><dl>
233 <dt><i>coord</i></dt>
234 <dd>
235 the position of the mouse pointer (QPoint)
236 </dd>
237 </dl><a NAME="LogViewerEdit.appendToStderr" ID="LogViewerEdit.appendToStderr"></a>
238 <h4>LogViewerEdit.appendToStderr</h4>
239 <b>appendToStderr</b>(<i>txt</i>)
240 <p>
241 Public slot to appand text to the "stderr" tab.
242 </p><dl>
243 <dt><i>txt</i></dt>
244 <dd>
245 text to be appended (string)
246 </dd>
247 </dl><a NAME="LogViewerEdit.appendToStdout" ID="LogViewerEdit.appendToStdout"></a>
248 <h4>LogViewerEdit.appendToStdout</h4>
249 <b>appendToStdout</b>(<i>txt</i>)
250 <p>
251 Public slot to appand text to the "stdout" tab.
252 </p><dl>
253 <dt><i>txt</i></dt>
254 <dd>
255 text to be appended (string)
256 </dd>
257 </dl><a NAME="LogViewerEdit.keyPressEvent" ID="LogViewerEdit.keyPressEvent"></a>
258 <h4>LogViewerEdit.keyPressEvent</h4>
259 <b>keyPressEvent</b>(<i>evt</i>)
260 <p>
261 Protected method handling key press events.
262 </p><dl>
263 <dt><i>evt</i></dt>
264 <dd>
265 key press event (QKeyEvent)
266 </dd>
267 </dl><a NAME="LogViewerEdit.preferencesChanged" ID="LogViewerEdit.preferencesChanged"></a>
268 <h4>LogViewerEdit.preferencesChanged</h4>
269 <b>preferencesChanged</b>(<i></i>)
270 <p>
271 Public slot to handle a change of the preferences.
272 </p><a NAME="LogViewerEdit.searchNext" ID="LogViewerEdit.searchNext"></a>
273 <h4>LogViewerEdit.searchNext</h4>
274 <b>searchNext</b>(<i>txt, caseSensitive, wholeWord</i>)
275 <p>
276 Public method to search the next occurrence of the given text.
277 </p><dl>
278 <dt><i>txt</i></dt>
279 <dd>
280 text to search for (string)
281 </dd><dt><i>caseSensitive</i></dt>
282 <dd>
283 flag indicating case sensitivity (boolean)
284 </dd><dt><i>wholeWord</i></dt>
285 <dd>
286 flag indicating a search for the whole word (boolean)
287 </dd>
288 </dl><a NAME="LogViewerEdit.searchPrev" ID="LogViewerEdit.searchPrev"></a>
289 <h4>LogViewerEdit.searchPrev</h4>
290 <b>searchPrev</b>(<i>txt, caseSensitive, wholeWord</i>)
291 <p>
292 Public method to search the previous occurrence of the given text.
293 </p><dl>
294 <dt><i>txt</i></dt>
295 <dd>
296 text to search for (string)
297 </dd><dt><i>caseSensitive</i></dt>
298 <dd>
299 flag indicating case sensitivity (boolean)
300 </dd><dt><i>wholeWord</i></dt>
301 <dd>
302 flag indicating a search for the whole word (boolean)
303 </dd>
304 </dl>
305 <div align="right"><a href="#top">Up</a></div>
306 <hr />
307 </body></html>

Mercurial Repository: eric

eric ide

mercurial