eric7/Documentation/Source/eric7.Debugger.BreakPointModel.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.Debugger.BreakPointModel</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.BreakPointModel</h1>
24
25 <p>
26 Module implementing the Breakpoint model.
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="#BreakPointModel">BreakPointModel</a></td>
39 <td>Class implementing a custom model for breakpoints.</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="BreakPointModel" ID="BreakPointModel"></a>
50 <h2>BreakPointModel</h2>
51
52 <p>
53 Class implementing a custom model for breakpoints.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>dataAboutToBeChanged(QModelIndex, QModelIndex)</dt>
59 <dd>
60 emitted to indicate
61 a change of the data
62 </dd>
63 </dl>
64 <h3>Derived from</h3>
65 QAbstractItemModel
66 <h3>Class Attributes</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Class Methods</h3>
72
73 <table>
74 <tr><td>None</td></tr>
75 </table>
76 <h3>Methods</h3>
77
78 <table>
79
80 <tr>
81 <td><a href="#BreakPointModel.__init__">BreakPointModel</a></td>
82 <td>Constructor</td>
83 </tr>
84 <tr>
85 <td><a href="#BreakPointModel.addBreakPoint">addBreakPoint</a></td>
86 <td>Public method to add a new breakpoint to the list.</td>
87 </tr>
88 <tr>
89 <td><a href="#BreakPointModel.addBreakPoints">addBreakPoints</a></td>
90 <td>Public method to add multiple breakpoints to the list.</td>
91 </tr>
92 <tr>
93 <td><a href="#BreakPointModel.columnCount">columnCount</a></td>
94 <td>Public method to get the current column count.</td>
95 </tr>
96 <tr>
97 <td><a href="#BreakPointModel.data">data</a></td>
98 <td>Public method to get the requested data.</td>
99 </tr>
100 <tr>
101 <td><a href="#BreakPointModel.deleteAll">deleteAll</a></td>
102 <td>Public method to delete all breakpoints.</td>
103 </tr>
104 <tr>
105 <td><a href="#BreakPointModel.deleteBreakPointByIndex">deleteBreakPointByIndex</a></td>
106 <td>Public method to set the values of a breakpoint given by index.</td>
107 </tr>
108 <tr>
109 <td><a href="#BreakPointModel.deleteBreakPoints">deleteBreakPoints</a></td>
110 <td>Public method to delete a list of breakpoints given by their indexes.</td>
111 </tr>
112 <tr>
113 <td><a href="#BreakPointModel.flags">flags</a></td>
114 <td>Public method to get item flags.</td>
115 </tr>
116 <tr>
117 <td><a href="#BreakPointModel.getAllBreakpoints">getAllBreakpoints</a></td>
118 <td>Public method to get a copy of the breakpoints.</td>
119 </tr>
120 <tr>
121 <td><a href="#BreakPointModel.getBreakPointByIndex">getBreakPointByIndex</a></td>
122 <td>Public method to get the values of a breakpoint given by index.</td>
123 </tr>
124 <tr>
125 <td><a href="#BreakPointModel.getBreakPointIndex">getBreakPointIndex</a></td>
126 <td>Public method to get the index of a breakpoint given by filename and line number.</td>
127 </tr>
128 <tr>
129 <td><a href="#BreakPointModel.hasChildren">hasChildren</a></td>
130 <td>Public method to check for the presence of child items.</td>
131 </tr>
132 <tr>
133 <td><a href="#BreakPointModel.headerData">headerData</a></td>
134 <td>Public method to get header data.</td>
135 </tr>
136 <tr>
137 <td><a href="#BreakPointModel.index">index</a></td>
138 <td>Public method to create an index.</td>
139 </tr>
140 <tr>
141 <td><a href="#BreakPointModel.isBreakPointTemporaryByIndex">isBreakPointTemporaryByIndex</a></td>
142 <td>Public method to test, if a breakpoint given by its index is temporary.</td>
143 </tr>
144 <tr>
145 <td><a href="#BreakPointModel.parent">parent</a></td>
146 <td>Public method to get the parent index.</td>
147 </tr>
148 <tr>
149 <td><a href="#BreakPointModel.rowCount">rowCount</a></td>
150 <td>Public method to get the current row count.</td>
151 </tr>
152 <tr>
153 <td><a href="#BreakPointModel.setBreakPointByIndex">setBreakPointByIndex</a></td>
154 <td>Public method to set the values of a breakpoint given by index.</td>
155 </tr>
156 <tr>
157 <td><a href="#BreakPointModel.setBreakPointEnabledByIndex">setBreakPointEnabledByIndex</a></td>
158 <td>Public method to set the enabled state of a breakpoint given by index.</td>
159 </tr>
160 <tr>
161 <td><a href="#BreakPointModel.setData">setData</a></td>
162 <td>Public method to change data in the model.</td>
163 </tr>
164 </table>
165 <h3>Static Methods</h3>
166
167 <table>
168 <tr><td>None</td></tr>
169 </table>
170
171 <a NAME="BreakPointModel.__init__" ID="BreakPointModel.__init__"></a>
172 <h4>BreakPointModel (Constructor)</h4>
173 <b>BreakPointModel</b>(<i>project, parent=None</i>)
174
175 <p>
176 Constructor
177 </p>
178 <dl>
179
180 <dt><i>project</i> (Project)</dt>
181 <dd>
182 reference to the project object
183 </dd>
184 <dt><i>parent</i> (QObject)</dt>
185 <dd>
186 reference to the parent widget
187 </dd>
188 </dl>
189 <a NAME="BreakPointModel.addBreakPoint" ID="BreakPointModel.addBreakPoint"></a>
190 <h4>BreakPointModel.addBreakPoint</h4>
191 <b>addBreakPoint</b>(<i>fn, line, properties</i>)
192
193 <p>
194 Public method to add a new breakpoint to the list.
195 </p>
196 <dl>
197
198 <dt><i>fn</i> (str)</dt>
199 <dd>
200 filename of the breakpoint
201 </dd>
202 <dt><i>line</i> (int)</dt>
203 <dd>
204 line number of the breakpoint
205 </dd>
206 <dt><i>properties</i> (tuple of (str, bool, bool, int))</dt>
207 <dd>
208 properties of the breakpoint
209 (tuple of condition, temporary flag, enabled flag, ignore count)
210 </dd>
211 </dl>
212 <a NAME="BreakPointModel.addBreakPoints" ID="BreakPointModel.addBreakPoints"></a>
213 <h4>BreakPointModel.addBreakPoints</h4>
214 <b>addBreakPoints</b>(<i>breakpoints</i>)
215
216 <p>
217 Public method to add multiple breakpoints to the list.
218 </p>
219 <dl>
220
221 <dt><i>breakpoints</i> (list of (str, int, str, bool, bool, int))</dt>
222 <dd>
223 list of breakpoints with file name, line number,
224 condition, temporary flag, enabled flag and ignore count each
225 </dd>
226 </dl>
227 <a NAME="BreakPointModel.columnCount" ID="BreakPointModel.columnCount"></a>
228 <h4>BreakPointModel.columnCount</h4>
229 <b>columnCount</b>(<i>parent=None</i>)
230
231 <p>
232 Public method to get the current column count.
233 </p>
234 <dl>
235
236 <dt><i>parent</i> (QModelIndex)</dt>
237 <dd>
238 reference to parent index (Unused)
239 </dd>
240 </dl>
241 <dl>
242 <dt>Return:</dt>
243 <dd>
244 column count
245 </dd>
246 </dl>
247 <dl>
248 <dt>Return Type:</dt>
249 <dd>
250 int
251 </dd>
252 </dl>
253 <a NAME="BreakPointModel.data" ID="BreakPointModel.data"></a>
254 <h4>BreakPointModel.data</h4>
255 <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>)
256
257 <p>
258 Public method to get the requested data.
259 </p>
260 <dl>
261
262 <dt><i>index</i> (QModelIndex)</dt>
263 <dd>
264 index of the requested data
265 </dd>
266 <dt><i>role</i> (Qt.ItemDataRole)</dt>
267 <dd>
268 role of the requested data
269 </dd>
270 </dl>
271 <dl>
272 <dt>Return:</dt>
273 <dd>
274 the requested data
275 </dd>
276 </dl>
277 <dl>
278 <dt>Return Type:</dt>
279 <dd>
280 any
281 </dd>
282 </dl>
283 <a NAME="BreakPointModel.deleteAll" ID="BreakPointModel.deleteAll"></a>
284 <h4>BreakPointModel.deleteAll</h4>
285 <b>deleteAll</b>(<i></i>)
286
287 <p>
288 Public method to delete all breakpoints.
289 </p>
290 <a NAME="BreakPointModel.deleteBreakPointByIndex" ID="BreakPointModel.deleteBreakPointByIndex"></a>
291 <h4>BreakPointModel.deleteBreakPointByIndex</h4>
292 <b>deleteBreakPointByIndex</b>(<i>index</i>)
293
294 <p>
295 Public method to set the values of a breakpoint given by index.
296 </p>
297 <dl>
298
299 <dt><i>index</i> (QModelIndex)</dt>
300 <dd>
301 index of the breakpoint
302 </dd>
303 </dl>
304 <a NAME="BreakPointModel.deleteBreakPoints" ID="BreakPointModel.deleteBreakPoints"></a>
305 <h4>BreakPointModel.deleteBreakPoints</h4>
306 <b>deleteBreakPoints</b>(<i>idxList</i>)
307
308 <p>
309 Public method to delete a list of breakpoints given by their indexes.
310 </p>
311 <dl>
312
313 <dt><i>idxList</i> (list of QModelIndex)</dt>
314 <dd>
315 list of breakpoint indexes
316 </dd>
317 </dl>
318 <a NAME="BreakPointModel.flags" ID="BreakPointModel.flags"></a>
319 <h4>BreakPointModel.flags</h4>
320 <b>flags</b>(<i>index</i>)
321
322 <p>
323 Public method to get item flags.
324 </p>
325 <dl>
326
327 <dt><i>index</i> (QModelIndex)</dt>
328 <dd>
329 index of the requested flags
330 </dd>
331 </dl>
332 <dl>
333 <dt>Return:</dt>
334 <dd>
335 item flags for the given index
336 </dd>
337 </dl>
338 <dl>
339 <dt>Return Type:</dt>
340 <dd>
341 Qt.ItemFlags
342 </dd>
343 </dl>
344 <a NAME="BreakPointModel.getAllBreakpoints" ID="BreakPointModel.getAllBreakpoints"></a>
345 <h4>BreakPointModel.getAllBreakpoints</h4>
346 <b>getAllBreakpoints</b>(<i></i>)
347
348 <p>
349 Public method to get a copy of the breakpoints.
350 </p>
351 <dl>
352 <dt>Return:</dt>
353 <dd>
354 list of breakpoints
355 </dd>
356 </dl>
357 <dl>
358 <dt>Return Type:</dt>
359 <dd>
360 list of list of [str, int, str, bool, bool, int]
361 </dd>
362 </dl>
363 <a NAME="BreakPointModel.getBreakPointByIndex" ID="BreakPointModel.getBreakPointByIndex"></a>
364 <h4>BreakPointModel.getBreakPointByIndex</h4>
365 <b>getBreakPointByIndex</b>(<i>index</i>)
366
367 <p>
368 Public method to get the values of a breakpoint given by index.
369 </p>
370 <dl>
371
372 <dt><i>index</i> (QModelIndex)</dt>
373 <dd>
374 index of the breakpoint
375 </dd>
376 </dl>
377 <dl>
378 <dt>Return:</dt>
379 <dd>
380 breakpoint (list of six values (filename, line number,
381 condition, temporary flag, enabled flag, ignore count))
382 </dd>
383 </dl>
384 <dl>
385 <dt>Return Type:</dt>
386 <dd>
387 list of (str, int, str, bool, bool, int)
388 </dd>
389 </dl>
390 <a NAME="BreakPointModel.getBreakPointIndex" ID="BreakPointModel.getBreakPointIndex"></a>
391 <h4>BreakPointModel.getBreakPointIndex</h4>
392 <b>getBreakPointIndex</b>(<i>fn, lineno</i>)
393
394 <p>
395 Public method to get the index of a breakpoint given by filename and
396 line number.
397 </p>
398 <dl>
399
400 <dt><i>fn</i> (str)</dt>
401 <dd>
402 filename of the breakpoint
403 </dd>
404 <dt><i>lineno</i> (int)</dt>
405 <dd>
406 line number of the breakpoint
407 </dd>
408 </dl>
409 <dl>
410 <dt>Return:</dt>
411 <dd>
412 index
413 </dd>
414 </dl>
415 <dl>
416 <dt>Return Type:</dt>
417 <dd>
418 QModelIndex
419 </dd>
420 </dl>
421 <a NAME="BreakPointModel.hasChildren" ID="BreakPointModel.hasChildren"></a>
422 <h4>BreakPointModel.hasChildren</h4>
423 <b>hasChildren</b>(<i>parent=None</i>)
424
425 <p>
426 Public method to check for the presence of child items.
427 </p>
428 <dl>
429
430 <dt><i>parent</i> (QModelIndex)</dt>
431 <dd>
432 index of parent item
433 </dd>
434 </dl>
435 <dl>
436 <dt>Return:</dt>
437 <dd>
438 flag indicating the presence of child items
439 </dd>
440 </dl>
441 <dl>
442 <dt>Return Type:</dt>
443 <dd>
444 bool
445 </dd>
446 </dl>
447 <a NAME="BreakPointModel.headerData" ID="BreakPointModel.headerData"></a>
448 <h4>BreakPointModel.headerData</h4>
449 <b>headerData</b>(<i>section, orientation, role=Qt.ItemDataRole.DisplayRole</i>)
450
451 <p>
452 Public method to get header data.
453 </p>
454 <dl>
455
456 <dt><i>section</i> (int)</dt>
457 <dd>
458 section number of the requested header data
459 </dd>
460 <dt><i>orientation</i> (Qt.Orientation)</dt>
461 <dd>
462 orientation of the header
463 </dd>
464 <dt><i>role</i> (Qt.ItemDataRole)</dt>
465 <dd>
466 role of the requested data
467 </dd>
468 </dl>
469 <dl>
470 <dt>Return:</dt>
471 <dd>
472 header data
473 </dd>
474 </dl>
475 <dl>
476 <dt>Return Type:</dt>
477 <dd>
478 str
479 </dd>
480 </dl>
481 <a NAME="BreakPointModel.index" ID="BreakPointModel.index"></a>
482 <h4>BreakPointModel.index</h4>
483 <b>index</b>(<i>row, column, parent=None</i>)
484
485 <p>
486 Public method to create an index.
487 </p>
488 <dl>
489
490 <dt><i>row</i> (int)</dt>
491 <dd>
492 row number for the index
493 </dd>
494 <dt><i>column</i> (int)</dt>
495 <dd>
496 column number for the index
497 </dd>
498 <dt><i>parent</i> (QModelIndex)</dt>
499 <dd>
500 index of the parent item
501 </dd>
502 </dl>
503 <dl>
504 <dt>Return:</dt>
505 <dd>
506 requested index
507 </dd>
508 </dl>
509 <dl>
510 <dt>Return Type:</dt>
511 <dd>
512 QModelIndex
513 </dd>
514 </dl>
515 <a NAME="BreakPointModel.isBreakPointTemporaryByIndex" ID="BreakPointModel.isBreakPointTemporaryByIndex"></a>
516 <h4>BreakPointModel.isBreakPointTemporaryByIndex</h4>
517 <b>isBreakPointTemporaryByIndex</b>(<i>index</i>)
518
519 <p>
520 Public method to test, if a breakpoint given by its index is temporary.
521 </p>
522 <dl>
523
524 <dt><i>index</i> (QModelIndex)</dt>
525 <dd>
526 index of the breakpoint to test
527 </dd>
528 </dl>
529 <dl>
530 <dt>Return:</dt>
531 <dd>
532 flag indicating a temporary breakpoint
533 </dd>
534 </dl>
535 <dl>
536 <dt>Return Type:</dt>
537 <dd>
538 bool
539 </dd>
540 </dl>
541 <a NAME="BreakPointModel.parent" ID="BreakPointModel.parent"></a>
542 <h4>BreakPointModel.parent</h4>
543 <b>parent</b>(<i>index</i>)
544
545 <p>
546 Public method to get the parent index.
547 </p>
548 <dl>
549
550 <dt><i>index</i> (QModelIndex)</dt>
551 <dd>
552 index of item to get parent
553 </dd>
554 </dl>
555 <dl>
556 <dt>Return:</dt>
557 <dd>
558 index of parent
559 </dd>
560 </dl>
561 <dl>
562 <dt>Return Type:</dt>
563 <dd>
564 QModelIndex
565 </dd>
566 </dl>
567 <a NAME="BreakPointModel.rowCount" ID="BreakPointModel.rowCount"></a>
568 <h4>BreakPointModel.rowCount</h4>
569 <b>rowCount</b>(<i>parent=None</i>)
570
571 <p>
572 Public method to get the current row count.
573 </p>
574 <dl>
575
576 <dt><i>parent</i> (QModelIndex)</dt>
577 <dd>
578 reference to parent index
579 </dd>
580 </dl>
581 <dl>
582 <dt>Return:</dt>
583 <dd>
584 row count
585 </dd>
586 </dl>
587 <dl>
588 <dt>Return Type:</dt>
589 <dd>
590 int
591 </dd>
592 </dl>
593 <a NAME="BreakPointModel.setBreakPointByIndex" ID="BreakPointModel.setBreakPointByIndex"></a>
594 <h4>BreakPointModel.setBreakPointByIndex</h4>
595 <b>setBreakPointByIndex</b>(<i>index, fn, line, properties</i>)
596
597 <p>
598 Public method to set the values of a breakpoint given by index.
599 </p>
600 <dl>
601
602 <dt><i>index</i> (QModelIndex)</dt>
603 <dd>
604 index of the breakpoint
605 </dd>
606 <dt><i>fn</i> (str)</dt>
607 <dd>
608 filename of the breakpoint
609 </dd>
610 <dt><i>line</i> (int)</dt>
611 <dd>
612 line number of the breakpoint
613 </dd>
614 <dt><i>properties</i> (tuple of (str, bool, bool, int))</dt>
615 <dd>
616 properties of the breakpoint
617 (tuple of condition, temporary flag, enabled flag, ignore count)
618 </dd>
619 </dl>
620 <a NAME="BreakPointModel.setBreakPointEnabledByIndex" ID="BreakPointModel.setBreakPointEnabledByIndex"></a>
621 <h4>BreakPointModel.setBreakPointEnabledByIndex</h4>
622 <b>setBreakPointEnabledByIndex</b>(<i>index, enabled</i>)
623
624 <p>
625 Public method to set the enabled state of a breakpoint given by index.
626 </p>
627 <dl>
628
629 <dt><i>index</i> (QModelIndex)</dt>
630 <dd>
631 index of the breakpoint
632 </dd>
633 <dt><i>enabled</i> (bool)</dt>
634 <dd>
635 flag giving the enabled state
636 </dd>
637 </dl>
638 <a NAME="BreakPointModel.setData" ID="BreakPointModel.setData"></a>
639 <h4>BreakPointModel.setData</h4>
640 <b>setData</b>(<i>index, value, role=Qt.ItemDataRole.EditRole</i>)
641
642 <p>
643 Public method to change data in the model.
644 </p>
645 <dl>
646
647 <dt><i>index</i> (QModelIndex)</dt>
648 <dd>
649 index of the changed data
650 </dd>
651 <dt><i>value</i> (any)</dt>
652 <dd>
653 value of the changed data
654 </dd>
655 <dt><i>role</i> (Qt.ItemDataRole)</dt>
656 <dd>
657 role of the changed data
658 </dd>
659 </dl>
660 <dl>
661 <dt>Return:</dt>
662 <dd>
663 flag indicating success
664 </dd>
665 </dl>
666 <dl>
667 <dt>Return Type:</dt>
668 <dd>
669 bool
670 </dd>
671 </dl>
672 <div align="right"><a href="#top">Up</a></div>
673 <hr />
674 </body></html>

eric ide

mercurial