Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial