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

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

eric ide

mercurial