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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10417
c6011e501282
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Debugger.WatchPointViewer</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.WatchPointViewer</h1>
10
11 <p>
12 Module implementing the watch expression viewer widget.
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="#WatchPointViewer">WatchPointViewer</a></td>
25 <td>Class implementing the watch expression viewer widget.</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="WatchPointViewer" ID="WatchPointViewer"></a>
36 <h2>WatchPointViewer</h2>
37
38 <p>
39 Class implementing the watch expression viewer widget.
40 </p>
41 <p>
42 Watch expressions will be shown with all their details. They can be
43 modified through the context menu of this widget.
44 </p>
45 <h3>Derived from</h3>
46 QTreeView
47 <h3>Class Attributes</h3>
48
49 <table>
50 <tr><td>None</td></tr>
51 </table>
52 <h3>Class Methods</h3>
53
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58
59 <table>
60
61 <tr>
62 <td><a href="#WatchPointViewer.__init__">WatchPointViewer</a></td>
63 <td>Constructor</td>
64 </tr>
65 <tr>
66 <td><a href="#WatchPointViewer.__addWatchPoint">__addWatchPoint</a></td>
67 <td>Private slot to handle the add watch expression context menu entry.</td>
68 </tr>
69 <tr>
70 <td><a href="#WatchPointViewer.__clearSelection">__clearSelection</a></td>
71 <td>Private slot to clear the selection.</td>
72 </tr>
73 <tr>
74 <td><a href="#WatchPointViewer.__configure">__configure</a></td>
75 <td>Private method to open the configuration dialog.</td>
76 </tr>
77 <tr>
78 <td><a href="#WatchPointViewer.__createPopupMenus">__createPopupMenus</a></td>
79 <td>Private method to generate the popup menus.</td>
80 </tr>
81 <tr>
82 <td><a href="#WatchPointViewer.__deleteAllWatchPoints">__deleteAllWatchPoints</a></td>
83 <td>Private slot to handle the delete all watch expressions context menu entry.</td>
84 </tr>
85 <tr>
86 <td><a href="#WatchPointViewer.__deleteSelectedWatchPoints">__deleteSelectedWatchPoints</a></td>
87 <td>Private slot to handle the delete selected watch expressions context menu entry.</td>
88 </tr>
89 <tr>
90 <td><a href="#WatchPointViewer.__deleteWatchPoint">__deleteWatchPoint</a></td>
91 <td>Private slot to handle the delete watch expression context menu entry.</td>
92 </tr>
93 <tr>
94 <td><a href="#WatchPointViewer.__disableAllWatchPoints">__disableAllWatchPoints</a></td>
95 <td>Private slot to handle the disable all watch expressions context menu entry.</td>
96 </tr>
97 <tr>
98 <td><a href="#WatchPointViewer.__disableSelectedWatchPoints">__disableSelectedWatchPoints</a></td>
99 <td>Private slot to handle the disable selected watch expressions context menu entry.</td>
100 </tr>
101 <tr>
102 <td><a href="#WatchPointViewer.__disableWatchPoint">__disableWatchPoint</a></td>
103 <td>Private slot to handle the disable watch expression context menu entry.</td>
104 </tr>
105 <tr>
106 <td><a href="#WatchPointViewer.__doEditWatchPoint">__doEditWatchPoint</a></td>
107 <td>Private slot to edit a watch expression.</td>
108 </tr>
109 <tr>
110 <td><a href="#WatchPointViewer.__doubleClicked">__doubleClicked</a></td>
111 <td>Private slot to handle the double clicked signal.</td>
112 </tr>
113 <tr>
114 <td><a href="#WatchPointViewer.__editWatchPoint">__editWatchPoint</a></td>
115 <td>Private slot to handle the edit watch expression context menu entry.</td>
116 </tr>
117 <tr>
118 <td><a href="#WatchPointViewer.__enableAllWatchPoints">__enableAllWatchPoints</a></td>
119 <td>Private slot to handle the enable all watch expressions context menu entry.</td>
120 </tr>
121 <tr>
122 <td><a href="#WatchPointViewer.__enableSelectedWatchPoints">__enableSelectedWatchPoints</a></td>
123 <td>Private slot to handle the enable selected watch expressions context menu entry.</td>
124 </tr>
125 <tr>
126 <td><a href="#WatchPointViewer.__enableWatchPoint">__enableWatchPoint</a></td>
127 <td>Private slot to handle the enable watch expression context menu entry.</td>
128 </tr>
129 <tr>
130 <td><a href="#WatchPointViewer.__findDuplicates">__findDuplicates</a></td>
131 <td>Private method to check, if an entry already exists.</td>
132 </tr>
133 <tr>
134 <td><a href="#WatchPointViewer.__fromSourceIndex">__fromSourceIndex</a></td>
135 <td>Private slot to convert a source index to an index.</td>
136 </tr>
137 <tr>
138 <td><a href="#WatchPointViewer.__getSelectedItemsCount">__getSelectedItemsCount</a></td>
139 <td>Private method to get the count of items selected.</td>
140 </tr>
141 <tr>
142 <td><a href="#WatchPointViewer.__layoutDisplay">__layoutDisplay</a></td>
143 <td>Private slot to perform a layout operation.</td>
144 </tr>
145 <tr>
146 <td><a href="#WatchPointViewer.__resizeColumns">__resizeColumns</a></td>
147 <td>Private slot to resize the view when items get added, edited or deleted.</td>
148 </tr>
149 <tr>
150 <td><a href="#WatchPointViewer.__resort">__resort</a></td>
151 <td>Private slot to resort the tree.</td>
152 </tr>
153 <tr>
154 <td><a href="#WatchPointViewer.__setRowSelected">__setRowSelected</a></td>
155 <td>Private slot to select a complete row.</td>
156 </tr>
157 <tr>
158 <td><a href="#WatchPointViewer.__setWpEnabled">__setWpEnabled</a></td>
159 <td>Private method to set the enabled status of a watch expression.</td>
160 </tr>
161 <tr>
162 <td><a href="#WatchPointViewer.__showBackMenu">__showBackMenu</a></td>
163 <td>Private slot to handle the aboutToShow signal of the background menu.</td>
164 </tr>
165 <tr>
166 <td><a href="#WatchPointViewer.__showContextMenu">__showContextMenu</a></td>
167 <td>Private slot to show the context menu.</td>
168 </tr>
169 <tr>
170 <td><a href="#WatchPointViewer.__toSourceIndex">__toSourceIndex</a></td>
171 <td>Private slot to convert an index to a source index.</td>
172 </tr>
173 <tr>
174 <td><a href="#WatchPointViewer.setModel">setModel</a></td>
175 <td>Public slot to set the watch expression model.</td>
176 </tr>
177 </table>
178 <h3>Static Methods</h3>
179
180 <table>
181 <tr><td>None</td></tr>
182 </table>
183
184 <a NAME="WatchPointViewer.__init__" ID="WatchPointViewer.__init__"></a>
185 <h4>WatchPointViewer (Constructor)</h4>
186 <b>WatchPointViewer</b>(<i>parent=None</i>)
187
188 <p>
189 Constructor
190 </p>
191 <dl>
192
193 <dt><i>parent</i></dt>
194 <dd>
195 the parent (QWidget)
196 </dd>
197 </dl>
198 <a NAME="WatchPointViewer.__addWatchPoint" ID="WatchPointViewer.__addWatchPoint"></a>
199 <h4>WatchPointViewer.__addWatchPoint</h4>
200 <b>__addWatchPoint</b>(<i></i>)
201
202 <p>
203 Private slot to handle the add watch expression context menu entry.
204 </p>
205 <a NAME="WatchPointViewer.__clearSelection" ID="WatchPointViewer.__clearSelection"></a>
206 <h4>WatchPointViewer.__clearSelection</h4>
207 <b>__clearSelection</b>(<i></i>)
208
209 <p>
210 Private slot to clear the selection.
211 </p>
212 <a NAME="WatchPointViewer.__configure" ID="WatchPointViewer.__configure"></a>
213 <h4>WatchPointViewer.__configure</h4>
214 <b>__configure</b>(<i></i>)
215
216 <p>
217 Private method to open the configuration dialog.
218 </p>
219 <a NAME="WatchPointViewer.__createPopupMenus" ID="WatchPointViewer.__createPopupMenus"></a>
220 <h4>WatchPointViewer.__createPopupMenus</h4>
221 <b>__createPopupMenus</b>(<i></i>)
222
223 <p>
224 Private method to generate the popup menus.
225 </p>
226 <a NAME="WatchPointViewer.__deleteAllWatchPoints" ID="WatchPointViewer.__deleteAllWatchPoints"></a>
227 <h4>WatchPointViewer.__deleteAllWatchPoints</h4>
228 <b>__deleteAllWatchPoints</b>(<i></i>)
229
230 <p>
231 Private slot to handle the delete all watch expressions context menu
232 entry.
233 </p>
234 <a NAME="WatchPointViewer.__deleteSelectedWatchPoints" ID="WatchPointViewer.__deleteSelectedWatchPoints"></a>
235 <h4>WatchPointViewer.__deleteSelectedWatchPoints</h4>
236 <b>__deleteSelectedWatchPoints</b>(<i></i>)
237
238 <p>
239 Private slot to handle the delete selected watch expressions context
240 menu entry.
241 </p>
242 <a NAME="WatchPointViewer.__deleteWatchPoint" ID="WatchPointViewer.__deleteWatchPoint"></a>
243 <h4>WatchPointViewer.__deleteWatchPoint</h4>
244 <b>__deleteWatchPoint</b>(<i></i>)
245
246 <p>
247 Private slot to handle the delete watch expression context menu entry.
248 </p>
249 <a NAME="WatchPointViewer.__disableAllWatchPoints" ID="WatchPointViewer.__disableAllWatchPoints"></a>
250 <h4>WatchPointViewer.__disableAllWatchPoints</h4>
251 <b>__disableAllWatchPoints</b>(<i></i>)
252
253 <p>
254 Private slot to handle the disable all watch expressions context menu
255 entry.
256 </p>
257 <a NAME="WatchPointViewer.__disableSelectedWatchPoints" ID="WatchPointViewer.__disableSelectedWatchPoints"></a>
258 <h4>WatchPointViewer.__disableSelectedWatchPoints</h4>
259 <b>__disableSelectedWatchPoints</b>(<i></i>)
260
261 <p>
262 Private slot to handle the disable selected watch expressions context
263 menu entry.
264 </p>
265 <a NAME="WatchPointViewer.__disableWatchPoint" ID="WatchPointViewer.__disableWatchPoint"></a>
266 <h4>WatchPointViewer.__disableWatchPoint</h4>
267 <b>__disableWatchPoint</b>(<i></i>)
268
269 <p>
270 Private slot to handle the disable watch expression context menu entry.
271 </p>
272 <a NAME="WatchPointViewer.__doEditWatchPoint" ID="WatchPointViewer.__doEditWatchPoint"></a>
273 <h4>WatchPointViewer.__doEditWatchPoint</h4>
274 <b>__doEditWatchPoint</b>(<i>index</i>)
275
276 <p>
277 Private slot to edit a watch expression.
278 </p>
279 <dl>
280
281 <dt><i>index</i></dt>
282 <dd>
283 index of watch expression to be edited (QModelIndex)
284 </dd>
285 </dl>
286 <a NAME="WatchPointViewer.__doubleClicked" ID="WatchPointViewer.__doubleClicked"></a>
287 <h4>WatchPointViewer.__doubleClicked</h4>
288 <b>__doubleClicked</b>(<i>index</i>)
289
290 <p>
291 Private slot to handle the double clicked signal.
292 </p>
293 <dl>
294
295 <dt><i>index</i></dt>
296 <dd>
297 index of the entry that was double clicked (QModelIndex)
298 </dd>
299 </dl>
300 <a NAME="WatchPointViewer.__editWatchPoint" ID="WatchPointViewer.__editWatchPoint"></a>
301 <h4>WatchPointViewer.__editWatchPoint</h4>
302 <b>__editWatchPoint</b>(<i></i>)
303
304 <p>
305 Private slot to handle the edit watch expression context menu entry.
306 </p>
307 <a NAME="WatchPointViewer.__enableAllWatchPoints" ID="WatchPointViewer.__enableAllWatchPoints"></a>
308 <h4>WatchPointViewer.__enableAllWatchPoints</h4>
309 <b>__enableAllWatchPoints</b>(<i></i>)
310
311 <p>
312 Private slot to handle the enable all watch expressions context menu
313 entry.
314 </p>
315 <a NAME="WatchPointViewer.__enableSelectedWatchPoints" ID="WatchPointViewer.__enableSelectedWatchPoints"></a>
316 <h4>WatchPointViewer.__enableSelectedWatchPoints</h4>
317 <b>__enableSelectedWatchPoints</b>(<i></i>)
318
319 <p>
320 Private slot to handle the enable selected watch expressions context
321 menu entry.
322 </p>
323 <a NAME="WatchPointViewer.__enableWatchPoint" ID="WatchPointViewer.__enableWatchPoint"></a>
324 <h4>WatchPointViewer.__enableWatchPoint</h4>
325 <b>__enableWatchPoint</b>(<i></i>)
326
327 <p>
328 Private slot to handle the enable watch expression context menu entry.
329 </p>
330 <a NAME="WatchPointViewer.__findDuplicates" ID="WatchPointViewer.__findDuplicates"></a>
331 <h4>WatchPointViewer.__findDuplicates</h4>
332 <b>__findDuplicates</b>(<i>cond, special, showMessage=False, index=None</i>)
333
334 <p>
335 Private method to check, if an entry already exists.
336 </p>
337 <dl>
338
339 <dt><i>cond</i></dt>
340 <dd>
341 condition to check (string)
342 </dd>
343 <dt><i>special</i></dt>
344 <dd>
345 special condition to check (string)
346 </dd>
347 <dt><i>showMessage</i></dt>
348 <dd>
349 flag indicating a message should be shown,
350 if a duplicate entry is found (boolean)
351 </dd>
352 <dt><i>index</i></dt>
353 <dd>
354 index that should not be considered duplicate
355 (QModelIndex)
356 </dd>
357 </dl>
358 <dl>
359 <dt>Return:</dt>
360 <dd>
361 flag indicating a duplicate entry (boolean)
362 </dd>
363 </dl>
364 <a NAME="WatchPointViewer.__fromSourceIndex" ID="WatchPointViewer.__fromSourceIndex"></a>
365 <h4>WatchPointViewer.__fromSourceIndex</h4>
366 <b>__fromSourceIndex</b>(<i>sindex</i>)
367
368 <p>
369 Private slot to convert a source index to an index.
370 </p>
371 <dl>
372
373 <dt><i>sindex</i></dt>
374 <dd>
375 source index to be converted (QModelIndex)
376 </dd>
377 </dl>
378 <dl>
379 <dt>Return:</dt>
380 <dd>
381 mapped index (QModelIndex)
382 </dd>
383 </dl>
384 <a NAME="WatchPointViewer.__getSelectedItemsCount" ID="WatchPointViewer.__getSelectedItemsCount"></a>
385 <h4>WatchPointViewer.__getSelectedItemsCount</h4>
386 <b>__getSelectedItemsCount</b>(<i></i>)
387
388 <p>
389 Private method to get the count of items selected.
390 </p>
391 <dl>
392 <dt>Return:</dt>
393 <dd>
394 count of items selected (integer)
395 </dd>
396 </dl>
397 <a NAME="WatchPointViewer.__layoutDisplay" ID="WatchPointViewer.__layoutDisplay"></a>
398 <h4>WatchPointViewer.__layoutDisplay</h4>
399 <b>__layoutDisplay</b>(<i></i>)
400
401 <p>
402 Private slot to perform a layout operation.
403 </p>
404 <a NAME="WatchPointViewer.__resizeColumns" ID="WatchPointViewer.__resizeColumns"></a>
405 <h4>WatchPointViewer.__resizeColumns</h4>
406 <b>__resizeColumns</b>(<i></i>)
407
408 <p>
409 Private slot to resize the view when items get added, edited or
410 deleted.
411 </p>
412 <a NAME="WatchPointViewer.__resort" ID="WatchPointViewer.__resort"></a>
413 <h4>WatchPointViewer.__resort</h4>
414 <b>__resort</b>(<i></i>)
415
416 <p>
417 Private slot to resort the tree.
418 </p>
419 <a NAME="WatchPointViewer.__setRowSelected" ID="WatchPointViewer.__setRowSelected"></a>
420 <h4>WatchPointViewer.__setRowSelected</h4>
421 <b>__setRowSelected</b>(<i>index, selected=True</i>)
422
423 <p>
424 Private slot to select a complete row.
425 </p>
426 <dl>
427
428 <dt><i>index</i></dt>
429 <dd>
430 index determining the row to be selected (QModelIndex)
431 </dd>
432 <dt><i>selected</i></dt>
433 <dd>
434 flag indicating the action (bool)
435 </dd>
436 </dl>
437 <a NAME="WatchPointViewer.__setWpEnabled" ID="WatchPointViewer.__setWpEnabled"></a>
438 <h4>WatchPointViewer.__setWpEnabled</h4>
439 <b>__setWpEnabled</b>(<i>index, enabled</i>)
440
441 <p>
442 Private method to set the enabled status of a watch expression.
443 </p>
444 <dl>
445
446 <dt><i>index</i></dt>
447 <dd>
448 index of watch expression to be enabled/disabled
449 (QModelIndex)
450 </dd>
451 <dt><i>enabled</i></dt>
452 <dd>
453 flag indicating the enabled status to be set (boolean)
454 </dd>
455 </dl>
456 <a NAME="WatchPointViewer.__showBackMenu" ID="WatchPointViewer.__showBackMenu"></a>
457 <h4>WatchPointViewer.__showBackMenu</h4>
458 <b>__showBackMenu</b>(<i></i>)
459
460 <p>
461 Private slot to handle the aboutToShow signal of the background menu.
462 </p>
463 <a NAME="WatchPointViewer.__showContextMenu" ID="WatchPointViewer.__showContextMenu"></a>
464 <h4>WatchPointViewer.__showContextMenu</h4>
465 <b>__showContextMenu</b>(<i>coord</i>)
466
467 <p>
468 Private slot to show the context menu.
469 </p>
470 <dl>
471
472 <dt><i>coord</i></dt>
473 <dd>
474 the position of the mouse pointer (QPoint)
475 </dd>
476 </dl>
477 <a NAME="WatchPointViewer.__toSourceIndex" ID="WatchPointViewer.__toSourceIndex"></a>
478 <h4>WatchPointViewer.__toSourceIndex</h4>
479 <b>__toSourceIndex</b>(<i>index</i>)
480
481 <p>
482 Private slot to convert an index to a source index.
483 </p>
484 <dl>
485
486 <dt><i>index</i></dt>
487 <dd>
488 index to be converted (QModelIndex)
489 </dd>
490 </dl>
491 <dl>
492 <dt>Return:</dt>
493 <dd>
494 mapped index (QModelIndex)
495 </dd>
496 </dl>
497 <a NAME="WatchPointViewer.setModel" ID="WatchPointViewer.setModel"></a>
498 <h4>WatchPointViewer.setModel</h4>
499 <b>setModel</b>(<i>model</i>)
500
501 <p>
502 Public slot to set the watch expression model.
503 </p>
504 <dl>
505
506 <dt><i>model</i></dt>
507 <dd>
508 reference to the watch expression model (WatchPointModel)
509 </dd>
510 </dl>
511 <div align="right"><a href="#top">Up</a></div>
512 <hr />
513 </body></html>

eric ide

mercurial