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