Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Debugger.BreakPointViewer.html

eric7/Documentation/Source/eric7.Debugger.BreakPointViewer.html

branch
eric7
changeset 8372
e0227a7c850e
child 8524
595547ab8d6f
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Debugger.BreakPointViewer</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.Debugger.BreakPointViewer</h1>
24
25 <p>
26 Module implementing the Breakpoint viewer 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="#BreakPointViewer">BreakPointViewer</a></td>
39 <td>Class implementing the Breakpoint viewer widget.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="BreakPointViewer" ID="BreakPointViewer"></a>
50 <h2>BreakPointViewer</h2>
51
52 <p>
53 Class implementing the Breakpoint viewer widget.
54 </p>
55 <p>
56 Breakpoints will be shown with all their details. They can be modified
57 through the context menu of this widget.
58 </p>
59 <h3>Signals</h3>
60 <dl>
61
62 <dt>sourceFile(str, int)</dt>
63 <dd>
64 emitted to show the source of a breakpoint
65 </dd>
66 </dl>
67 <h3>Derived from</h3>
68 QTreeView
69 <h3>Class Attributes</h3>
70
71 <table>
72 <tr><td>None</td></tr>
73 </table>
74 <h3>Class Methods</h3>
75
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79 <h3>Methods</h3>
80
81 <table>
82
83 <tr>
84 <td><a href="#BreakPointViewer.__init__">BreakPointViewer</a></td>
85 <td>Constructor</td>
86 </tr>
87 <tr>
88 <td><a href="#BreakPointViewer.__addBreak">__addBreak</a></td>
89 <td>Private slot to handle the add breakpoint context menu entry.</td>
90 </tr>
91 <tr>
92 <td><a href="#BreakPointViewer.__clearSelection">__clearSelection</a></td>
93 <td>Private slot to clear the selection.</td>
94 </tr>
95 <tr>
96 <td><a href="#BreakPointViewer.__configure">__configure</a></td>
97 <td>Private method to open the configuration dialog.</td>
98 </tr>
99 <tr>
100 <td><a href="#BreakPointViewer.__createPopupMenus">__createPopupMenus</a></td>
101 <td>Private method to generate the popup menus.</td>
102 </tr>
103 <tr>
104 <td><a href="#BreakPointViewer.__deleteAllBreaks">__deleteAllBreaks</a></td>
105 <td>Private slot to handle the delete all breakpoints context menu entry.</td>
106 </tr>
107 <tr>
108 <td><a href="#BreakPointViewer.__deleteBreak">__deleteBreak</a></td>
109 <td>Private slot to handle the delete breakpoint context menu entry.</td>
110 </tr>
111 <tr>
112 <td><a href="#BreakPointViewer.__deleteSelectedBreaks">__deleteSelectedBreaks</a></td>
113 <td>Private slot to handle the delete selected breakpoints context menu entry.</td>
114 </tr>
115 <tr>
116 <td><a href="#BreakPointViewer.__disableAllBreaks">__disableAllBreaks</a></td>
117 <td>Private slot to handle the disable all breakpoints context menu entry.</td>
118 </tr>
119 <tr>
120 <td><a href="#BreakPointViewer.__disableBreak">__disableBreak</a></td>
121 <td>Private slot to handle the disable breakpoint context menu entry.</td>
122 </tr>
123 <tr>
124 <td><a href="#BreakPointViewer.__disableSelectedBreaks">__disableSelectedBreaks</a></td>
125 <td>Private slot to handle the disable selected breakpoints context menu entry.</td>
126 </tr>
127 <tr>
128 <td><a href="#BreakPointViewer.__doubleClicked">__doubleClicked</a></td>
129 <td>Private slot to handle the double clicked signal.</td>
130 </tr>
131 <tr>
132 <td><a href="#BreakPointViewer.__editBreak">__editBreak</a></td>
133 <td>Private slot to handle the edit breakpoint context menu entry.</td>
134 </tr>
135 <tr>
136 <td><a href="#BreakPointViewer.__editBreakpoint">__editBreakpoint</a></td>
137 <td>Private slot to edit a breakpoint.</td>
138 </tr>
139 <tr>
140 <td><a href="#BreakPointViewer.__enableAllBreaks">__enableAllBreaks</a></td>
141 <td>Private slot to handle the enable all breakpoints context menu entry.</td>
142 </tr>
143 <tr>
144 <td><a href="#BreakPointViewer.__enableBreak">__enableBreak</a></td>
145 <td>Private slot to handle the enable breakpoint context menu entry.</td>
146 </tr>
147 <tr>
148 <td><a href="#BreakPointViewer.__enableSelectedBreaks">__enableSelectedBreaks</a></td>
149 <td>Private slot to handle the enable selected breakpoints context menu entry.</td>
150 </tr>
151 <tr>
152 <td><a href="#BreakPointViewer.__fromSourceIndex">__fromSourceIndex</a></td>
153 <td>Private slot to convert a source index to an index.</td>
154 </tr>
155 <tr>
156 <td><a href="#BreakPointViewer.__getSelectedItemsCount">__getSelectedItemsCount</a></td>
157 <td>Private method to get the count of items selected.</td>
158 </tr>
159 <tr>
160 <td><a href="#BreakPointViewer.__layoutDisplay">__layoutDisplay</a></td>
161 <td>Private slot to perform a layout operation.</td>
162 </tr>
163 <tr>
164 <td><a href="#BreakPointViewer.__loadRecent">__loadRecent</a></td>
165 <td>Private method to load the recently used file names.</td>
166 </tr>
167 <tr>
168 <td><a href="#BreakPointViewer.__resizeColumns">__resizeColumns</a></td>
169 <td>Private slot to resize the view when items get added, edited or deleted.</td>
170 </tr>
171 <tr>
172 <td><a href="#BreakPointViewer.__resort">__resort</a></td>
173 <td>Private slot to resort the tree.</td>
174 </tr>
175 <tr>
176 <td><a href="#BreakPointViewer.__saveRecent">__saveRecent</a></td>
177 <td>Private method to save the list of recently used file names.</td>
178 </tr>
179 <tr>
180 <td><a href="#BreakPointViewer.__setBpEnabled">__setBpEnabled</a></td>
181 <td>Private method to set the enabled status of a breakpoint.</td>
182 </tr>
183 <tr>
184 <td><a href="#BreakPointViewer.__setRowSelected">__setRowSelected</a></td>
185 <td>Private slot to select a complete row.</td>
186 </tr>
187 <tr>
188 <td><a href="#BreakPointViewer.__showBackMenu">__showBackMenu</a></td>
189 <td>Private slot to handle the aboutToShow signal of the background menu.</td>
190 </tr>
191 <tr>
192 <td><a href="#BreakPointViewer.__showContextMenu">__showContextMenu</a></td>
193 <td>Private slot to show the context menu.</td>
194 </tr>
195 <tr>
196 <td><a href="#BreakPointViewer.__showSource">__showSource</a></td>
197 <td>Private slot to handle the goto context menu entry.</td>
198 </tr>
199 <tr>
200 <td><a href="#BreakPointViewer.__toSourceIndex">__toSourceIndex</a></td>
201 <td>Private slot to convert an index to a source index.</td>
202 </tr>
203 <tr>
204 <td><a href="#BreakPointViewer.handleResetUI">handleResetUI</a></td>
205 <td>Public slot to reset the breakpoint viewer.</td>
206 </tr>
207 <tr>
208 <td><a href="#BreakPointViewer.highlightBreakpoint">highlightBreakpoint</a></td>
209 <td>Public slot to handle the clientLine signal.</td>
210 </tr>
211 <tr>
212 <td><a href="#BreakPointViewer.setModel">setModel</a></td>
213 <td>Public slot to set the breakpoint model.</td>
214 </tr>
215 </table>
216 <h3>Static Methods</h3>
217
218 <table>
219 <tr><td>None</td></tr>
220 </table>
221
222 <a NAME="BreakPointViewer.__init__" ID="BreakPointViewer.__init__"></a>
223 <h4>BreakPointViewer (Constructor)</h4>
224 <b>BreakPointViewer</b>(<i>parent=None</i>)
225
226 <p>
227 Constructor
228 </p>
229 <dl>
230
231 <dt><i>parent</i></dt>
232 <dd>
233 the parent (QWidget)
234 </dd>
235 </dl>
236 <a NAME="BreakPointViewer.__addBreak" ID="BreakPointViewer.__addBreak"></a>
237 <h4>BreakPointViewer.__addBreak</h4>
238 <b>__addBreak</b>(<i></i>)
239
240 <p>
241 Private slot to handle the add breakpoint context menu entry.
242 </p>
243 <a NAME="BreakPointViewer.__clearSelection" ID="BreakPointViewer.__clearSelection"></a>
244 <h4>BreakPointViewer.__clearSelection</h4>
245 <b>__clearSelection</b>(<i></i>)
246
247 <p>
248 Private slot to clear the selection.
249 </p>
250 <a NAME="BreakPointViewer.__configure" ID="BreakPointViewer.__configure"></a>
251 <h4>BreakPointViewer.__configure</h4>
252 <b>__configure</b>(<i></i>)
253
254 <p>
255 Private method to open the configuration dialog.
256 </p>
257 <a NAME="BreakPointViewer.__createPopupMenus" ID="BreakPointViewer.__createPopupMenus"></a>
258 <h4>BreakPointViewer.__createPopupMenus</h4>
259 <b>__createPopupMenus</b>(<i></i>)
260
261 <p>
262 Private method to generate the popup menus.
263 </p>
264 <a NAME="BreakPointViewer.__deleteAllBreaks" ID="BreakPointViewer.__deleteAllBreaks"></a>
265 <h4>BreakPointViewer.__deleteAllBreaks</h4>
266 <b>__deleteAllBreaks</b>(<i></i>)
267
268 <p>
269 Private slot to handle the delete all breakpoints context menu entry.
270 </p>
271 <a NAME="BreakPointViewer.__deleteBreak" ID="BreakPointViewer.__deleteBreak"></a>
272 <h4>BreakPointViewer.__deleteBreak</h4>
273 <b>__deleteBreak</b>(<i></i>)
274
275 <p>
276 Private slot to handle the delete breakpoint context menu entry.
277 </p>
278 <a NAME="BreakPointViewer.__deleteSelectedBreaks" ID="BreakPointViewer.__deleteSelectedBreaks"></a>
279 <h4>BreakPointViewer.__deleteSelectedBreaks</h4>
280 <b>__deleteSelectedBreaks</b>(<i></i>)
281
282 <p>
283 Private slot to handle the delete selected breakpoints context menu
284 entry.
285 </p>
286 <a NAME="BreakPointViewer.__disableAllBreaks" ID="BreakPointViewer.__disableAllBreaks"></a>
287 <h4>BreakPointViewer.__disableAllBreaks</h4>
288 <b>__disableAllBreaks</b>(<i></i>)
289
290 <p>
291 Private slot to handle the disable all breakpoints context menu entry.
292 </p>
293 <a NAME="BreakPointViewer.__disableBreak" ID="BreakPointViewer.__disableBreak"></a>
294 <h4>BreakPointViewer.__disableBreak</h4>
295 <b>__disableBreak</b>(<i></i>)
296
297 <p>
298 Private slot to handle the disable breakpoint context menu entry.
299 </p>
300 <a NAME="BreakPointViewer.__disableSelectedBreaks" ID="BreakPointViewer.__disableSelectedBreaks"></a>
301 <h4>BreakPointViewer.__disableSelectedBreaks</h4>
302 <b>__disableSelectedBreaks</b>(<i></i>)
303
304 <p>
305 Private slot to handle the disable selected breakpoints context menu
306 entry.
307 </p>
308 <a NAME="BreakPointViewer.__doubleClicked" ID="BreakPointViewer.__doubleClicked"></a>
309 <h4>BreakPointViewer.__doubleClicked</h4>
310 <b>__doubleClicked</b>(<i>index</i>)
311
312 <p>
313 Private slot to handle the double clicked signal.
314 </p>
315 <dl>
316
317 <dt><i>index</i> (QModelIndex)</dt>
318 <dd>
319 index of the entry that was double clicked
320 </dd>
321 </dl>
322 <a NAME="BreakPointViewer.__editBreak" ID="BreakPointViewer.__editBreak"></a>
323 <h4>BreakPointViewer.__editBreak</h4>
324 <b>__editBreak</b>(<i></i>)
325
326 <p>
327 Private slot to handle the edit breakpoint context menu entry.
328 </p>
329 <a NAME="BreakPointViewer.__editBreakpoint" ID="BreakPointViewer.__editBreakpoint"></a>
330 <h4>BreakPointViewer.__editBreakpoint</h4>
331 <b>__editBreakpoint</b>(<i>index</i>)
332
333 <p>
334 Private slot to edit a breakpoint.
335 </p>
336 <dl>
337
338 <dt><i>index</i> (QModelIndex)</dt>
339 <dd>
340 index of breakpoint to be edited
341 </dd>
342 </dl>
343 <a NAME="BreakPointViewer.__enableAllBreaks" ID="BreakPointViewer.__enableAllBreaks"></a>
344 <h4>BreakPointViewer.__enableAllBreaks</h4>
345 <b>__enableAllBreaks</b>(<i></i>)
346
347 <p>
348 Private slot to handle the enable all breakpoints context menu entry.
349 </p>
350 <a NAME="BreakPointViewer.__enableBreak" ID="BreakPointViewer.__enableBreak"></a>
351 <h4>BreakPointViewer.__enableBreak</h4>
352 <b>__enableBreak</b>(<i></i>)
353
354 <p>
355 Private slot to handle the enable breakpoint context menu entry.
356 </p>
357 <a NAME="BreakPointViewer.__enableSelectedBreaks" ID="BreakPointViewer.__enableSelectedBreaks"></a>
358 <h4>BreakPointViewer.__enableSelectedBreaks</h4>
359 <b>__enableSelectedBreaks</b>(<i></i>)
360
361 <p>
362 Private slot to handle the enable selected breakpoints context menu
363 entry.
364 </p>
365 <a NAME="BreakPointViewer.__fromSourceIndex" ID="BreakPointViewer.__fromSourceIndex"></a>
366 <h4>BreakPointViewer.__fromSourceIndex</h4>
367 <b>__fromSourceIndex</b>(<i>sindex</i>)
368
369 <p>
370 Private slot to convert a source index to an index.
371 </p>
372 <dl>
373
374 <dt><i>sindex</i> (QModelIndex)</dt>
375 <dd>
376 source index to be converted
377 </dd>
378 </dl>
379 <dl>
380 <dt>Return:</dt>
381 <dd>
382 mapped index
383 </dd>
384 </dl>
385 <dl>
386 <dt>Return Type:</dt>
387 <dd>
388 QModelIndex
389 </dd>
390 </dl>
391 <a NAME="BreakPointViewer.__getSelectedItemsCount" ID="BreakPointViewer.__getSelectedItemsCount"></a>
392 <h4>BreakPointViewer.__getSelectedItemsCount</h4>
393 <b>__getSelectedItemsCount</b>(<i></i>)
394
395 <p>
396 Private method to get the count of items selected.
397 </p>
398 <dl>
399 <dt>Return:</dt>
400 <dd>
401 count of items selected
402 </dd>
403 </dl>
404 <dl>
405 <dt>Return Type:</dt>
406 <dd>
407 int
408 </dd>
409 </dl>
410 <a NAME="BreakPointViewer.__layoutDisplay" ID="BreakPointViewer.__layoutDisplay"></a>
411 <h4>BreakPointViewer.__layoutDisplay</h4>
412 <b>__layoutDisplay</b>(<i></i>)
413
414 <p>
415 Private slot to perform a layout operation.
416 </p>
417 <a NAME="BreakPointViewer.__loadRecent" ID="BreakPointViewer.__loadRecent"></a>
418 <h4>BreakPointViewer.__loadRecent</h4>
419 <b>__loadRecent</b>(<i></i>)
420
421 <p>
422 Private method to load the recently used file names.
423 </p>
424 <a NAME="BreakPointViewer.__resizeColumns" ID="BreakPointViewer.__resizeColumns"></a>
425 <h4>BreakPointViewer.__resizeColumns</h4>
426 <b>__resizeColumns</b>(<i></i>)
427
428 <p>
429 Private slot to resize the view when items get added, edited or
430 deleted.
431 </p>
432 <a NAME="BreakPointViewer.__resort" ID="BreakPointViewer.__resort"></a>
433 <h4>BreakPointViewer.__resort</h4>
434 <b>__resort</b>(<i></i>)
435
436 <p>
437 Private slot to resort the tree.
438 </p>
439 <a NAME="BreakPointViewer.__saveRecent" ID="BreakPointViewer.__saveRecent"></a>
440 <h4>BreakPointViewer.__saveRecent</h4>
441 <b>__saveRecent</b>(<i></i>)
442
443 <p>
444 Private method to save the list of recently used file names.
445 </p>
446 <a NAME="BreakPointViewer.__setBpEnabled" ID="BreakPointViewer.__setBpEnabled"></a>
447 <h4>BreakPointViewer.__setBpEnabled</h4>
448 <b>__setBpEnabled</b>(<i>index, enabled</i>)
449
450 <p>
451 Private method to set the enabled status of a breakpoint.
452 </p>
453 <dl>
454
455 <dt><i>index</i> (QModelIndex)</dt>
456 <dd>
457 index of breakpoint to be enabled/disabled
458 </dd>
459 <dt><i>enabled</i> (bool)</dt>
460 <dd>
461 flag indicating the enabled status to be set
462 </dd>
463 </dl>
464 <a NAME="BreakPointViewer.__setRowSelected" ID="BreakPointViewer.__setRowSelected"></a>
465 <h4>BreakPointViewer.__setRowSelected</h4>
466 <b>__setRowSelected</b>(<i>index, selected=True</i>)
467
468 <p>
469 Private slot to select a complete row.
470 </p>
471 <dl>
472
473 <dt><i>index</i> (QModelIndex)</dt>
474 <dd>
475 index determining the row to be selected
476 </dd>
477 <dt><i>selected</i> (bool)</dt>
478 <dd>
479 flag indicating the action
480 </dd>
481 </dl>
482 <a NAME="BreakPointViewer.__showBackMenu" ID="BreakPointViewer.__showBackMenu"></a>
483 <h4>BreakPointViewer.__showBackMenu</h4>
484 <b>__showBackMenu</b>(<i></i>)
485
486 <p>
487 Private slot to handle the aboutToShow signal of the background menu.
488 </p>
489 <a NAME="BreakPointViewer.__showContextMenu" ID="BreakPointViewer.__showContextMenu"></a>
490 <h4>BreakPointViewer.__showContextMenu</h4>
491 <b>__showContextMenu</b>(<i>coord</i>)
492
493 <p>
494 Private slot to show the context menu.
495 </p>
496 <dl>
497
498 <dt><i>coord</i> (QPoint)</dt>
499 <dd>
500 the position of the mouse pointer
501 </dd>
502 </dl>
503 <a NAME="BreakPointViewer.__showSource" ID="BreakPointViewer.__showSource"></a>
504 <h4>BreakPointViewer.__showSource</h4>
505 <b>__showSource</b>(<i></i>)
506
507 <p>
508 Private slot to handle the goto context menu entry.
509 </p>
510 <a NAME="BreakPointViewer.__toSourceIndex" ID="BreakPointViewer.__toSourceIndex"></a>
511 <h4>BreakPointViewer.__toSourceIndex</h4>
512 <b>__toSourceIndex</b>(<i>index</i>)
513
514 <p>
515 Private slot to convert an index to a source index.
516 </p>
517 <dl>
518
519 <dt><i>index</i> (QModelIndex)</dt>
520 <dd>
521 index to be converted
522 </dd>
523 </dl>
524 <dl>
525 <dt>Return:</dt>
526 <dd>
527 mapped index
528 </dd>
529 </dl>
530 <dl>
531 <dt>Return Type:</dt>
532 <dd>
533 QModelIndex
534 </dd>
535 </dl>
536 <a NAME="BreakPointViewer.handleResetUI" ID="BreakPointViewer.handleResetUI"></a>
537 <h4>BreakPointViewer.handleResetUI</h4>
538 <b>handleResetUI</b>(<i></i>)
539
540 <p>
541 Public slot to reset the breakpoint viewer.
542 </p>
543 <a NAME="BreakPointViewer.highlightBreakpoint" ID="BreakPointViewer.highlightBreakpoint"></a>
544 <h4>BreakPointViewer.highlightBreakpoint</h4>
545 <b>highlightBreakpoint</b>(<i>fn, lineno</i>)
546
547 <p>
548 Public slot to handle the clientLine signal.
549 </p>
550 <dl>
551
552 <dt><i>fn</i> (str)</dt>
553 <dd>
554 filename of the breakpoint
555 </dd>
556 <dt><i>lineno</i> (int)</dt>
557 <dd>
558 line number of the breakpoint
559 </dd>
560 </dl>
561 <a NAME="BreakPointViewer.setModel" ID="BreakPointViewer.setModel"></a>
562 <h4>BreakPointViewer.setModel</h4>
563 <b>setModel</b>(<i>model</i>)
564
565 <p>
566 Public slot to set the breakpoint model.
567 </p>
568 <dl>
569
570 <dt><i>model</i> (BreakPointModel)</dt>
571 <dd>
572 reference to the breakpoint model
573 </dd>
574 </dl>
575 <div align="right"><a href="#top">Up</a></div>
576 <hr />
577 </body></html>

Mercurial Repository: eric

eric ide

mercurial