Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Debugger.VariablesViewer.html

Documentation/Source/eric6.Debugger.VariablesViewer.html

changeset 3673
e26d7d0c1088
child 4569
8ff785ae7ae6
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Debugger.VariablesViewer</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.VariablesViewer</h1>
23 <p>
24 Module implementing the variables 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="#ArrayElementVarItem">ArrayElementVarItem</a></td>
34 <td>Class implementing a VariableItem that represents an array element.</td>
35 </tr><tr>
36 <td><a href="#SpecialArrayElementVarItem">SpecialArrayElementVarItem</a></td>
37 <td>Class implementing a QTreeWidgetItem that represents a special array variable node.</td>
38 </tr><tr>
39 <td><a href="#SpecialVarItem">SpecialVarItem</a></td>
40 <td>Class implementing a VariableItem that represents a special variable node.</td>
41 </tr><tr>
42 <td><a href="#VariableItem">VariableItem</a></td>
43 <td>Class implementing the data structure for variable items.</td>
44 </tr><tr>
45 <td><a href="#VariablesViewer">VariablesViewer</a></td>
46 <td>Class implementing the variables viewer widget.</td>
47 </tr>
48 </table>
49 <h3>Functions</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <hr /><hr />
54 <a NAME="ArrayElementVarItem" ID="ArrayElementVarItem"></a>
55 <h2>ArrayElementVarItem</h2>
56 <p>
57 Class implementing a VariableItem that represents an array element.
58 </p>
59 <h3>Derived from</h3>
60 VariableItem
61 <h3>Class Attributes</h3>
62 <table>
63 <tr><td>None</td></tr>
64 </table>
65 <h3>Class Methods</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70 <table>
71 <tr>
72 <td><a href="#ArrayElementVarItem.__init__">ArrayElementVarItem</a></td>
73 <td>Constructor</td>
74 </tr><tr>
75 <td><a href="#ArrayElementVarItem.key">key</a></td>
76 <td>Public method generating the key for this item.</td>
77 </tr>
78 </table>
79 <h3>Static Methods</h3>
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83 <a NAME="ArrayElementVarItem.__init__" ID="ArrayElementVarItem.__init__"></a>
84 <h4>ArrayElementVarItem (Constructor)</h4>
85 <b>ArrayElementVarItem</b>(<i>parent, dvar, dvalue, dtype</i>)
86 <p>
87 Constructor
88 </p><dl>
89 <dt><i>parent</i></dt>
90 <dd>
91 parent of this item
92 </dd><dt><i>dvar</i></dt>
93 <dd>
94 variable name (string)
95 </dd><dt><i>dvalue</i></dt>
96 <dd>
97 value string (string)
98 </dd><dt><i>dtype</i></dt>
99 <dd>
100 type string (string)
101 </dd>
102 </dl><a NAME="ArrayElementVarItem.key" ID="ArrayElementVarItem.key"></a>
103 <h4>ArrayElementVarItem.key</h4>
104 <b>key</b>(<i>column</i>)
105 <p>
106 Public method generating the key for this item.
107 </p><dl>
108 <dt><i>column</i></dt>
109 <dd>
110 the column to sort on (integer)
111 </dd>
112 </dl><dl>
113 <dt>Returns:</dt>
114 <dd>
115 key of the item (string)
116 </dd>
117 </dl>
118 <div align="right"><a href="#top">Up</a></div>
119 <hr /><hr />
120 <a NAME="SpecialArrayElementVarItem" ID="SpecialArrayElementVarItem"></a>
121 <h2>SpecialArrayElementVarItem</h2>
122 <p>
123 Class implementing a QTreeWidgetItem that represents a special array
124 variable node.
125 </p>
126 <h3>Derived from</h3>
127 SpecialVarItem
128 <h3>Class Attributes</h3>
129 <table>
130 <tr><td>None</td></tr>
131 </table>
132 <h3>Class Methods</h3>
133 <table>
134 <tr><td>None</td></tr>
135 </table>
136 <h3>Methods</h3>
137 <table>
138 <tr>
139 <td><a href="#SpecialArrayElementVarItem.__init__">SpecialArrayElementVarItem</a></td>
140 <td>Constructor</td>
141 </tr><tr>
142 <td><a href="#SpecialArrayElementVarItem.key">key</a></td>
143 <td>Public method generating the key for this item.</td>
144 </tr>
145 </table>
146 <h3>Static Methods</h3>
147 <table>
148 <tr><td>None</td></tr>
149 </table>
150 <a NAME="SpecialArrayElementVarItem.__init__" ID="SpecialArrayElementVarItem.__init__"></a>
151 <h4>SpecialArrayElementVarItem (Constructor)</h4>
152 <b>SpecialArrayElementVarItem</b>(<i>parent, dvar, dvalue, dtype, frmnr, scope</i>)
153 <p>
154 Constructor
155 </p><dl>
156 <dt><i>parent</i></dt>
157 <dd>
158 parent of this item
159 </dd><dt><i>dvar</i></dt>
160 <dd>
161 variable name (string)
162 </dd><dt><i>dvalue</i></dt>
163 <dd>
164 value string (string)
165 </dd><dt><i>dtype</i></dt>
166 <dd>
167 type string (string)
168 </dd><dt><i>frmnr</i></dt>
169 <dd>
170 frame number (0 is the current frame) (int)
171 </dd><dt><i>scope</i></dt>
172 <dd>
173 flag indicating global (1) or local (0) variables
174 </dd>
175 </dl><a NAME="SpecialArrayElementVarItem.key" ID="SpecialArrayElementVarItem.key"></a>
176 <h4>SpecialArrayElementVarItem.key</h4>
177 <b>key</b>(<i>column</i>)
178 <p>
179 Public method generating the key for this item.
180 </p><dl>
181 <dt><i>column</i></dt>
182 <dd>
183 the column to sort on (integer)
184 </dd>
185 </dl><dl>
186 <dt>Returns:</dt>
187 <dd>
188 key of the item (string)
189 </dd>
190 </dl>
191 <div align="right"><a href="#top">Up</a></div>
192 <hr /><hr />
193 <a NAME="SpecialVarItem" ID="SpecialVarItem"></a>
194 <h2>SpecialVarItem</h2>
195 <p>
196 Class implementing a VariableItem that represents a special variable node.
197 </p><p>
198 These special variable nodes are generated for classes, lists,
199 tuples and dictionaries.
200 </p>
201 <h3>Derived from</h3>
202 VariableItem
203 <h3>Class Attributes</h3>
204 <table>
205 <tr><td>None</td></tr>
206 </table>
207 <h3>Class Methods</h3>
208 <table>
209 <tr><td>None</td></tr>
210 </table>
211 <h3>Methods</h3>
212 <table>
213 <tr>
214 <td><a href="#SpecialVarItem.__init__">SpecialVarItem</a></td>
215 <td>Constructor</td>
216 </tr><tr>
217 <td><a href="#SpecialVarItem.expand">expand</a></td>
218 <td>Public method to expand the item.</td>
219 </tr>
220 </table>
221 <h3>Static Methods</h3>
222 <table>
223 <tr><td>None</td></tr>
224 </table>
225 <a NAME="SpecialVarItem.__init__" ID="SpecialVarItem.__init__"></a>
226 <h4>SpecialVarItem (Constructor)</h4>
227 <b>SpecialVarItem</b>(<i>parent, dvar, dvalue, dtype, frmnr, scope</i>)
228 <p>
229 Constructor
230 </p><dl>
231 <dt><i>parent</i></dt>
232 <dd>
233 parent of this item
234 </dd><dt><i>dvar</i></dt>
235 <dd>
236 variable name (string)
237 </dd><dt><i>dvalue</i></dt>
238 <dd>
239 value string (string)
240 </dd><dt><i>dtype</i></dt>
241 <dd>
242 type string (string)
243 </dd><dt><i>frmnr</i></dt>
244 <dd>
245 frame number (0 is the current frame) (int)
246 </dd><dt><i>scope</i></dt>
247 <dd>
248 flag indicating global (1) or local (0) variables
249 </dd>
250 </dl><a NAME="SpecialVarItem.expand" ID="SpecialVarItem.expand"></a>
251 <h4>SpecialVarItem.expand</h4>
252 <b>expand</b>(<i></i>)
253 <p>
254 Public method to expand the item.
255 </p>
256 <div align="right"><a href="#top">Up</a></div>
257 <hr /><hr />
258 <a NAME="VariableItem" ID="VariableItem"></a>
259 <h2>VariableItem</h2>
260 <p>
261 Class implementing the data structure for variable items.
262 </p>
263 <h3>Derived from</h3>
264 QTreeWidgetItem
265 <h3>Class Attributes</h3>
266 <table>
267 <tr><td>None</td></tr>
268 </table>
269 <h3>Class Methods</h3>
270 <table>
271 <tr><td>None</td></tr>
272 </table>
273 <h3>Methods</h3>
274 <table>
275 <tr>
276 <td><a href="#VariableItem.__init__">VariableItem</a></td>
277 <td>Constructor</td>
278 </tr><tr>
279 <td><a href="#VariableItem.__lt__">__lt__</a></td>
280 <td>Special method to check, if the item is less than the other one.</td>
281 </tr><tr>
282 <td><a href="#VariableItem.attachDummy">attachDummy</a></td>
283 <td>Public method to attach a dummy sub item to allow for lazy population.</td>
284 </tr><tr>
285 <td><a href="#VariableItem.collapse">collapse</a></td>
286 <td>Public method to collapse the item.</td>
287 </tr><tr>
288 <td><a href="#VariableItem.data">data</a></td>
289 <td>Public method to return the data for the requested role.</td>
290 </tr><tr>
291 <td><a href="#VariableItem.deleteChildren">deleteChildren</a></td>
292 <td>Public method to delete all children (cleaning the subtree).</td>
293 </tr><tr>
294 <td><a href="#VariableItem.expand">expand</a></td>
295 <td>Public method to expand the item.</td>
296 </tr><tr>
297 <td><a href="#VariableItem.getValue">getValue</a></td>
298 <td>Public method to return the value of the item.</td>
299 </tr><tr>
300 <td><a href="#VariableItem.key">key</a></td>
301 <td>Public method generating the key for this item.</td>
302 </tr>
303 </table>
304 <h3>Static Methods</h3>
305 <table>
306 <tr><td>None</td></tr>
307 </table>
308 <a NAME="VariableItem.__init__" ID="VariableItem.__init__"></a>
309 <h4>VariableItem (Constructor)</h4>
310 <b>VariableItem</b>(<i>parent, dvar, dvalue, dtype</i>)
311 <p>
312 Constructor
313 </p><dl>
314 <dt><i>parent</i></dt>
315 <dd>
316 reference to the parent item
317 </dd><dt><i>dvar</i></dt>
318 <dd>
319 variable name (string)
320 </dd><dt><i>dvalue</i></dt>
321 <dd>
322 value string (string)
323 </dd><dt><i>dtype</i></dt>
324 <dd>
325 type string (string)
326 </dd>
327 </dl><a NAME="VariableItem.__lt__" ID="VariableItem.__lt__"></a>
328 <h4>VariableItem.__lt__</h4>
329 <b>__lt__</b>(<i>other</i>)
330 <p>
331 Special method to check, if the item is less than the other one.
332 </p><dl>
333 <dt><i>other</i></dt>
334 <dd>
335 reference to item to compare against (QTreeWidgetItem)
336 </dd>
337 </dl><dl>
338 <dt>Returns:</dt>
339 <dd>
340 true, if this item is less than other (boolean)
341 </dd>
342 </dl><a NAME="VariableItem.attachDummy" ID="VariableItem.attachDummy"></a>
343 <h4>VariableItem.attachDummy</h4>
344 <b>attachDummy</b>(<i></i>)
345 <p>
346 Public method to attach a dummy sub item to allow for lazy population.
347 </p><a NAME="VariableItem.collapse" ID="VariableItem.collapse"></a>
348 <h4>VariableItem.collapse</h4>
349 <b>collapse</b>(<i></i>)
350 <p>
351 Public method to collapse the item.
352 </p><p>
353 Note: This is just a do nothing and should be overwritten.
354 </p><a NAME="VariableItem.data" ID="VariableItem.data"></a>
355 <h4>VariableItem.data</h4>
356 <b>data</b>(<i>column, role</i>)
357 <p>
358 Public method to return the data for the requested role.
359 </p><p>
360 This implementation changes the original behavior in a way, that the
361 display data is returned as the tooltip for column 1.
362 </p><dl>
363 <dt><i>column</i></dt>
364 <dd>
365 column number (integer)
366 </dd><dt><i>role</i></dt>
367 <dd>
368 data role (Qt.ItemDataRole)
369 </dd>
370 </dl><dl>
371 <dt>Returns:</dt>
372 <dd>
373 requested data
374 </dd>
375 </dl><a NAME="VariableItem.deleteChildren" ID="VariableItem.deleteChildren"></a>
376 <h4>VariableItem.deleteChildren</h4>
377 <b>deleteChildren</b>(<i></i>)
378 <p>
379 Public method to delete all children (cleaning the subtree).
380 </p><a NAME="VariableItem.expand" ID="VariableItem.expand"></a>
381 <h4>VariableItem.expand</h4>
382 <b>expand</b>(<i></i>)
383 <p>
384 Public method to expand the item.
385 </p><p>
386 Note: This is just a do nothing and should be overwritten.
387 </p><a NAME="VariableItem.getValue" ID="VariableItem.getValue"></a>
388 <h4>VariableItem.getValue</h4>
389 <b>getValue</b>(<i></i>)
390 <p>
391 Public method to return the value of the item.
392 </p><dl>
393 <dt>Returns:</dt>
394 <dd>
395 value of the item (string)
396 </dd>
397 </dl><a NAME="VariableItem.key" ID="VariableItem.key"></a>
398 <h4>VariableItem.key</h4>
399 <b>key</b>(<i>column</i>)
400 <p>
401 Public method generating the key for this item.
402 </p><dl>
403 <dt><i>column</i></dt>
404 <dd>
405 the column to sort on (integer)
406 </dd>
407 </dl><dl>
408 <dt>Returns:</dt>
409 <dd>
410 text of the column (string)
411 </dd>
412 </dl>
413 <div align="right"><a href="#top">Up</a></div>
414 <hr /><hr />
415 <a NAME="VariablesViewer" ID="VariablesViewer"></a>
416 <h2>VariablesViewer</h2>
417 <p>
418 Class implementing the variables viewer widget.
419 </p><p>
420 This widget is used to display the variables of the program being
421 debugged in a tree. Compound types will be shown with
422 their main entry first. Once the subtree has been expanded, the
423 individual entries will be shown. Double clicking an entry will
424 popup a dialog showing the variables parameters in a more readable
425 form. This is especially useful for lengthy strings.
426 </p><p>
427 This widget has two modes for displaying the global and the local
428 variables.
429 </p>
430 <h3>Derived from</h3>
431 QTreeWidget
432 <h3>Class Attributes</h3>
433 <table>
434 <tr><td>None</td></tr>
435 </table>
436 <h3>Class Methods</h3>
437 <table>
438 <tr><td>None</td></tr>
439 </table>
440 <h3>Methods</h3>
441 <table>
442 <tr>
443 <td><a href="#VariablesViewer.__init__">VariablesViewer</a></td>
444 <td>Constructor</td>
445 </tr><tr>
446 <td><a href="#VariablesViewer.__addItem">__addItem</a></td>
447 <td>Private method used to add an item to the list.</td>
448 </tr><tr>
449 <td><a href="#VariablesViewer.__buildTreePath">__buildTreePath</a></td>
450 <td>Private method to build up a path from the top to an item.</td>
451 </tr><tr>
452 <td><a href="#VariablesViewer.__configure">__configure</a></td>
453 <td>Private method to open the configuration dialog.</td>
454 </tr><tr>
455 <td><a href="#VariablesViewer.__createPopupMenus">__createPopupMenus</a></td>
456 <td>Private method to generate the popup menus.</td>
457 </tr><tr>
458 <td><a href="#VariablesViewer.__expandItemSignal">__expandItemSignal</a></td>
459 <td>Private slot to handle the expanded signal.</td>
460 </tr><tr>
461 <td><a href="#VariablesViewer.__findItem">__findItem</a></td>
462 <td>Private method to search for an item.</td>
463 </tr><tr>
464 <td><a href="#VariablesViewer.__generateItem">__generateItem</a></td>
465 <td>Private method used to generate a VariableItem.</td>
466 </tr><tr>
467 <td><a href="#VariablesViewer.__getDispType">__getDispType</a></td>
468 <td>Private method used to get the display string for type vtype.</td>
469 </tr><tr>
470 <td><a href="#VariablesViewer.__resort">__resort</a></td>
471 <td>Private method to resort the tree.</td>
472 </tr><tr>
473 <td><a href="#VariablesViewer.__showContextMenu">__showContextMenu</a></td>
474 <td>Private slot to show the context menu.</td>
475 </tr><tr>
476 <td><a href="#VariablesViewer.__showDetails">__showDetails</a></td>
477 <td>Private slot to show details about the selected variable.</td>
478 </tr><tr>
479 <td><a href="#VariablesViewer.__showVariableDetails">__showVariableDetails</a></td>
480 <td>Private method to show details about a variable.</td>
481 </tr><tr>
482 <td><a href="#VariablesViewer.collapseItem">collapseItem</a></td>
483 <td>Public slot to handle the collapsed signal.</td>
484 </tr><tr>
485 <td><a href="#VariablesViewer.expandItem">expandItem</a></td>
486 <td>Public slot to handle the expanded signal.</td>
487 </tr><tr>
488 <td><a href="#VariablesViewer.handleResetUI">handleResetUI</a></td>
489 <td>Public method to reset the VariablesViewer.</td>
490 </tr><tr>
491 <td><a href="#VariablesViewer.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
492 <td>Protected method of QAbstractItemView.</td>
493 </tr><tr>
494 <td><a href="#VariablesViewer.showVariable">showVariable</a></td>
495 <td>Public method to show variables in a list.</td>
496 </tr><tr>
497 <td><a href="#VariablesViewer.showVariables">showVariables</a></td>
498 <td>Public method to show variables in a list.</td>
499 </tr>
500 </table>
501 <h3>Static Methods</h3>
502 <table>
503 <tr><td>None</td></tr>
504 </table>
505 <a NAME="VariablesViewer.__init__" ID="VariablesViewer.__init__"></a>
506 <h4>VariablesViewer (Constructor)</h4>
507 <b>VariablesViewer</b>(<i>parent=None, scope=1</i>)
508 <p>
509 Constructor
510 </p><dl>
511 <dt><i>parent</i></dt>
512 <dd>
513 the parent (QWidget)
514 </dd><dt><i>scope</i></dt>
515 <dd>
516 flag indicating global (1) or local (0) variables
517 </dd>
518 </dl><a NAME="VariablesViewer.__addItem" ID="VariablesViewer.__addItem"></a>
519 <h4>VariablesViewer.__addItem</h4>
520 <b>__addItem</b>(<i>parent, vtype, var, value</i>)
521 <p>
522 Private method used to add an item to the list.
523 </p><p>
524 If the item is of a type with subelements (i.e. list, dictionary,
525 tuple), these subelements are added by calling this method recursively.
526 </p><dl>
527 <dt><i>parent</i></dt>
528 <dd>
529 the parent of the item to be added
530 (QTreeWidgetItem or None)
531 </dd><dt><i>vtype</i></dt>
532 <dd>
533 the type of the item to be added
534 (string)
535 </dd><dt><i>var</i></dt>
536 <dd>
537 the variable name (string)
538 </dd><dt><i>value</i></dt>
539 <dd>
540 the value string (string)
541 </dd>
542 </dl><dl>
543 <dt>Returns:</dt>
544 <dd>
545 The item that was added to the listview (QTreeWidgetItem).
546 </dd>
547 </dl><a NAME="VariablesViewer.__buildTreePath" ID="VariablesViewer.__buildTreePath"></a>
548 <h4>VariablesViewer.__buildTreePath</h4>
549 <b>__buildTreePath</b>(<i>itm</i>)
550 <p>
551 Private method to build up a path from the top to an item.
552 </p><dl>
553 <dt><i>itm</i></dt>
554 <dd>
555 item to build the path for (QTreeWidgetItem)
556 </dd>
557 </dl><dl>
558 <dt>Returns:</dt>
559 <dd>
560 list of names denoting the path from the top (list of strings)
561 </dd>
562 </dl><a NAME="VariablesViewer.__configure" ID="VariablesViewer.__configure"></a>
563 <h4>VariablesViewer.__configure</h4>
564 <b>__configure</b>(<i></i>)
565 <p>
566 Private method to open the configuration dialog.
567 </p><a NAME="VariablesViewer.__createPopupMenus" ID="VariablesViewer.__createPopupMenus"></a>
568 <h4>VariablesViewer.__createPopupMenus</h4>
569 <b>__createPopupMenus</b>(<i></i>)
570 <p>
571 Private method to generate the popup menus.
572 </p><a NAME="VariablesViewer.__expandItemSignal" ID="VariablesViewer.__expandItemSignal"></a>
573 <h4>VariablesViewer.__expandItemSignal</h4>
574 <b>__expandItemSignal</b>(<i>parentItem</i>)
575 <p>
576 Private slot to handle the expanded signal.
577 </p><dl>
578 <dt><i>parentItem</i></dt>
579 <dd>
580 reference to the item being expanded
581 (QTreeWidgetItem)
582 </dd>
583 </dl><a NAME="VariablesViewer.__findItem" ID="VariablesViewer.__findItem"></a>
584 <h4>VariablesViewer.__findItem</h4>
585 <b>__findItem</b>(<i>slist, column, node=None</i>)
586 <p>
587 Private method to search for an item.
588 </p><p>
589 It is used to find a specific item in column,
590 that is a child of node. If node is None, a child of the
591 QTreeWidget is searched.
592 </p><dl>
593 <dt><i>slist</i></dt>
594 <dd>
595 searchlist (list of strings)
596 </dd><dt><i>column</i></dt>
597 <dd>
598 index of column to search in (int)
599 </dd><dt><i>node</i></dt>
600 <dd>
601 start point of the search
602 </dd>
603 </dl><dl>
604 <dt>Returns:</dt>
605 <dd>
606 the found item or None
607 </dd>
608 </dl><a NAME="VariablesViewer.__generateItem" ID="VariablesViewer.__generateItem"></a>
609 <h4>VariablesViewer.__generateItem</h4>
610 <b>__generateItem</b>(<i>parent, dvar, dvalue, dtype, isSpecial=False</i>)
611 <p>
612 Private method used to generate a VariableItem.
613 </p><dl>
614 <dt><i>parent</i></dt>
615 <dd>
616 parent of the item to be generated
617 </dd><dt><i>dvar</i></dt>
618 <dd>
619 variable name (string)
620 </dd><dt><i>dvalue</i></dt>
621 <dd>
622 value string (string)
623 </dd><dt><i>dtype</i></dt>
624 <dd>
625 type string (string)
626 </dd><dt><i>isSpecial</i></dt>
627 <dd>
628 flag indicating that a special node should be
629 generated (boolean)
630 </dd>
631 </dl><dl>
632 <dt>Returns:</dt>
633 <dd>
634 The item that was generated (VariableItem).
635 </dd>
636 </dl><a NAME="VariablesViewer.__getDispType" ID="VariablesViewer.__getDispType"></a>
637 <h4>VariablesViewer.__getDispType</h4>
638 <b>__getDispType</b>(<i>vtype</i>)
639 <p>
640 Private method used to get the display string for type vtype.
641 </p><dl>
642 <dt><i>vtype</i></dt>
643 <dd>
644 the type, the display string should be looked up for
645 (string)
646 </dd>
647 </dl><dl>
648 <dt>Returns:</dt>
649 <dd>
650 displaystring (string)
651 </dd>
652 </dl><a NAME="VariablesViewer.__resort" ID="VariablesViewer.__resort"></a>
653 <h4>VariablesViewer.__resort</h4>
654 <b>__resort</b>(<i></i>)
655 <p>
656 Private method to resort the tree.
657 </p><a NAME="VariablesViewer.__showContextMenu" ID="VariablesViewer.__showContextMenu"></a>
658 <h4>VariablesViewer.__showContextMenu</h4>
659 <b>__showContextMenu</b>(<i>coord</i>)
660 <p>
661 Private slot to show the context menu.
662 </p><dl>
663 <dt><i>coord</i></dt>
664 <dd>
665 the position of the mouse pointer (QPoint)
666 </dd>
667 </dl><a NAME="VariablesViewer.__showDetails" ID="VariablesViewer.__showDetails"></a>
668 <h4>VariablesViewer.__showDetails</h4>
669 <b>__showDetails</b>(<i></i>)
670 <p>
671 Private slot to show details about the selected variable.
672 </p><a NAME="VariablesViewer.__showVariableDetails" ID="VariablesViewer.__showVariableDetails"></a>
673 <h4>VariablesViewer.__showVariableDetails</h4>
674 <b>__showVariableDetails</b>(<i>itm</i>)
675 <p>
676 Private method to show details about a variable.
677 </p><dl>
678 <dt><i>itm</i></dt>
679 <dd>
680 reference to the variable item
681 </dd>
682 </dl><a NAME="VariablesViewer.collapseItem" ID="VariablesViewer.collapseItem"></a>
683 <h4>VariablesViewer.collapseItem</h4>
684 <b>collapseItem</b>(<i>parentItem</i>)
685 <p>
686 Public slot to handle the collapsed signal.
687 </p><dl>
688 <dt><i>parentItem</i></dt>
689 <dd>
690 reference to the item being collapsed
691 (QTreeWidgetItem)
692 </dd>
693 </dl><a NAME="VariablesViewer.expandItem" ID="VariablesViewer.expandItem"></a>
694 <h4>VariablesViewer.expandItem</h4>
695 <b>expandItem</b>(<i>parentItem</i>)
696 <p>
697 Public slot to handle the expanded signal.
698 </p><dl>
699 <dt><i>parentItem</i></dt>
700 <dd>
701 reference to the item being expanded
702 (QTreeWidgetItem)
703 </dd>
704 </dl><a NAME="VariablesViewer.handleResetUI" ID="VariablesViewer.handleResetUI"></a>
705 <h4>VariablesViewer.handleResetUI</h4>
706 <b>handleResetUI</b>(<i></i>)
707 <p>
708 Public method to reset the VariablesViewer.
709 </p><a NAME="VariablesViewer.mouseDoubleClickEvent" ID="VariablesViewer.mouseDoubleClickEvent"></a>
710 <h4>VariablesViewer.mouseDoubleClickEvent</h4>
711 <b>mouseDoubleClickEvent</b>(<i>mouseEvent</i>)
712 <p>
713 Protected method of QAbstractItemView.
714 </p><p>
715 Reimplemented to disable expanding/collapsing of items when
716 double-clicking. Instead the double-clicked entry is opened.
717 </p><dl>
718 <dt><i>mouseEvent</i></dt>
719 <dd>
720 the mouse event object (QMouseEvent)
721 </dd>
722 </dl><a NAME="VariablesViewer.showVariable" ID="VariablesViewer.showVariable"></a>
723 <h4>VariablesViewer.showVariable</h4>
724 <b>showVariable</b>(<i>vlist</i>)
725 <p>
726 Public method to show variables in a list.
727 </p><dl>
728 <dt><i>vlist</i></dt>
729 <dd>
730 the list of subitems to be displayed.
731 The first element gives the path of the
732 parent variable. Each other listentry is
733 a tuple of three values.
734 <ul>
735 <li>the variable name (string)</li>
736 <li>the variables type (string)</li>
737 <li>the variables value (string)</li>
738 </ul>
739 </dd>
740 </dl><a NAME="VariablesViewer.showVariables" ID="VariablesViewer.showVariables"></a>
741 <h4>VariablesViewer.showVariables</h4>
742 <b>showVariables</b>(<i>vlist, frmnr</i>)
743 <p>
744 Public method to show variables in a list.
745 </p><dl>
746 <dt><i>vlist</i></dt>
747 <dd>
748 the list of variables to be displayed. Each
749 listentry is a tuple of three values.
750 <ul>
751 <li>the variable name (string)</li>
752 <li>the variables type (string)</li>
753 <li>the variables value (string)</li>
754 </ul>
755 </dd><dt><i>frmnr</i></dt>
756 <dd>
757 frame number (0 is the current frame) (int)
758 </dd>
759 </dl>
760 <div align="right"><a href="#top">Up</a></div>
761 <hr />
762 </body></html>

Mercurial Repository: eric

eric ide

mercurial