Documentation/Source/eric4.Debugger.VariablesViewer.html

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

eric ide

mercurial