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

eric ide

mercurial