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

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

eric ide

mercurial