|
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.DataViews.PyProfileDialog</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.DataViews.PyProfileDialog</h1> |
|
24 <p> |
|
25 Module implementing a dialog to display profile data. |
|
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="#ProfileTreeWidgetItem">ProfileTreeWidgetItem</a></td> |
|
35 <td>Class implementing a custom QTreeWidgetItem to allow sorting on numeric values.</td> |
|
36 </tr><tr> |
|
37 <td><a href="#PyProfileDialog">PyProfileDialog</a></td> |
|
38 <td>Class implementing a dialog to display the results of a syntax check run.</td> |
|
39 </tr> |
|
40 </table> |
|
41 <h3>Functions</h3> |
|
42 <table> |
|
43 <tr><td>None</td></tr> |
|
44 </table> |
|
45 <hr /><hr /> |
|
46 <a NAME="ProfileTreeWidgetItem" ID="ProfileTreeWidgetItem"></a> |
|
47 <h2>ProfileTreeWidgetItem</h2> |
|
48 <p> |
|
49 Class implementing a custom QTreeWidgetItem to allow sorting on numeric values. |
|
50 </p> |
|
51 <h3>Derived from</h3> |
|
52 QTreeWidgetItem |
|
53 <h3>Class Attributes</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#ProfileTreeWidgetItem.__getNC">__getNC</a></td> |
|
61 <td>Private method to get the value to compare on for the first column.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#ProfileTreeWidgetItem.__lt__">__lt__</a></td> |
|
64 <td>Public method to check, if the item is less than the other one.</td> |
|
65 </tr> |
|
66 </table> |
|
67 <a NAME="ProfileTreeWidgetItem.__getNC" ID="ProfileTreeWidgetItem.__getNC"></a> |
|
68 <h4>ProfileTreeWidgetItem.__getNC</h4> |
|
69 <b>__getNC</b>(<i>itm</i>) |
|
70 <p> |
|
71 Private method to get the value to compare on for the first column. |
|
72 </p><dl> |
|
73 <dt><i>itm</i></dt> |
|
74 <dd> |
|
75 item to operate on (ProfileTreeWidgetItem) |
|
76 </dd> |
|
77 </dl><a NAME="ProfileTreeWidgetItem.__lt__" ID="ProfileTreeWidgetItem.__lt__"></a> |
|
78 <h4>ProfileTreeWidgetItem.__lt__</h4> |
|
79 <b>__lt__</b>(<i>other</i>) |
|
80 <p> |
|
81 Public method to check, if the item is less than the other one. |
|
82 </p><dl> |
|
83 <dt><i>other</i></dt> |
|
84 <dd> |
|
85 reference to item to compare against (ProfileTreeWidgetItem) |
|
86 </dd> |
|
87 </dl><dl> |
|
88 <dt>Returns:</dt> |
|
89 <dd> |
|
90 true, if this item is less than other (boolean) |
|
91 </dd> |
|
92 </dl> |
|
93 <div align="right"><a href="#top">Up</a></div> |
|
94 <hr /><hr /> |
|
95 <a NAME="PyProfileDialog" ID="PyProfileDialog"></a> |
|
96 <h2>PyProfileDialog</h2> |
|
97 <p> |
|
98 Class implementing a dialog to display the results of a syntax check run. |
|
99 </p> |
|
100 <h3>Derived from</h3> |
|
101 QDialog, Ui_PyProfileDialog |
|
102 <h3>Class Attributes</h3> |
|
103 <table> |
|
104 <tr><td>None</td></tr> |
|
105 </table> |
|
106 <h3>Methods</h3> |
|
107 <table> |
|
108 <tr> |
|
109 <td><a href="#PyProfileDialog.__init__">PyProfileDialog</a></td> |
|
110 <td>Constructor</td> |
|
111 </tr><tr> |
|
112 <td><a href="#PyProfileDialog.__createResultItem">__createResultItem</a></td> |
|
113 <td>Private method to create an entry in the result list.</td> |
|
114 </tr><tr> |
|
115 <td><a href="#PyProfileDialog.__createSummaryItem">__createSummaryItem</a></td> |
|
116 <td>Private method to create an entry in the summary list.</td> |
|
117 </tr><tr> |
|
118 <td><a href="#PyProfileDialog.__eraseAll">__eraseAll</a></td> |
|
119 <td>Private slot to handle the Erase All context menu action.</td> |
|
120 </tr><tr> |
|
121 <td><a href="#PyProfileDialog.__eraseProfile">__eraseProfile</a></td> |
|
122 <td>Private slot to handle the Erase Profile context menu action.</td> |
|
123 </tr><tr> |
|
124 <td><a href="#PyProfileDialog.__eraseTiming">__eraseTiming</a></td> |
|
125 <td>Private slot to handle the Erase Timing context menu action.</td> |
|
126 </tr><tr> |
|
127 <td><a href="#PyProfileDialog.__filter">__filter</a></td> |
|
128 <td>Private slot to handle the Exclude/Include Python Library context menu action.</td> |
|
129 </tr><tr> |
|
130 <td><a href="#PyProfileDialog.__finish">__finish</a></td> |
|
131 <td>Private slot called when the action finished or the user pressed the button.</td> |
|
132 </tr><tr> |
|
133 <td><a href="#PyProfileDialog.__populateLists">__populateLists</a></td> |
|
134 <td>Private method used to populate the listviews.</td> |
|
135 </tr><tr> |
|
136 <td><a href="#PyProfileDialog.__resortResultList">__resortResultList</a></td> |
|
137 <td>Private method to resort the tree.</td> |
|
138 </tr><tr> |
|
139 <td><a href="#PyProfileDialog.__showContextMenu">__showContextMenu</a></td> |
|
140 <td>Private slot to show the context menu of the listview.</td> |
|
141 </tr><tr> |
|
142 <td><a href="#PyProfileDialog.__unfinish">__unfinish</a></td> |
|
143 <td>Private slot called to revert the effects of the __finish slot.</td> |
|
144 </tr><tr> |
|
145 <td><a href="#PyProfileDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
146 <td>Private slot called by a button of the button box clicked.</td> |
|
147 </tr><tr> |
|
148 <td><a href="#PyProfileDialog.start">start</a></td> |
|
149 <td>Public slot to start the calculation of the profile data.</td> |
|
150 </tr> |
|
151 </table> |
|
152 <a NAME="PyProfileDialog.__init__" ID="PyProfileDialog.__init__"></a> |
|
153 <h4>PyProfileDialog (Constructor)</h4> |
|
154 <b>PyProfileDialog</b>(<i>parent = None</i>) |
|
155 <p> |
|
156 Constructor |
|
157 </p><dl> |
|
158 <dt><i>parent</i></dt> |
|
159 <dd> |
|
160 parent widget (QWidget) |
|
161 </dd> |
|
162 </dl><a NAME="PyProfileDialog.__createResultItem" ID="PyProfileDialog.__createResultItem"></a> |
|
163 <h4>PyProfileDialog.__createResultItem</h4> |
|
164 <b>__createResultItem</b>(<i>calls, totalTime, totalTimePerCall, cumulativeTime, cumulativeTimePerCall, file, line, functionName</i>) |
|
165 <p> |
|
166 Private method to create an entry in the result list. |
|
167 </p><dl> |
|
168 <dt><i>calls</i></dt> |
|
169 <dd> |
|
170 number of calls (integer) |
|
171 </dd><dt><i>totalTime</i></dt> |
|
172 <dd> |
|
173 total time (double) |
|
174 </dd><dt><i>totalTimePerCall</i></dt> |
|
175 <dd> |
|
176 total time per call (double) |
|
177 </dd><dt><i>cumulativeTime</i></dt> |
|
178 <dd> |
|
179 cumulative time (double) |
|
180 </dd><dt><i>cumulativeTimePerCall</i></dt> |
|
181 <dd> |
|
182 cumulative time per call (double) |
|
183 </dd><dt><i>file</i></dt> |
|
184 <dd> |
|
185 filename of file (string) |
|
186 </dd><dt><i>line</i></dt> |
|
187 <dd> |
|
188 linenumber (integer) |
|
189 </dd><dt><i>functionName</i></dt> |
|
190 <dd> |
|
191 function name (string) |
|
192 </dd> |
|
193 </dl><a NAME="PyProfileDialog.__createSummaryItem" ID="PyProfileDialog.__createSummaryItem"></a> |
|
194 <h4>PyProfileDialog.__createSummaryItem</h4> |
|
195 <b>__createSummaryItem</b>(<i>label, contents</i>) |
|
196 <p> |
|
197 Private method to create an entry in the summary list. |
|
198 </p><dl> |
|
199 <dt><i>label</i></dt> |
|
200 <dd> |
|
201 text of the first column (string) |
|
202 </dd><dt><i>contents</i></dt> |
|
203 <dd> |
|
204 text of the second column (string) |
|
205 </dd> |
|
206 </dl><a NAME="PyProfileDialog.__eraseAll" ID="PyProfileDialog.__eraseAll"></a> |
|
207 <h4>PyProfileDialog.__eraseAll</h4> |
|
208 <b>__eraseAll</b>(<i></i>) |
|
209 <p> |
|
210 Private slot to handle the Erase All context menu action. |
|
211 </p><a NAME="PyProfileDialog.__eraseProfile" ID="PyProfileDialog.__eraseProfile"></a> |
|
212 <h4>PyProfileDialog.__eraseProfile</h4> |
|
213 <b>__eraseProfile</b>(<i></i>) |
|
214 <p> |
|
215 Private slot to handle the Erase Profile context menu action. |
|
216 </p><a NAME="PyProfileDialog.__eraseTiming" ID="PyProfileDialog.__eraseTiming"></a> |
|
217 <h4>PyProfileDialog.__eraseTiming</h4> |
|
218 <b>__eraseTiming</b>(<i></i>) |
|
219 <p> |
|
220 Private slot to handle the Erase Timing context menu action. |
|
221 </p><a NAME="PyProfileDialog.__filter" ID="PyProfileDialog.__filter"></a> |
|
222 <h4>PyProfileDialog.__filter</h4> |
|
223 <b>__filter</b>(<i></i>) |
|
224 <p> |
|
225 Private slot to handle the Exclude/Include Python Library context menu action. |
|
226 </p><a NAME="PyProfileDialog.__finish" ID="PyProfileDialog.__finish"></a> |
|
227 <h4>PyProfileDialog.__finish</h4> |
|
228 <b>__finish</b>(<i></i>) |
|
229 <p> |
|
230 Private slot called when the action finished or the user pressed the button. |
|
231 </p><a NAME="PyProfileDialog.__populateLists" ID="PyProfileDialog.__populateLists"></a> |
|
232 <h4>PyProfileDialog.__populateLists</h4> |
|
233 <b>__populateLists</b>(<i>exclude = False</i>) |
|
234 <p> |
|
235 Private method used to populate the listviews. |
|
236 </p><dl> |
|
237 <dt><i>exclude</i></dt> |
|
238 <dd> |
|
239 flag indicating whether files residing in the |
|
240 Python library should be excluded |
|
241 </dd> |
|
242 </dl><a NAME="PyProfileDialog.__resortResultList" ID="PyProfileDialog.__resortResultList"></a> |
|
243 <h4>PyProfileDialog.__resortResultList</h4> |
|
244 <b>__resortResultList</b>(<i></i>) |
|
245 <p> |
|
246 Private method to resort the tree. |
|
247 </p><a NAME="PyProfileDialog.__showContextMenu" ID="PyProfileDialog.__showContextMenu"></a> |
|
248 <h4>PyProfileDialog.__showContextMenu</h4> |
|
249 <b>__showContextMenu</b>(<i>coord</i>) |
|
250 <p> |
|
251 Private slot to show the context menu of the listview. |
|
252 </p><dl> |
|
253 <dt><i>coord</i></dt> |
|
254 <dd> |
|
255 the position of the mouse pointer (QPoint) |
|
256 </dd> |
|
257 </dl><a NAME="PyProfileDialog.__unfinish" ID="PyProfileDialog.__unfinish"></a> |
|
258 <h4>PyProfileDialog.__unfinish</h4> |
|
259 <b>__unfinish</b>(<i></i>) |
|
260 <p> |
|
261 Private slot called to revert the effects of the __finish slot. |
|
262 </p><a NAME="PyProfileDialog.on_buttonBox_clicked" ID="PyProfileDialog.on_buttonBox_clicked"></a> |
|
263 <h4>PyProfileDialog.on_buttonBox_clicked</h4> |
|
264 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
265 <p> |
|
266 Private slot called by a button of the button box clicked. |
|
267 </p><dl> |
|
268 <dt><i>button</i></dt> |
|
269 <dd> |
|
270 button that was clicked (QAbstractButton) |
|
271 </dd> |
|
272 </dl><a NAME="PyProfileDialog.start" ID="PyProfileDialog.start"></a> |
|
273 <h4>PyProfileDialog.start</h4> |
|
274 <b>start</b>(<i>pfn, fn=None</i>) |
|
275 <p> |
|
276 Public slot to start the calculation of the profile data. |
|
277 </p><dl> |
|
278 <dt><i>pfn</i></dt> |
|
279 <dd> |
|
280 basename of the profiling file (string) |
|
281 </dd><dt><i>fn</i></dt> |
|
282 <dd> |
|
283 file to display the profiling data for (string) |
|
284 </dd> |
|
285 </dl> |
|
286 <div align="right"><a href="#top">Up</a></div> |
|
287 <hr /> |
|
288 </body></html> |