Documentation/Source/eric6.Debugger.BreakPointViewer.html

changeset 3673
e26d7d0c1088
child 6034
4f88f70d2cd4
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
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.__resizeColumns">__resizeColumns</a></td>
130 <td>Private slot to resize the view when items get added, edited or deleted.</td>
131 </tr><tr>
132 <td><a href="#BreakPointViewer.__resort">__resort</a></td>
133 <td>Private slot to resort the tree.</td>
134 </tr><tr>
135 <td><a href="#BreakPointViewer.__setBpEnabled">__setBpEnabled</a></td>
136 <td>Private method to set the enabled status of a breakpoint.</td>
137 </tr><tr>
138 <td><a href="#BreakPointViewer.__setRowSelected">__setRowSelected</a></td>
139 <td>Private slot to select a complete row.</td>
140 </tr><tr>
141 <td><a href="#BreakPointViewer.__showBackMenu">__showBackMenu</a></td>
142 <td>Private slot to handle the aboutToShow signal of the background menu.</td>
143 </tr><tr>
144 <td><a href="#BreakPointViewer.__showContextMenu">__showContextMenu</a></td>
145 <td>Private slot to show the context menu.</td>
146 </tr><tr>
147 <td><a href="#BreakPointViewer.__showSource">__showSource</a></td>
148 <td>Private slot to handle the goto context menu entry.</td>
149 </tr><tr>
150 <td><a href="#BreakPointViewer.__toSourceIndex">__toSourceIndex</a></td>
151 <td>Private slot to convert an index to a source index.</td>
152 </tr><tr>
153 <td><a href="#BreakPointViewer.handleResetUI">handleResetUI</a></td>
154 <td>Public slot to reset the breakpoint viewer.</td>
155 </tr><tr>
156 <td><a href="#BreakPointViewer.highlightBreakpoint">highlightBreakpoint</a></td>
157 <td>Public slot to handle the clientLine signal.</td>
158 </tr><tr>
159 <td><a href="#BreakPointViewer.setModel">setModel</a></td>
160 <td>Public slot to set the breakpoint model.</td>
161 </tr>
162 </table>
163 <h3>Static Methods</h3>
164 <table>
165 <tr><td>None</td></tr>
166 </table>
167 <a NAME="BreakPointViewer.__init__" ID="BreakPointViewer.__init__"></a>
168 <h4>BreakPointViewer (Constructor)</h4>
169 <b>BreakPointViewer</b>(<i>parent=None</i>)
170 <p>
171 Constructor
172 </p><dl>
173 <dt><i>parent</i></dt>
174 <dd>
175 the parent (QWidget)
176 </dd>
177 </dl><a NAME="BreakPointViewer.__addBreak" ID="BreakPointViewer.__addBreak"></a>
178 <h4>BreakPointViewer.__addBreak</h4>
179 <b>__addBreak</b>(<i></i>)
180 <p>
181 Private slot to handle the add breakpoint context menu entry.
182 </p><a NAME="BreakPointViewer.__clearSelection" ID="BreakPointViewer.__clearSelection"></a>
183 <h4>BreakPointViewer.__clearSelection</h4>
184 <b>__clearSelection</b>(<i></i>)
185 <p>
186 Private slot to clear the selection.
187 </p><a NAME="BreakPointViewer.__configure" ID="BreakPointViewer.__configure"></a>
188 <h4>BreakPointViewer.__configure</h4>
189 <b>__configure</b>(<i></i>)
190 <p>
191 Private method to open the configuration dialog.
192 </p><a NAME="BreakPointViewer.__createPopupMenus" ID="BreakPointViewer.__createPopupMenus"></a>
193 <h4>BreakPointViewer.__createPopupMenus</h4>
194 <b>__createPopupMenus</b>(<i></i>)
195 <p>
196 Private method to generate the popup menus.
197 </p><a NAME="BreakPointViewer.__deleteAllBreaks" ID="BreakPointViewer.__deleteAllBreaks"></a>
198 <h4>BreakPointViewer.__deleteAllBreaks</h4>
199 <b>__deleteAllBreaks</b>(<i></i>)
200 <p>
201 Private slot to handle the delete all breakpoints context menu entry.
202 </p><a NAME="BreakPointViewer.__deleteBreak" ID="BreakPointViewer.__deleteBreak"></a>
203 <h4>BreakPointViewer.__deleteBreak</h4>
204 <b>__deleteBreak</b>(<i></i>)
205 <p>
206 Private slot to handle the delete breakpoint context menu entry.
207 </p><a NAME="BreakPointViewer.__deleteSelectedBreaks" ID="BreakPointViewer.__deleteSelectedBreaks"></a>
208 <h4>BreakPointViewer.__deleteSelectedBreaks</h4>
209 <b>__deleteSelectedBreaks</b>(<i></i>)
210 <p>
211 Private slot to handle the delete selected breakpoints context menu
212 entry.
213 </p><a NAME="BreakPointViewer.__disableAllBreaks" ID="BreakPointViewer.__disableAllBreaks"></a>
214 <h4>BreakPointViewer.__disableAllBreaks</h4>
215 <b>__disableAllBreaks</b>(<i></i>)
216 <p>
217 Private slot to handle the disable all breakpoints context menu entry.
218 </p><a NAME="BreakPointViewer.__disableBreak" ID="BreakPointViewer.__disableBreak"></a>
219 <h4>BreakPointViewer.__disableBreak</h4>
220 <b>__disableBreak</b>(<i></i>)
221 <p>
222 Private slot to handle the disable breakpoint context menu entry.
223 </p><a NAME="BreakPointViewer.__disableSelectedBreaks" ID="BreakPointViewer.__disableSelectedBreaks"></a>
224 <h4>BreakPointViewer.__disableSelectedBreaks</h4>
225 <b>__disableSelectedBreaks</b>(<i></i>)
226 <p>
227 Private slot to handle the disable selected breakpoints context menu
228 entry.
229 </p><a NAME="BreakPointViewer.__doubleClicked" ID="BreakPointViewer.__doubleClicked"></a>
230 <h4>BreakPointViewer.__doubleClicked</h4>
231 <b>__doubleClicked</b>(<i>index</i>)
232 <p>
233 Private slot to handle the double clicked signal.
234 </p><dl>
235 <dt><i>index</i></dt>
236 <dd>
237 index of the entry that was double clicked (QModelIndex)
238 </dd>
239 </dl><a NAME="BreakPointViewer.__editBreak" ID="BreakPointViewer.__editBreak"></a>
240 <h4>BreakPointViewer.__editBreak</h4>
241 <b>__editBreak</b>(<i></i>)
242 <p>
243 Private slot to handle the edit breakpoint context menu entry.
244 </p><a NAME="BreakPointViewer.__editBreakpoint" ID="BreakPointViewer.__editBreakpoint"></a>
245 <h4>BreakPointViewer.__editBreakpoint</h4>
246 <b>__editBreakpoint</b>(<i>index</i>)
247 <p>
248 Private slot to edit a breakpoint.
249 </p><dl>
250 <dt><i>index</i></dt>
251 <dd>
252 index of breakpoint to be edited (QModelIndex)
253 </dd>
254 </dl><a NAME="BreakPointViewer.__enableAllBreaks" ID="BreakPointViewer.__enableAllBreaks"></a>
255 <h4>BreakPointViewer.__enableAllBreaks</h4>
256 <b>__enableAllBreaks</b>(<i></i>)
257 <p>
258 Private slot to handle the enable all breakpoints context menu entry.
259 </p><a NAME="BreakPointViewer.__enableBreak" ID="BreakPointViewer.__enableBreak"></a>
260 <h4>BreakPointViewer.__enableBreak</h4>
261 <b>__enableBreak</b>(<i></i>)
262 <p>
263 Private slot to handle the enable breakpoint context menu entry.
264 </p><a NAME="BreakPointViewer.__enableSelectedBreaks" ID="BreakPointViewer.__enableSelectedBreaks"></a>
265 <h4>BreakPointViewer.__enableSelectedBreaks</h4>
266 <b>__enableSelectedBreaks</b>(<i></i>)
267 <p>
268 Private slot to handle the enable selected breakpoints context menu
269 entry.
270 </p><a NAME="BreakPointViewer.__fromSourceIndex" ID="BreakPointViewer.__fromSourceIndex"></a>
271 <h4>BreakPointViewer.__fromSourceIndex</h4>
272 <b>__fromSourceIndex</b>(<i>sindex</i>)
273 <p>
274 Private slot to convert a source index to an index.
275 </p><dl>
276 <dt><i>sindex</i></dt>
277 <dd>
278 source index to be converted (QModelIndex)
279 </dd>
280 </dl><dl>
281 <dt>Returns:</dt>
282 <dd>
283 mapped index (QModelIndex)
284 </dd>
285 </dl><a NAME="BreakPointViewer.__getSelectedItemsCount" ID="BreakPointViewer.__getSelectedItemsCount"></a>
286 <h4>BreakPointViewer.__getSelectedItemsCount</h4>
287 <b>__getSelectedItemsCount</b>(<i></i>)
288 <p>
289 Private method to get the count of items selected.
290 </p><dl>
291 <dt>Returns:</dt>
292 <dd>
293 count of items selected (integer)
294 </dd>
295 </dl><a NAME="BreakPointViewer.__layoutDisplay" ID="BreakPointViewer.__layoutDisplay"></a>
296 <h4>BreakPointViewer.__layoutDisplay</h4>
297 <b>__layoutDisplay</b>(<i></i>)
298 <p>
299 Private slot to perform a layout operation.
300 </p><a NAME="BreakPointViewer.__resizeColumns" ID="BreakPointViewer.__resizeColumns"></a>
301 <h4>BreakPointViewer.__resizeColumns</h4>
302 <b>__resizeColumns</b>(<i></i>)
303 <p>
304 Private slot to resize the view when items get added, edited or
305 deleted.
306 </p><a NAME="BreakPointViewer.__resort" ID="BreakPointViewer.__resort"></a>
307 <h4>BreakPointViewer.__resort</h4>
308 <b>__resort</b>(<i></i>)
309 <p>
310 Private slot to resort the tree.
311 </p><a NAME="BreakPointViewer.__setBpEnabled" ID="BreakPointViewer.__setBpEnabled"></a>
312 <h4>BreakPointViewer.__setBpEnabled</h4>
313 <b>__setBpEnabled</b>(<i>index, enabled</i>)
314 <p>
315 Private method to set the enabled status of a breakpoint.
316 </p><dl>
317 <dt><i>index</i></dt>
318 <dd>
319 index of breakpoint to be enabled/disabled (QModelIndex)
320 </dd><dt><i>enabled</i></dt>
321 <dd>
322 flag indicating the enabled status to be set (boolean)
323 </dd>
324 </dl><a NAME="BreakPointViewer.__setRowSelected" ID="BreakPointViewer.__setRowSelected"></a>
325 <h4>BreakPointViewer.__setRowSelected</h4>
326 <b>__setRowSelected</b>(<i>index, selected=True</i>)
327 <p>
328 Private slot to select a complete row.
329 </p><dl>
330 <dt><i>index</i></dt>
331 <dd>
332 index determining the row to be selected (QModelIndex)
333 </dd><dt><i>selected</i></dt>
334 <dd>
335 flag indicating the action (bool)
336 </dd>
337 </dl><a NAME="BreakPointViewer.__showBackMenu" ID="BreakPointViewer.__showBackMenu"></a>
338 <h4>BreakPointViewer.__showBackMenu</h4>
339 <b>__showBackMenu</b>(<i></i>)
340 <p>
341 Private slot to handle the aboutToShow signal of the background menu.
342 </p><a NAME="BreakPointViewer.__showContextMenu" ID="BreakPointViewer.__showContextMenu"></a>
343 <h4>BreakPointViewer.__showContextMenu</h4>
344 <b>__showContextMenu</b>(<i>coord</i>)
345 <p>
346 Private slot to show the context menu.
347 </p><dl>
348 <dt><i>coord</i></dt>
349 <dd>
350 the position of the mouse pointer (QPoint)
351 </dd>
352 </dl><a NAME="BreakPointViewer.__showSource" ID="BreakPointViewer.__showSource"></a>
353 <h4>BreakPointViewer.__showSource</h4>
354 <b>__showSource</b>(<i></i>)
355 <p>
356 Private slot to handle the goto context menu entry.
357 </p><a NAME="BreakPointViewer.__toSourceIndex" ID="BreakPointViewer.__toSourceIndex"></a>
358 <h4>BreakPointViewer.__toSourceIndex</h4>
359 <b>__toSourceIndex</b>(<i>index</i>)
360 <p>
361 Private slot to convert an index to a source index.
362 </p><dl>
363 <dt><i>index</i></dt>
364 <dd>
365 index to be converted (QModelIndex)
366 </dd>
367 </dl><dl>
368 <dt>Returns:</dt>
369 <dd>
370 mapped index (QModelIndex)
371 </dd>
372 </dl><a NAME="BreakPointViewer.handleResetUI" ID="BreakPointViewer.handleResetUI"></a>
373 <h4>BreakPointViewer.handleResetUI</h4>
374 <b>handleResetUI</b>(<i></i>)
375 <p>
376 Public slot to reset the breakpoint viewer.
377 </p><a NAME="BreakPointViewer.highlightBreakpoint" ID="BreakPointViewer.highlightBreakpoint"></a>
378 <h4>BreakPointViewer.highlightBreakpoint</h4>
379 <b>highlightBreakpoint</b>(<i>fn, lineno</i>)
380 <p>
381 Public slot to handle the clientLine signal.
382 </p><dl>
383 <dt><i>fn</i></dt>
384 <dd>
385 filename of the breakpoint (string)
386 </dd><dt><i>lineno</i></dt>
387 <dd>
388 line number of the breakpoint (integer)
389 </dd>
390 </dl><a NAME="BreakPointViewer.setModel" ID="BreakPointViewer.setModel"></a>
391 <h4>BreakPointViewer.setModel</h4>
392 <b>setModel</b>(<i>model</i>)
393 <p>
394 Public slot to set the breakpoint model.
395 </p><dl>
396 <dt><i>model</i></dt>
397 <dd>
398 reference to the breakpoint model (BreakPointModel)
399 </dd>
400 </dl>
401 <div align="right"><a href="#top">Up</a></div>
402 <hr />
403 </body></html>

eric ide

mercurial