~mcfletch/eric/update-to-4.5.13

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