Documentation/Source/eric6.Debugger.WatchPointModel.html

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

eric ide

mercurial