Mercurial Repositories > eric / file comparison

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

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

Mercurial Repository: eric

eric ide

mercurial