Documentation/Source/eric4.Debugger.BreakPointViewer.html

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

eric ide

mercurial