Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Debugger.BreakPointModel.html

Documentation/Source/eric6.Debugger.BreakPointModel.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.BreakPointModel</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.BreakPointModel</h1>
23 <p>
24 Module implementing the Breakpoint 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="#BreakPointModel">BreakPointModel</a></td>
34 <td>Class implementing a custom model for breakpoints.</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="BreakPointModel" ID="BreakPointModel"></a>
43 <h2>BreakPointModel</h2>
44 <p>
45 Class implementing a custom model for breakpoints.
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="#BreakPointModel.__init__">BreakPointModel</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#BreakPointModel.addBreakPoint">addBreakPoint</a></td>
64 <td>Public method to add a new breakpoint to the list.</td>
65 </tr><tr>
66 <td><a href="#BreakPointModel.columnCount">columnCount</a></td>
67 <td>Public method to get the current column count.</td>
68 </tr><tr>
69 <td><a href="#BreakPointModel.data">data</a></td>
70 <td>Public method to get the requested data.</td>
71 </tr><tr>
72 <td><a href="#BreakPointModel.deleteAll">deleteAll</a></td>
73 <td>Public method to delete all breakpoints.</td>
74 </tr><tr>
75 <td><a href="#BreakPointModel.deleteBreakPointByIndex">deleteBreakPointByIndex</a></td>
76 <td>Public method to set the values of a breakpoint given by index.</td>
77 </tr><tr>
78 <td><a href="#BreakPointModel.deleteBreakPoints">deleteBreakPoints</a></td>
79 <td>Public method to delete a list of breakpoints given by their indexes.</td>
80 </tr><tr>
81 <td><a href="#BreakPointModel.flags">flags</a></td>
82 <td>Public method to get item flags.</td>
83 </tr><tr>
84 <td><a href="#BreakPointModel.getBreakPointByIndex">getBreakPointByIndex</a></td>
85 <td>Public method to get the values of a breakpoint given by index.</td>
86 </tr><tr>
87 <td><a href="#BreakPointModel.getBreakPointIndex">getBreakPointIndex</a></td>
88 <td>Public method to get the index of a breakpoint given by filename and line number.</td>
89 </tr><tr>
90 <td><a href="#BreakPointModel.hasChildren">hasChildren</a></td>
91 <td>Public method to check for the presence of child items.</td>
92 </tr><tr>
93 <td><a href="#BreakPointModel.headerData">headerData</a></td>
94 <td>Public method to get header data.</td>
95 </tr><tr>
96 <td><a href="#BreakPointModel.index">index</a></td>
97 <td>Public method to create an index.</td>
98 </tr><tr>
99 <td><a href="#BreakPointModel.isBreakPointTemporaryByIndex">isBreakPointTemporaryByIndex</a></td>
100 <td>Public method to test, if a breakpoint given by its index is temporary.</td>
101 </tr><tr>
102 <td><a href="#BreakPointModel.parent">parent</a></td>
103 <td>Public method to get the parent index.</td>
104 </tr><tr>
105 <td><a href="#BreakPointModel.rowCount">rowCount</a></td>
106 <td>Public method to get the current row count.</td>
107 </tr><tr>
108 <td><a href="#BreakPointModel.setBreakPointByIndex">setBreakPointByIndex</a></td>
109 <td>Public method to set the values of a breakpoint given by index.</td>
110 </tr><tr>
111 <td><a href="#BreakPointModel.setBreakPointEnabledByIndex">setBreakPointEnabledByIndex</a></td>
112 <td>Public method to set the enabled state of a breakpoint given by index.</td>
113 </tr><tr>
114 <td><a href="#BreakPointModel.setData">setData</a></td>
115 <td>Public method to change data in the model.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122 <a NAME="BreakPointModel.__init__" ID="BreakPointModel.__init__"></a>
123 <h4>BreakPointModel (Constructor)</h4>
124 <b>BreakPointModel</b>(<i>parent=None</i>)
125 <p>
126 Constructor
127 </p><dl>
128 <dt><i>parent</i></dt>
129 <dd>
130 reference to the parent widget (QObject)
131 </dd>
132 </dl><a NAME="BreakPointModel.addBreakPoint" ID="BreakPointModel.addBreakPoint"></a>
133 <h4>BreakPointModel.addBreakPoint</h4>
134 <b>addBreakPoint</b>(<i>fn, line, properties</i>)
135 <p>
136 Public method to add a new breakpoint to the list.
137 </p><dl>
138 <dt><i>fn</i></dt>
139 <dd>
140 filename of the breakpoint (string)
141 </dd><dt><i>line</i></dt>
142 <dd>
143 line number of the breakpoint (integer)
144 </dd><dt><i>properties</i></dt>
145 <dd>
146 properties of the breakpoint
147 (tuple of condition (string), temporary flag (bool),
148 enabled flag (bool), ignore count (integer))
149 </dd>
150 </dl><a NAME="BreakPointModel.columnCount" ID="BreakPointModel.columnCount"></a>
151 <h4>BreakPointModel.columnCount</h4>
152 <b>columnCount</b>(<i>parent=QModelIndex()</i>)
153 <p>
154 Public method to get the current column count.
155 </p><dl>
156 <dt><i>parent</i></dt>
157 <dd>
158 reference to parent index (QModelIndex)
159 </dd>
160 </dl><dl>
161 <dt>Returns:</dt>
162 <dd>
163 column count (integer)
164 </dd>
165 </dl><a NAME="BreakPointModel.data" ID="BreakPointModel.data"></a>
166 <h4>BreakPointModel.data</h4>
167 <b>data</b>(<i>index, role=Qt.DisplayRole</i>)
168 <p>
169 Public method to get the requested data.
170 </p><dl>
171 <dt><i>index</i></dt>
172 <dd>
173 index of the requested data (QModelIndex)
174 </dd><dt><i>role</i></dt>
175 <dd>
176 role of the requested data (Qt.ItemDataRole)
177 </dd>
178 </dl><dl>
179 <dt>Returns:</dt>
180 <dd>
181 the requested data
182 </dd>
183 </dl><a NAME="BreakPointModel.deleteAll" ID="BreakPointModel.deleteAll"></a>
184 <h4>BreakPointModel.deleteAll</h4>
185 <b>deleteAll</b>(<i></i>)
186 <p>
187 Public method to delete all breakpoints.
188 </p><a NAME="BreakPointModel.deleteBreakPointByIndex" ID="BreakPointModel.deleteBreakPointByIndex"></a>
189 <h4>BreakPointModel.deleteBreakPointByIndex</h4>
190 <b>deleteBreakPointByIndex</b>(<i>index</i>)
191 <p>
192 Public method to set the values of a breakpoint given by index.
193 </p><dl>
194 <dt><i>index</i></dt>
195 <dd>
196 index of the breakpoint (QModelIndex)
197 </dd>
198 </dl><a NAME="BreakPointModel.deleteBreakPoints" ID="BreakPointModel.deleteBreakPoints"></a>
199 <h4>BreakPointModel.deleteBreakPoints</h4>
200 <b>deleteBreakPoints</b>(<i>idxList</i>)
201 <p>
202 Public method to delete a list of breakpoints given by their indexes.
203 </p><dl>
204 <dt><i>idxList</i></dt>
205 <dd>
206 list of breakpoint indexes (list of QModelIndex)
207 </dd>
208 </dl><a NAME="BreakPointModel.flags" ID="BreakPointModel.flags"></a>
209 <h4>BreakPointModel.flags</h4>
210 <b>flags</b>(<i>index</i>)
211 <p>
212 Public method to get item flags.
213 </p><dl>
214 <dt><i>index</i></dt>
215 <dd>
216 index of the requested flags (QModelIndex)
217 </dd>
218 </dl><dl>
219 <dt>Returns:</dt>
220 <dd>
221 item flags for the given index (Qt.ItemFlags)
222 </dd>
223 </dl><a NAME="BreakPointModel.getBreakPointByIndex" ID="BreakPointModel.getBreakPointByIndex"></a>
224 <h4>BreakPointModel.getBreakPointByIndex</h4>
225 <b>getBreakPointByIndex</b>(<i>index</i>)
226 <p>
227 Public method to get the values of a breakpoint given by index.
228 </p><dl>
229 <dt><i>index</i></dt>
230 <dd>
231 index of the breakpoint (QModelIndex)
232 </dd>
233 </dl><dl>
234 <dt>Returns:</dt>
235 <dd>
236 breakpoint (list of seven values (filename, line number,
237 condition, temporary flag, enabled flag, ignore count))
238 </dd>
239 </dl><a NAME="BreakPointModel.getBreakPointIndex" ID="BreakPointModel.getBreakPointIndex"></a>
240 <h4>BreakPointModel.getBreakPointIndex</h4>
241 <b>getBreakPointIndex</b>(<i>fn, lineno</i>)
242 <p>
243 Public method to get the index of a breakpoint given by filename and
244 line number.
245 </p><dl>
246 <dt><i>fn</i></dt>
247 <dd>
248 filename of the breakpoint (string)
249 </dd><dt><i>lineno</i></dt>
250 <dd>
251 line number of the breakpoint (integer)
252 </dd>
253 </dl><dl>
254 <dt>Returns:</dt>
255 <dd>
256 index (QModelIndex)
257 </dd>
258 </dl><a NAME="BreakPointModel.hasChildren" ID="BreakPointModel.hasChildren"></a>
259 <h4>BreakPointModel.hasChildren</h4>
260 <b>hasChildren</b>(<i>parent=QModelIndex()</i>)
261 <p>
262 Public method to check for the presence of child items.
263 </p><dl>
264 <dt><i>parent</i></dt>
265 <dd>
266 index of parent item (QModelIndex)
267 </dd>
268 </dl><dl>
269 <dt>Returns:</dt>
270 <dd>
271 flag indicating the presence of child items (boolean)
272 </dd>
273 </dl><a NAME="BreakPointModel.headerData" ID="BreakPointModel.headerData"></a>
274 <h4>BreakPointModel.headerData</h4>
275 <b>headerData</b>(<i>section, orientation, role=Qt.DisplayRole</i>)
276 <p>
277 Public method to get header data.
278 </p><dl>
279 <dt><i>section</i></dt>
280 <dd>
281 section number of the requested header data (integer)
282 </dd><dt><i>orientation</i></dt>
283 <dd>
284 orientation of the header (Qt.Orientation)
285 </dd><dt><i>role</i></dt>
286 <dd>
287 role of the requested data (Qt.ItemDataRole)
288 </dd>
289 </dl><dl>
290 <dt>Returns:</dt>
291 <dd>
292 header data
293 </dd>
294 </dl><a NAME="BreakPointModel.index" ID="BreakPointModel.index"></a>
295 <h4>BreakPointModel.index</h4>
296 <b>index</b>(<i>row, column, parent=QModelIndex()</i>)
297 <p>
298 Public method to create an index.
299 </p><dl>
300 <dt><i>row</i></dt>
301 <dd>
302 row number for the index (integer)
303 </dd><dt><i>column</i></dt>
304 <dd>
305 column number for the index (integer)
306 </dd><dt><i>parent</i></dt>
307 <dd>
308 index of the parent item (QModelIndex)
309 </dd>
310 </dl><dl>
311 <dt>Returns:</dt>
312 <dd>
313 requested index (QModelIndex)
314 </dd>
315 </dl><a NAME="BreakPointModel.isBreakPointTemporaryByIndex" ID="BreakPointModel.isBreakPointTemporaryByIndex"></a>
316 <h4>BreakPointModel.isBreakPointTemporaryByIndex</h4>
317 <b>isBreakPointTemporaryByIndex</b>(<i>index</i>)
318 <p>
319 Public method to test, if a breakpoint given by its index is temporary.
320 </p><dl>
321 <dt><i>index</i></dt>
322 <dd>
323 index of the breakpoint to test (QModelIndex)
324 </dd>
325 </dl><dl>
326 <dt>Returns:</dt>
327 <dd>
328 flag indicating a temporary breakpoint (boolean)
329 </dd>
330 </dl><a NAME="BreakPointModel.parent" ID="BreakPointModel.parent"></a>
331 <h4>BreakPointModel.parent</h4>
332 <b>parent</b>(<i>index</i>)
333 <p>
334 Public method to get the parent index.
335 </p><dl>
336 <dt><i>index</i></dt>
337 <dd>
338 index of item to get parent (QModelIndex)
339 </dd>
340 </dl><dl>
341 <dt>Returns:</dt>
342 <dd>
343 index of parent (QModelIndex)
344 </dd>
345 </dl><a NAME="BreakPointModel.rowCount" ID="BreakPointModel.rowCount"></a>
346 <h4>BreakPointModel.rowCount</h4>
347 <b>rowCount</b>(<i>parent=QModelIndex()</i>)
348 <p>
349 Public method to get the current row count.
350 </p><dl>
351 <dt><i>parent</i></dt>
352 <dd>
353 reference to parent index (QModelIndex)
354 </dd>
355 </dl><dl>
356 <dt>Returns:</dt>
357 <dd>
358 row count (integer)
359 </dd>
360 </dl><a NAME="BreakPointModel.setBreakPointByIndex" ID="BreakPointModel.setBreakPointByIndex"></a>
361 <h4>BreakPointModel.setBreakPointByIndex</h4>
362 <b>setBreakPointByIndex</b>(<i>index, fn, line, properties</i>)
363 <p>
364 Public method to set the values of a breakpoint given by index.
365 </p><dl>
366 <dt><i>index</i></dt>
367 <dd>
368 index of the breakpoint (QModelIndex)
369 </dd><dt><i>fn</i></dt>
370 <dd>
371 filename of the breakpoint (string)
372 </dd><dt><i>line</i></dt>
373 <dd>
374 line number of the breakpoint (integer)
375 </dd><dt><i>properties</i></dt>
376 <dd>
377 properties of the breakpoint
378 (tuple of condition (string), temporary flag (bool),
379 enabled flag (bool), ignore count (integer))
380 </dd>
381 </dl><a NAME="BreakPointModel.setBreakPointEnabledByIndex" ID="BreakPointModel.setBreakPointEnabledByIndex"></a>
382 <h4>BreakPointModel.setBreakPointEnabledByIndex</h4>
383 <b>setBreakPointEnabledByIndex</b>(<i>index, enabled</i>)
384 <p>
385 Public method to set the enabled state of a breakpoint given by index.
386 </p><dl>
387 <dt><i>index</i></dt>
388 <dd>
389 index of the breakpoint (QModelIndex)
390 </dd><dt><i>enabled</i></dt>
391 <dd>
392 flag giving the enabled state (boolean)
393 </dd>
394 </dl><a NAME="BreakPointModel.setData" ID="BreakPointModel.setData"></a>
395 <h4>BreakPointModel.setData</h4>
396 <b>setData</b>(<i>index, value, role=Qt.EditRole</i>)
397 <p>
398 Public method to change data in the model.
399 </p><dl>
400 <dt><i>index</i></dt>
401 <dd>
402 index of the changed data (QModelIndex)
403 </dd><dt><i>value</i></dt>
404 <dd>
405 value of the changed data
406 </dd><dt><i>role</i></dt>
407 <dd>
408 role of the changed data (Qt.ItemDataRole)
409 </dd>
410 </dl><dl>
411 <dt>Returns:</dt>
412 <dd>
413 flag indicating success (boolean)
414 </dd>
415 </dl>
416 <div align="right"><a href="#top">Up</a></div>
417 <hr />
418 </body></html>

Mercurial Repository: eric

eric ide

mercurial