|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Debugger.BreakPointViewer</h1> |
|
23 <p> |
|
24 Module implementing the Breakpoint viewer 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="#BreakPointViewer">BreakPointViewer</a></td> |
|
34 <td>Class implementing the Breakpoint viewer widget.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="BreakPointViewer" ID="BreakPointViewer"></a> |
|
43 <h2>BreakPointViewer</h2> |
|
44 <p> |
|
45 Class implementing the Breakpoint viewer widget. |
|
46 </p><p> |
|
47 Breakpoints will be shown with all their details. They can be modified |
|
48 through the context menu of this widget. |
|
49 </p><h3>Signals</h3> |
|
50 <dl> |
|
51 <dt>sourceFile(str, int)</dt> |
|
52 <dd> |
|
53 emitted to show the source of a breakpoint |
|
54 </dd> |
|
55 </dl> |
|
56 <h3>Derived from</h3> |
|
57 QTreeView |
|
58 <h3>Class Attributes</h3> |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 <table> |
|
64 <tr><td>None</td></tr> |
|
65 </table> |
|
66 <h3>Methods</h3> |
|
67 <table> |
|
68 <tr> |
|
69 <td><a href="#BreakPointViewer.__init__">BreakPointViewer</a></td> |
|
70 <td>Constructor</td> |
|
71 </tr><tr> |
|
72 <td><a href="#BreakPointViewer.__addBreak">__addBreak</a></td> |
|
73 <td>Private slot to handle the add breakpoint context menu entry.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#BreakPointViewer.__clearSelection">__clearSelection</a></td> |
|
76 <td>Private slot to clear the selection.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#BreakPointViewer.__configure">__configure</a></td> |
|
79 <td>Private method to open the configuration dialog.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#BreakPointViewer.__createPopupMenus">__createPopupMenus</a></td> |
|
82 <td>Private method to generate the popup menus.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#BreakPointViewer.__deleteAllBreaks">__deleteAllBreaks</a></td> |
|
85 <td>Private slot to handle the delete all breakpoints context menu entry.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#BreakPointViewer.__deleteBreak">__deleteBreak</a></td> |
|
88 <td>Private slot to handle the delete breakpoint context menu entry.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#BreakPointViewer.__deleteSelectedBreaks">__deleteSelectedBreaks</a></td> |
|
91 <td>Private slot to handle the delete selected breakpoints context menu entry.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#BreakPointViewer.__disableAllBreaks">__disableAllBreaks</a></td> |
|
94 <td>Private slot to handle the disable all breakpoints context menu entry.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#BreakPointViewer.__disableBreak">__disableBreak</a></td> |
|
97 <td>Private slot to handle the disable breakpoint context menu entry.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#BreakPointViewer.__disableSelectedBreaks">__disableSelectedBreaks</a></td> |
|
100 <td>Private slot to handle the disable selected breakpoints context menu entry.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#BreakPointViewer.__doubleClicked">__doubleClicked</a></td> |
|
103 <td>Private slot to handle the double clicked signal.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#BreakPointViewer.__editBreak">__editBreak</a></td> |
|
106 <td>Private slot to handle the edit breakpoint context menu entry.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#BreakPointViewer.__editBreakpoint">__editBreakpoint</a></td> |
|
109 <td>Private slot to edit a breakpoint.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#BreakPointViewer.__enableAllBreaks">__enableAllBreaks</a></td> |
|
112 <td>Private slot to handle the enable all breakpoints context menu entry.</td> |
|
113 </tr><tr> |
|
114 <td><a href="#BreakPointViewer.__enableBreak">__enableBreak</a></td> |
|
115 <td>Private slot to handle the enable breakpoint context menu entry.</td> |
|
116 </tr><tr> |
|
117 <td><a href="#BreakPointViewer.__enableSelectedBreaks">__enableSelectedBreaks</a></td> |
|
118 <td>Private slot to handle the enable selected breakpoints context menu entry.</td> |
|
119 </tr><tr> |
|
120 <td><a href="#BreakPointViewer.__fromSourceIndex">__fromSourceIndex</a></td> |
|
121 <td>Private slot to convert a source index to an index.</td> |
|
122 </tr><tr> |
|
123 <td><a href="#BreakPointViewer.__getSelectedItemsCount">__getSelectedItemsCount</a></td> |
|
124 <td>Private method to get the count of items selected.</td> |
|
125 </tr><tr> |
|
126 <td><a href="#BreakPointViewer.__layoutDisplay">__layoutDisplay</a></td> |
|
127 <td>Private slot to perform a layout operation.</td> |
|
128 </tr><tr> |
|
129 <td><a href="#BreakPointViewer.__loadRecent">__loadRecent</a></td> |
|
130 <td>Private method to load the recently used file names.</td> |
|
131 </tr><tr> |
|
132 <td><a href="#BreakPointViewer.__resizeColumns">__resizeColumns</a></td> |
|
133 <td>Private slot to resize the view when items get added, edited or deleted.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#BreakPointViewer.__resort">__resort</a></td> |
|
136 <td>Private slot to resort the tree.</td> |
|
137 </tr><tr> |
|
138 <td><a href="#BreakPointViewer.__saveRecent">__saveRecent</a></td> |
|
139 <td>Private method to save the list of recently used file names.</td> |
|
140 </tr><tr> |
|
141 <td><a href="#BreakPointViewer.__setBpEnabled">__setBpEnabled</a></td> |
|
142 <td>Private method to set the enabled status of a breakpoint.</td> |
|
143 </tr><tr> |
|
144 <td><a href="#BreakPointViewer.__setRowSelected">__setRowSelected</a></td> |
|
145 <td>Private slot to select a complete row.</td> |
|
146 </tr><tr> |
|
147 <td><a href="#BreakPointViewer.__showBackMenu">__showBackMenu</a></td> |
|
148 <td>Private slot to handle the aboutToShow signal of the background menu.</td> |
|
149 </tr><tr> |
|
150 <td><a href="#BreakPointViewer.__showContextMenu">__showContextMenu</a></td> |
|
151 <td>Private slot to show the context menu.</td> |
|
152 </tr><tr> |
|
153 <td><a href="#BreakPointViewer.__showSource">__showSource</a></td> |
|
154 <td>Private slot to handle the goto context menu entry.</td> |
|
155 </tr><tr> |
|
156 <td><a href="#BreakPointViewer.__toSourceIndex">__toSourceIndex</a></td> |
|
157 <td>Private slot to convert an index to a source index.</td> |
|
158 </tr><tr> |
|
159 <td><a href="#BreakPointViewer.handleResetUI">handleResetUI</a></td> |
|
160 <td>Public slot to reset the breakpoint viewer.</td> |
|
161 </tr><tr> |
|
162 <td><a href="#BreakPointViewer.highlightBreakpoint">highlightBreakpoint</a></td> |
|
163 <td>Public slot to handle the clientLine signal.</td> |
|
164 </tr><tr> |
|
165 <td><a href="#BreakPointViewer.setModel">setModel</a></td> |
|
166 <td>Public slot to set the breakpoint model.</td> |
|
167 </tr> |
|
168 </table> |
|
169 <h3>Static Methods</h3> |
|
170 <table> |
|
171 <tr><td>None</td></tr> |
|
172 </table> |
|
173 <a NAME="BreakPointViewer.__init__" ID="BreakPointViewer.__init__"></a> |
|
174 <h4>BreakPointViewer (Constructor)</h4> |
|
175 <b>BreakPointViewer</b>(<i>parent=None</i>) |
|
176 <p> |
|
177 Constructor |
|
178 </p><dl> |
|
179 <dt><i>parent</i></dt> |
|
180 <dd> |
|
181 the parent (QWidget) |
|
182 </dd> |
|
183 </dl><a NAME="BreakPointViewer.__addBreak" ID="BreakPointViewer.__addBreak"></a> |
|
184 <h4>BreakPointViewer.__addBreak</h4> |
|
185 <b>__addBreak</b>(<i></i>) |
|
186 <p> |
|
187 Private slot to handle the add breakpoint context menu entry. |
|
188 </p><a NAME="BreakPointViewer.__clearSelection" ID="BreakPointViewer.__clearSelection"></a> |
|
189 <h4>BreakPointViewer.__clearSelection</h4> |
|
190 <b>__clearSelection</b>(<i></i>) |
|
191 <p> |
|
192 Private slot to clear the selection. |
|
193 </p><a NAME="BreakPointViewer.__configure" ID="BreakPointViewer.__configure"></a> |
|
194 <h4>BreakPointViewer.__configure</h4> |
|
195 <b>__configure</b>(<i></i>) |
|
196 <p> |
|
197 Private method to open the configuration dialog. |
|
198 </p><a NAME="BreakPointViewer.__createPopupMenus" ID="BreakPointViewer.__createPopupMenus"></a> |
|
199 <h4>BreakPointViewer.__createPopupMenus</h4> |
|
200 <b>__createPopupMenus</b>(<i></i>) |
|
201 <p> |
|
202 Private method to generate the popup menus. |
|
203 </p><a NAME="BreakPointViewer.__deleteAllBreaks" ID="BreakPointViewer.__deleteAllBreaks"></a> |
|
204 <h4>BreakPointViewer.__deleteAllBreaks</h4> |
|
205 <b>__deleteAllBreaks</b>(<i></i>) |
|
206 <p> |
|
207 Private slot to handle the delete all breakpoints context menu entry. |
|
208 </p><a NAME="BreakPointViewer.__deleteBreak" ID="BreakPointViewer.__deleteBreak"></a> |
|
209 <h4>BreakPointViewer.__deleteBreak</h4> |
|
210 <b>__deleteBreak</b>(<i></i>) |
|
211 <p> |
|
212 Private slot to handle the delete breakpoint context menu entry. |
|
213 </p><a NAME="BreakPointViewer.__deleteSelectedBreaks" ID="BreakPointViewer.__deleteSelectedBreaks"></a> |
|
214 <h4>BreakPointViewer.__deleteSelectedBreaks</h4> |
|
215 <b>__deleteSelectedBreaks</b>(<i></i>) |
|
216 <p> |
|
217 Private slot to handle the delete selected breakpoints context menu |
|
218 entry. |
|
219 </p><a NAME="BreakPointViewer.__disableAllBreaks" ID="BreakPointViewer.__disableAllBreaks"></a> |
|
220 <h4>BreakPointViewer.__disableAllBreaks</h4> |
|
221 <b>__disableAllBreaks</b>(<i></i>) |
|
222 <p> |
|
223 Private slot to handle the disable all breakpoints context menu entry. |
|
224 </p><a NAME="BreakPointViewer.__disableBreak" ID="BreakPointViewer.__disableBreak"></a> |
|
225 <h4>BreakPointViewer.__disableBreak</h4> |
|
226 <b>__disableBreak</b>(<i></i>) |
|
227 <p> |
|
228 Private slot to handle the disable breakpoint context menu entry. |
|
229 </p><a NAME="BreakPointViewer.__disableSelectedBreaks" ID="BreakPointViewer.__disableSelectedBreaks"></a> |
|
230 <h4>BreakPointViewer.__disableSelectedBreaks</h4> |
|
231 <b>__disableSelectedBreaks</b>(<i></i>) |
|
232 <p> |
|
233 Private slot to handle the disable selected breakpoints context menu |
|
234 entry. |
|
235 </p><a NAME="BreakPointViewer.__doubleClicked" ID="BreakPointViewer.__doubleClicked"></a> |
|
236 <h4>BreakPointViewer.__doubleClicked</h4> |
|
237 <b>__doubleClicked</b>(<i>index</i>) |
|
238 <p> |
|
239 Private slot to handle the double clicked signal. |
|
240 </p><dl> |
|
241 <dt><i>index</i></dt> |
|
242 <dd> |
|
243 index of the entry that was double clicked (QModelIndex) |
|
244 </dd> |
|
245 </dl><a NAME="BreakPointViewer.__editBreak" ID="BreakPointViewer.__editBreak"></a> |
|
246 <h4>BreakPointViewer.__editBreak</h4> |
|
247 <b>__editBreak</b>(<i></i>) |
|
248 <p> |
|
249 Private slot to handle the edit breakpoint context menu entry. |
|
250 </p><a NAME="BreakPointViewer.__editBreakpoint" ID="BreakPointViewer.__editBreakpoint"></a> |
|
251 <h4>BreakPointViewer.__editBreakpoint</h4> |
|
252 <b>__editBreakpoint</b>(<i>index</i>) |
|
253 <p> |
|
254 Private slot to edit a breakpoint. |
|
255 </p><dl> |
|
256 <dt><i>index</i></dt> |
|
257 <dd> |
|
258 index of breakpoint to be edited (QModelIndex) |
|
259 </dd> |
|
260 </dl><a NAME="BreakPointViewer.__enableAllBreaks" ID="BreakPointViewer.__enableAllBreaks"></a> |
|
261 <h4>BreakPointViewer.__enableAllBreaks</h4> |
|
262 <b>__enableAllBreaks</b>(<i></i>) |
|
263 <p> |
|
264 Private slot to handle the enable all breakpoints context menu entry. |
|
265 </p><a NAME="BreakPointViewer.__enableBreak" ID="BreakPointViewer.__enableBreak"></a> |
|
266 <h4>BreakPointViewer.__enableBreak</h4> |
|
267 <b>__enableBreak</b>(<i></i>) |
|
268 <p> |
|
269 Private slot to handle the enable breakpoint context menu entry. |
|
270 </p><a NAME="BreakPointViewer.__enableSelectedBreaks" ID="BreakPointViewer.__enableSelectedBreaks"></a> |
|
271 <h4>BreakPointViewer.__enableSelectedBreaks</h4> |
|
272 <b>__enableSelectedBreaks</b>(<i></i>) |
|
273 <p> |
|
274 Private slot to handle the enable selected breakpoints context menu |
|
275 entry. |
|
276 </p><a NAME="BreakPointViewer.__fromSourceIndex" ID="BreakPointViewer.__fromSourceIndex"></a> |
|
277 <h4>BreakPointViewer.__fromSourceIndex</h4> |
|
278 <b>__fromSourceIndex</b>(<i>sindex</i>) |
|
279 <p> |
|
280 Private slot to convert a source index to an index. |
|
281 </p><dl> |
|
282 <dt><i>sindex</i></dt> |
|
283 <dd> |
|
284 source index to be converted (QModelIndex) |
|
285 </dd> |
|
286 </dl><dl> |
|
287 <dt>Returns:</dt> |
|
288 <dd> |
|
289 mapped index (QModelIndex) |
|
290 </dd> |
|
291 </dl><a NAME="BreakPointViewer.__getSelectedItemsCount" ID="BreakPointViewer.__getSelectedItemsCount"></a> |
|
292 <h4>BreakPointViewer.__getSelectedItemsCount</h4> |
|
293 <b>__getSelectedItemsCount</b>(<i></i>) |
|
294 <p> |
|
295 Private method to get the count of items selected. |
|
296 </p><dl> |
|
297 <dt>Returns:</dt> |
|
298 <dd> |
|
299 count of items selected (integer) |
|
300 </dd> |
|
301 </dl><a NAME="BreakPointViewer.__layoutDisplay" ID="BreakPointViewer.__layoutDisplay"></a> |
|
302 <h4>BreakPointViewer.__layoutDisplay</h4> |
|
303 <b>__layoutDisplay</b>(<i></i>) |
|
304 <p> |
|
305 Private slot to perform a layout operation. |
|
306 </p><a NAME="BreakPointViewer.__loadRecent" ID="BreakPointViewer.__loadRecent"></a> |
|
307 <h4>BreakPointViewer.__loadRecent</h4> |
|
308 <b>__loadRecent</b>(<i></i>) |
|
309 <p> |
|
310 Private method to load the recently used file names. |
|
311 </p><a NAME="BreakPointViewer.__resizeColumns" ID="BreakPointViewer.__resizeColumns"></a> |
|
312 <h4>BreakPointViewer.__resizeColumns</h4> |
|
313 <b>__resizeColumns</b>(<i></i>) |
|
314 <p> |
|
315 Private slot to resize the view when items get added, edited or |
|
316 deleted. |
|
317 </p><a NAME="BreakPointViewer.__resort" ID="BreakPointViewer.__resort"></a> |
|
318 <h4>BreakPointViewer.__resort</h4> |
|
319 <b>__resort</b>(<i></i>) |
|
320 <p> |
|
321 Private slot to resort the tree. |
|
322 </p><a NAME="BreakPointViewer.__saveRecent" ID="BreakPointViewer.__saveRecent"></a> |
|
323 <h4>BreakPointViewer.__saveRecent</h4> |
|
324 <b>__saveRecent</b>(<i></i>) |
|
325 <p> |
|
326 Private method to save the list of recently used file names. |
|
327 </p><a NAME="BreakPointViewer.__setBpEnabled" ID="BreakPointViewer.__setBpEnabled"></a> |
|
328 <h4>BreakPointViewer.__setBpEnabled</h4> |
|
329 <b>__setBpEnabled</b>(<i>index, enabled</i>) |
|
330 <p> |
|
331 Private method to set the enabled status of a breakpoint. |
|
332 </p><dl> |
|
333 <dt><i>index</i></dt> |
|
334 <dd> |
|
335 index of breakpoint to be enabled/disabled (QModelIndex) |
|
336 </dd><dt><i>enabled</i></dt> |
|
337 <dd> |
|
338 flag indicating the enabled status to be set (boolean) |
|
339 </dd> |
|
340 </dl><a NAME="BreakPointViewer.__setRowSelected" ID="BreakPointViewer.__setRowSelected"></a> |
|
341 <h4>BreakPointViewer.__setRowSelected</h4> |
|
342 <b>__setRowSelected</b>(<i>index, selected=True</i>) |
|
343 <p> |
|
344 Private slot to select a complete row. |
|
345 </p><dl> |
|
346 <dt><i>index</i></dt> |
|
347 <dd> |
|
348 index determining the row to be selected (QModelIndex) |
|
349 </dd><dt><i>selected</i></dt> |
|
350 <dd> |
|
351 flag indicating the action (bool) |
|
352 </dd> |
|
353 </dl><a NAME="BreakPointViewer.__showBackMenu" ID="BreakPointViewer.__showBackMenu"></a> |
|
354 <h4>BreakPointViewer.__showBackMenu</h4> |
|
355 <b>__showBackMenu</b>(<i></i>) |
|
356 <p> |
|
357 Private slot to handle the aboutToShow signal of the background menu. |
|
358 </p><a NAME="BreakPointViewer.__showContextMenu" ID="BreakPointViewer.__showContextMenu"></a> |
|
359 <h4>BreakPointViewer.__showContextMenu</h4> |
|
360 <b>__showContextMenu</b>(<i>coord</i>) |
|
361 <p> |
|
362 Private slot to show the context menu. |
|
363 </p><dl> |
|
364 <dt><i>coord</i></dt> |
|
365 <dd> |
|
366 the position of the mouse pointer (QPoint) |
|
367 </dd> |
|
368 </dl><a NAME="BreakPointViewer.__showSource" ID="BreakPointViewer.__showSource"></a> |
|
369 <h4>BreakPointViewer.__showSource</h4> |
|
370 <b>__showSource</b>(<i></i>) |
|
371 <p> |
|
372 Private slot to handle the goto context menu entry. |
|
373 </p><a NAME="BreakPointViewer.__toSourceIndex" ID="BreakPointViewer.__toSourceIndex"></a> |
|
374 <h4>BreakPointViewer.__toSourceIndex</h4> |
|
375 <b>__toSourceIndex</b>(<i>index</i>) |
|
376 <p> |
|
377 Private slot to convert an index to a source index. |
|
378 </p><dl> |
|
379 <dt><i>index</i></dt> |
|
380 <dd> |
|
381 index to be converted (QModelIndex) |
|
382 </dd> |
|
383 </dl><dl> |
|
384 <dt>Returns:</dt> |
|
385 <dd> |
|
386 mapped index (QModelIndex) |
|
387 </dd> |
|
388 </dl><a NAME="BreakPointViewer.handleResetUI" ID="BreakPointViewer.handleResetUI"></a> |
|
389 <h4>BreakPointViewer.handleResetUI</h4> |
|
390 <b>handleResetUI</b>(<i></i>) |
|
391 <p> |
|
392 Public slot to reset the breakpoint viewer. |
|
393 </p><a NAME="BreakPointViewer.highlightBreakpoint" ID="BreakPointViewer.highlightBreakpoint"></a> |
|
394 <h4>BreakPointViewer.highlightBreakpoint</h4> |
|
395 <b>highlightBreakpoint</b>(<i>fn, lineno</i>) |
|
396 <p> |
|
397 Public slot to handle the clientLine signal. |
|
398 </p><dl> |
|
399 <dt><i>fn</i></dt> |
|
400 <dd> |
|
401 filename of the breakpoint (string) |
|
402 </dd><dt><i>lineno</i></dt> |
|
403 <dd> |
|
404 line number of the breakpoint (integer) |
|
405 </dd> |
|
406 </dl><a NAME="BreakPointViewer.setModel" ID="BreakPointViewer.setModel"></a> |
|
407 <h4>BreakPointViewer.setModel</h4> |
|
408 <b>setModel</b>(<i>model</i>) |
|
409 <p> |
|
410 Public slot to set the breakpoint model. |
|
411 </p><dl> |
|
412 <dt><i>model</i></dt> |
|
413 <dd> |
|
414 reference to the breakpoint model (BreakPointModel) |
|
415 </dd> |
|
416 </dl> |
|
417 <div align="right"><a href="#top">Up</a></div> |
|
418 <hr /> |
|
419 </body></html> |