|
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>eric5.Debugger.WatchPointModel</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Debugger.WatchPointModel</h1> |
|
12 <p> |
|
13 Module implementing the Watch expression model. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#WatchPointModel">WatchPointModel</a></td> |
|
23 <td>Class implementing a custom model for watch expressions.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="WatchPointModel" ID="WatchPointModel"></a> |
|
32 <h2>WatchPointModel</h2> |
|
33 <p> |
|
34 Class implementing a custom model for watch expressions. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QAbstractItemModel |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#WatchPointModel.__init__">WatchPointModel</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#WatchPointModel.addWatchPoint">addWatchPoint</a></td> |
|
49 <td>Public method to add a new watch expression to the list.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#WatchPointModel.columnCount">columnCount</a></td> |
|
52 <td>Public method to get the current column count.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#WatchPointModel.data">data</a></td> |
|
55 <td>Public method to get the requested data.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#WatchPointModel.deleteAll">deleteAll</a></td> |
|
58 <td>Public method to delete all watch expressions.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#WatchPointModel.deleteWatchPointByIndex">deleteWatchPointByIndex</a></td> |
|
61 <td>Public method to set the values of a watch expression given by index.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#WatchPointModel.deleteWatchPoints">deleteWatchPoints</a></td> |
|
64 <td>Public method to delete a list of watch expressions given by their indexes.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#WatchPointModel.flags">flags</a></td> |
|
67 <td>Public method to get item flags.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#WatchPointModel.getWatchPointByIndex">getWatchPointByIndex</a></td> |
|
70 <td>Public method to get the values of a watch expression given by index.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#WatchPointModel.getWatchPointIndex">getWatchPointIndex</a></td> |
|
73 <td>Public method to get the index of a watch expression given by expression.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#WatchPointModel.hasChildren">hasChildren</a></td> |
|
76 <td>Public method to check for the presence of child items.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#WatchPointModel.headerData">headerData</a></td> |
|
79 <td>Public method to get header data.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#WatchPointModel.index">index</a></td> |
|
82 <td>Public method to create an index.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#WatchPointModel.parent">parent</a></td> |
|
85 <td>Public method to get the parent index.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#WatchPointModel.rowCount">rowCount</a></td> |
|
88 <td>Public method to get the current row count.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#WatchPointModel.setWatchPointByIndex">setWatchPointByIndex</a></td> |
|
91 <td>Public method to set the values of a watch expression given by index.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#WatchPointModel.setWatchPointEnabledByIndex">setWatchPointEnabledByIndex</a></td> |
|
94 <td>Public method to set the enabled state of a watch expression given by index.</td> |
|
95 </tr> |
|
96 </table> |
|
97 <a NAME="WatchPointModel.__init__" ID="WatchPointModel.__init__"></a> |
|
98 <h4>WatchPointModel (Constructor)</h4> |
|
99 <b>WatchPointModel</b>(<i>parent = None</i>) |
|
100 <p> |
|
101 Constructor |
|
102 </p><dl> |
|
103 <dt><i>reference</i></dt> |
|
104 <dd> |
|
105 to the parent widget (QObject) |
|
106 </dd> |
|
107 </dl><a NAME="WatchPointModel.addWatchPoint" ID="WatchPointModel.addWatchPoint"></a> |
|
108 <h4>WatchPointModel.addWatchPoint</h4> |
|
109 <b>addWatchPoint</b>(<i>cond, special, properties</i>) |
|
110 <p> |
|
111 Public method to add a new watch expression to the list. |
|
112 </p><dl> |
|
113 <dt><i>cond</i></dt> |
|
114 <dd> |
|
115 expression of the watch expression (string) |
|
116 </dd><dt><i>special</i></dt> |
|
117 <dd> |
|
118 special condition of the watch expression (string) |
|
119 </dd><dt><i>properties</i></dt> |
|
120 <dd> |
|
121 properties of the watch expression |
|
122 (tuple of temporary flag (bool), enabled flag (bool), ignore count (integer)) |
|
123 </dd> |
|
124 </dl><a NAME="WatchPointModel.columnCount" ID="WatchPointModel.columnCount"></a> |
|
125 <h4>WatchPointModel.columnCount</h4> |
|
126 <b>columnCount</b>(<i>parent = QModelIndex()</i>) |
|
127 <p> |
|
128 Public method to get the current column count. |
|
129 </p><dl> |
|
130 <dt>Returns:</dt> |
|
131 <dd> |
|
132 column count (integer) |
|
133 </dd> |
|
134 </dl><a NAME="WatchPointModel.data" ID="WatchPointModel.data"></a> |
|
135 <h4>WatchPointModel.data</h4> |
|
136 <b>data</b>(<i>index, role</i>) |
|
137 <p> |
|
138 Public method to get the requested data. |
|
139 </p><dl> |
|
140 <dt><i>index</i></dt> |
|
141 <dd> |
|
142 index of the requested data (QModelIndex) |
|
143 </dd><dt><i>role</i></dt> |
|
144 <dd> |
|
145 role of the requested data (Qt.ItemDataRole) |
|
146 </dd> |
|
147 </dl><dl> |
|
148 <dt>Returns:</dt> |
|
149 <dd> |
|
150 the requested data |
|
151 </dd> |
|
152 </dl><a NAME="WatchPointModel.deleteAll" ID="WatchPointModel.deleteAll"></a> |
|
153 <h4>WatchPointModel.deleteAll</h4> |
|
154 <b>deleteAll</b>(<i></i>) |
|
155 <p> |
|
156 Public method to delete all watch expressions. |
|
157 </p><a NAME="WatchPointModel.deleteWatchPointByIndex" ID="WatchPointModel.deleteWatchPointByIndex"></a> |
|
158 <h4>WatchPointModel.deleteWatchPointByIndex</h4> |
|
159 <b>deleteWatchPointByIndex</b>(<i>index</i>) |
|
160 <p> |
|
161 Public method to set the values of a watch expression given by index. |
|
162 </p><dl> |
|
163 <dt><i>index</i></dt> |
|
164 <dd> |
|
165 index of the watch expression (QModelIndex) |
|
166 </dd> |
|
167 </dl><a NAME="WatchPointModel.deleteWatchPoints" ID="WatchPointModel.deleteWatchPoints"></a> |
|
168 <h4>WatchPointModel.deleteWatchPoints</h4> |
|
169 <b>deleteWatchPoints</b>(<i>idxList</i>) |
|
170 <p> |
|
171 Public method to delete a list of watch expressions given by their indexes. |
|
172 </p><dl> |
|
173 <dt><i>idxList</i></dt> |
|
174 <dd> |
|
175 list of watch expression indexes (list of QModelIndex) |
|
176 </dd> |
|
177 </dl><a NAME="WatchPointModel.flags" ID="WatchPointModel.flags"></a> |
|
178 <h4>WatchPointModel.flags</h4> |
|
179 <b>flags</b>(<i>index</i>) |
|
180 <p> |
|
181 Public method to get item flags. |
|
182 </p><dl> |
|
183 <dt><i>index</i></dt> |
|
184 <dd> |
|
185 index of the requested flags (QModelIndex) |
|
186 </dd> |
|
187 </dl><dl> |
|
188 <dt>Returns:</dt> |
|
189 <dd> |
|
190 item flags for the given index (Qt.ItemFlags) |
|
191 </dd> |
|
192 </dl><a NAME="WatchPointModel.getWatchPointByIndex" ID="WatchPointModel.getWatchPointByIndex"></a> |
|
193 <h4>WatchPointModel.getWatchPointByIndex</h4> |
|
194 <b>getWatchPointByIndex</b>(<i>index</i>) |
|
195 <p> |
|
196 Public method to get the values of a watch expression given by index. |
|
197 </p><dl> |
|
198 <dt><i>index</i></dt> |
|
199 <dd> |
|
200 index of the watch expression (QModelIndex) |
|
201 </dd> |
|
202 </dl><dl> |
|
203 <dt>Returns:</dt> |
|
204 <dd> |
|
205 watch expression (list of six values (expression, special condition, |
|
206 temporary flag, enabled flag, ignore count, index)) |
|
207 </dd> |
|
208 </dl><a NAME="WatchPointModel.getWatchPointIndex" ID="WatchPointModel.getWatchPointIndex"></a> |
|
209 <h4>WatchPointModel.getWatchPointIndex</h4> |
|
210 <b>getWatchPointIndex</b>(<i>cond, special = ""</i>) |
|
211 <p> |
|
212 Public method to get the index of a watch expression given by expression. |
|
213 </p><dl> |
|
214 <dt><i>cond</i></dt> |
|
215 <dd> |
|
216 expression of the watch expression (string) |
|
217 </dd><dt><i>special</i></dt> |
|
218 <dd> |
|
219 special condition of the watch expression (string) |
|
220 </dd> |
|
221 </dl><dl> |
|
222 <dt>Returns:</dt> |
|
223 <dd> |
|
224 index (QModelIndex) |
|
225 </dd> |
|
226 </dl><a NAME="WatchPointModel.hasChildren" ID="WatchPointModel.hasChildren"></a> |
|
227 <h4>WatchPointModel.hasChildren</h4> |
|
228 <b>hasChildren</b>(<i>parent = QModelIndex()</i>) |
|
229 <p> |
|
230 Public method to check for the presence of child items. |
|
231 </p><dl> |
|
232 <dt><i>parent</i></dt> |
|
233 <dd> |
|
234 index of parent item (QModelIndex) |
|
235 </dd> |
|
236 </dl><dl> |
|
237 <dt>Returns:</dt> |
|
238 <dd> |
|
239 flag indicating the presence of child items (boolean) |
|
240 </dd> |
|
241 </dl><a NAME="WatchPointModel.headerData" ID="WatchPointModel.headerData"></a> |
|
242 <h4>WatchPointModel.headerData</h4> |
|
243 <b>headerData</b>(<i>section, orientation, role = Qt.DisplayRole</i>) |
|
244 <p> |
|
245 Public method to get header data. |
|
246 </p><dl> |
|
247 <dt><i>section</i></dt> |
|
248 <dd> |
|
249 section number of the requested header data (integer) |
|
250 </dd><dt><i>orientation</i></dt> |
|
251 <dd> |
|
252 orientation of the header (Qt.Orientation) |
|
253 </dd><dt><i>role</i></dt> |
|
254 <dd> |
|
255 role of the requested data (Qt.ItemDataRole) |
|
256 </dd> |
|
257 </dl><dl> |
|
258 <dt>Returns:</dt> |
|
259 <dd> |
|
260 header data |
|
261 </dd> |
|
262 </dl><a NAME="WatchPointModel.index" ID="WatchPointModel.index"></a> |
|
263 <h4>WatchPointModel.index</h4> |
|
264 <b>index</b>(<i>row, column, parent = QModelIndex()</i>) |
|
265 <p> |
|
266 Public method to create an index. |
|
267 </p><dl> |
|
268 <dt><i>row</i></dt> |
|
269 <dd> |
|
270 row number for the index (integer) |
|
271 </dd><dt><i>column</i></dt> |
|
272 <dd> |
|
273 column number for the index (integer) |
|
274 </dd><dt><i>parent</i></dt> |
|
275 <dd> |
|
276 index of the parent item (QModelIndex) |
|
277 </dd> |
|
278 </dl><dl> |
|
279 <dt>Returns:</dt> |
|
280 <dd> |
|
281 requested index (QModelIndex) |
|
282 </dd> |
|
283 </dl><a NAME="WatchPointModel.parent" ID="WatchPointModel.parent"></a> |
|
284 <h4>WatchPointModel.parent</h4> |
|
285 <b>parent</b>(<i>index</i>) |
|
286 <p> |
|
287 Public method to get the parent index. |
|
288 </p><dl> |
|
289 <dt><i>index</i></dt> |
|
290 <dd> |
|
291 index of item to get parent (QModelIndex) |
|
292 </dd> |
|
293 </dl><dl> |
|
294 <dt>Returns:</dt> |
|
295 <dd> |
|
296 index of parent (QModelIndex) |
|
297 </dd> |
|
298 </dl><a NAME="WatchPointModel.rowCount" ID="WatchPointModel.rowCount"></a> |
|
299 <h4>WatchPointModel.rowCount</h4> |
|
300 <b>rowCount</b>(<i>parent = QModelIndex()</i>) |
|
301 <p> |
|
302 Public method to get the current row count. |
|
303 </p><dl> |
|
304 <dt>Returns:</dt> |
|
305 <dd> |
|
306 row count (integer) |
|
307 </dd> |
|
308 </dl><a NAME="WatchPointModel.setWatchPointByIndex" ID="WatchPointModel.setWatchPointByIndex"></a> |
|
309 <h4>WatchPointModel.setWatchPointByIndex</h4> |
|
310 <b>setWatchPointByIndex</b>(<i>index, cond, special, properties</i>) |
|
311 <p> |
|
312 Public method to set the values of a watch expression given by index. |
|
313 </p><dl> |
|
314 <dt><i>index</i></dt> |
|
315 <dd> |
|
316 index of the watch expression (QModelIndex) |
|
317 </dd><dt><i>cond</i></dt> |
|
318 <dd> |
|
319 expression of the watch expression (string) |
|
320 </dd><dt><i>special</i></dt> |
|
321 <dd> |
|
322 special condition of the watch expression (string) |
|
323 </dd><dt><i>properties</i></dt> |
|
324 <dd> |
|
325 properties of the watch expression |
|
326 (tuple of temporary flag (bool), enabled flag (bool), ignore count (integer)) |
|
327 </dd> |
|
328 </dl><a NAME="WatchPointModel.setWatchPointEnabledByIndex" ID="WatchPointModel.setWatchPointEnabledByIndex"></a> |
|
329 <h4>WatchPointModel.setWatchPointEnabledByIndex</h4> |
|
330 <b>setWatchPointEnabledByIndex</b>(<i>index, enabled</i>) |
|
331 <p> |
|
332 Public method to set the enabled state of a watch expression given by index. |
|
333 </p><dl> |
|
334 <dt><i>index</i></dt> |
|
335 <dd> |
|
336 index of the watch expression (QModelIndex) |
|
337 </dd><dt><i>enabled</i></dt> |
|
338 <dd> |
|
339 flag giving the enabled state (boolean) |
|
340 </dd> |
|
341 </dl> |
|
342 <div align="right"><a href="#top">Up</a></div> |
|
343 <hr /> |
|
344 </body></html> |