Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksModel.html
src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksModel.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10436
- f6881d10e995
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.Bookmarks.BookmarksModel</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.WebBrowser.Bookmarks.BookmarksModel</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the bookmark model class. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#BookmarksModel">BookmarksModel</a></td> | |
| 25 <td>Class implementing the bookmark model.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="BookmarksModel" ID="BookmarksModel"></a> | |
| 36 <h2>BookmarksModel</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the bookmark model. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QAbstractItemModel | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>MIMETYPE</td></tr><tr><td>SeparatorRole</td></tr><tr><td>TypeRole</td></tr><tr><td>UrlRole</td></tr><tr><td>UrlStringRole</td></tr><tr><td>VisitCountRole</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#BookmarksModel.__init__">BookmarksModel</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#BookmarksModel.bookmarksManager">bookmarksManager</a></td> | |
| 63 <td>Public method to get a reference to the bookmarks manager.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#BookmarksModel.columnCount">columnCount</a></td> | |
| 67 <td>Public method to get the number of columns.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#BookmarksModel.data">data</a></td> | |
| 71 <td>Public method to get data from the model.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#BookmarksModel.dropMimeData">dropMimeData</a></td> | |
| 75 <td>Public method to accept the mime data of a drop action.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#BookmarksModel.entryAdded">entryAdded</a></td> | |
| 79 <td>Public slot to add a bookmark node.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#BookmarksModel.entryChanged">entryChanged</a></td> | |
| 83 <td>Public method to change a node.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#BookmarksModel.entryRemoved">entryRemoved</a></td> | |
| 87 <td>Public slot to remove a bookmark node.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#BookmarksModel.flags">flags</a></td> | |
| 91 <td>Public method to get flags for a node cell.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#BookmarksModel.hasChildren">hasChildren</a></td> | |
| 95 <td>Public method to check, if a parent node has some children.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#BookmarksModel.headerData">headerData</a></td> | |
| 99 <td>Public method to get the header data.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#BookmarksModel.index">index</a></td> | |
| 103 <td>Public method to get a model index for a node cell.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#BookmarksModel.mimeData">mimeData</a></td> | |
| 107 <td>Public method to return the mime data.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#BookmarksModel.mimeTypes">mimeTypes</a></td> | |
| 111 <td>Public method to report the supported mime types.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#BookmarksModel.node">node</a></td> | |
| 115 <td>Public method to get a bookmark node given its index.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#BookmarksModel.nodeIndex">nodeIndex</a></td> | |
| 119 <td>Public method to get a model index.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#BookmarksModel.parent">parent</a></td> | |
| 123 <td>Public method to get the index of the parent node.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#BookmarksModel.removeRows">removeRows</a></td> | |
| 127 <td>Public method to remove bookmarks from the model.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#BookmarksModel.rowCount">rowCount</a></td> | |
| 131 <td>Public method to determine the number of rows.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#BookmarksModel.setData">setData</a></td> | |
| 135 <td>Public method to set the data of a node cell.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#BookmarksModel.supportedDropActions">supportedDropActions</a></td> | |
| 139 <td>Public method to report the supported drop actions.</td> | |
| 140 </tr> | |
| 141 </table> | |
| 142 <h3>Static Methods</h3> | |
| 143 | |
| 144 <table> | |
| 145 <tr><td>None</td></tr> | |
| 146 </table> | |
| 147 | |
| 148 <a NAME="BookmarksModel.__init__" ID="BookmarksModel.__init__"></a> | |
| 149 <h4>BookmarksModel (Constructor)</h4> | |
| 150 <b>BookmarksModel</b>(<i>manager, parent=None</i>) | |
| 151 | |
| 152 <p> | |
| 153 Constructor | |
| 154 </p> | |
| 155 <dl> | |
| 156 | |
| 157 <dt><i>manager</i></dt> | |
| 158 <dd> | |
| 159 reference to the bookmark manager object | |
| 160 (BookmarksManager) | |
| 161 </dd> | |
| 162 <dt><i>parent</i></dt> | |
| 163 <dd> | |
| 164 reference to the parent object (QObject) | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <a NAME="BookmarksModel.bookmarksManager" ID="BookmarksModel.bookmarksManager"></a> | |
| 168 <h4>BookmarksModel.bookmarksManager</h4> | |
| 169 <b>bookmarksManager</b>(<i></i>) | |
| 170 | |
| 171 <p> | |
| 172 Public method to get a reference to the bookmarks manager. | |
| 173 </p> | |
| 174 <dl> | |
| 175 <dt>Return:</dt> | |
| 176 <dd> | |
| 177 reference to the bookmarks manager object (BookmarksManager) | |
| 178 </dd> | |
| 179 </dl> | |
| 180 <a NAME="BookmarksModel.columnCount" ID="BookmarksModel.columnCount"></a> | |
| 181 <h4>BookmarksModel.columnCount</h4> | |
| 182 <b>columnCount</b>(<i>parent=None</i>) | |
| 183 | |
| 184 <p> | |
| 185 Public method to get the number of columns. | |
| 186 </p> | |
| 187 <dl> | |
| 188 | |
| 189 <dt><i>parent</i></dt> | |
| 190 <dd> | |
| 191 index of parent (QModelIndex) | |
| 192 </dd> | |
| 193 </dl> | |
| 194 <dl> | |
| 195 <dt>Return:</dt> | |
| 196 <dd> | |
| 197 number of columns (integer) | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <a NAME="BookmarksModel.data" ID="BookmarksModel.data"></a> | |
| 201 <h4>BookmarksModel.data</h4> | |
| 202 <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>) | |
| 203 | |
| 204 <p> | |
| 205 Public method to get data from the model. | |
| 206 </p> | |
| 207 <dl> | |
| 208 | |
| 209 <dt><i>index</i></dt> | |
| 210 <dd> | |
| 211 index of bookmark to get data for (QModelIndex) | |
| 212 </dd> | |
| 213 <dt><i>role</i></dt> | |
| 214 <dd> | |
| 215 data role (integer) | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <dl> | |
| 219 <dt>Return:</dt> | |
| 220 <dd> | |
| 221 bookmark data | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <a NAME="BookmarksModel.dropMimeData" ID="BookmarksModel.dropMimeData"></a> | |
| 225 <h4>BookmarksModel.dropMimeData</h4> | |
| 226 <b>dropMimeData</b>(<i>data, action, row, column, parent</i>) | |
| 227 | |
| 228 <p> | |
| 229 Public method to accept the mime data of a drop action. | |
| 230 </p> | |
| 231 <dl> | |
| 232 | |
| 233 <dt><i>data</i></dt> | |
| 234 <dd> | |
| 235 reference to the mime data (QMimeData) | |
| 236 </dd> | |
| 237 <dt><i>action</i></dt> | |
| 238 <dd> | |
| 239 drop action requested (Qt.DropAction) | |
| 240 </dd> | |
| 241 <dt><i>row</i></dt> | |
| 242 <dd> | |
| 243 row number (integer) | |
| 244 </dd> | |
| 245 <dt><i>column</i></dt> | |
| 246 <dd> | |
| 247 column number (integer) | |
| 248 </dd> | |
| 249 <dt><i>parent</i></dt> | |
| 250 <dd> | |
| 251 index of the parent node (QModelIndex) | |
| 252 </dd> | |
| 253 </dl> | |
| 254 <dl> | |
| 255 <dt>Return:</dt> | |
| 256 <dd> | |
| 257 flag indicating successful acceptance of the data (boolean) | |
| 258 </dd> | |
| 259 </dl> | |
| 260 <a NAME="BookmarksModel.entryAdded" ID="BookmarksModel.entryAdded"></a> | |
| 261 <h4>BookmarksModel.entryAdded</h4> | |
| 262 <b>entryAdded</b>(<i>node</i>) | |
| 263 | |
| 264 <p> | |
| 265 Public slot to add a bookmark node. | |
| 266 </p> | |
| 267 <dl> | |
| 268 | |
| 269 <dt><i>node</i></dt> | |
| 270 <dd> | |
| 271 reference to the bookmark node to add (BookmarkNode) | |
| 272 </dd> | |
| 273 </dl> | |
| 274 <a NAME="BookmarksModel.entryChanged" ID="BookmarksModel.entryChanged"></a> | |
| 275 <h4>BookmarksModel.entryChanged</h4> | |
| 276 <b>entryChanged</b>(<i>node</i>) | |
| 277 | |
| 278 <p> | |
| 279 Public method to change a node. | |
| 280 </p> | |
| 281 <dl> | |
| 282 | |
| 283 <dt><i>node</i></dt> | |
| 284 <dd> | |
| 285 reference to the bookmark node to change (BookmarkNode) | |
| 286 </dd> | |
| 287 </dl> | |
| 288 <a NAME="BookmarksModel.entryRemoved" ID="BookmarksModel.entryRemoved"></a> | |
| 289 <h4>BookmarksModel.entryRemoved</h4> | |
| 290 <b>entryRemoved</b>(<i>parent, row, node</i>) | |
| 291 | |
| 292 <p> | |
| 293 Public slot to remove a bookmark node. | |
| 294 </p> | |
| 295 <dl> | |
| 296 | |
| 297 <dt><i>parent</i></dt> | |
| 298 <dd> | |
| 299 reference to the parent bookmark node (BookmarkNode) | |
| 300 </dd> | |
| 301 <dt><i>row</i></dt> | |
| 302 <dd> | |
| 303 row number of the node (integer) | |
| 304 </dd> | |
| 305 <dt><i>node</i></dt> | |
| 306 <dd> | |
| 307 reference to the bookmark node to remove (BookmarkNode) | |
| 308 </dd> | |
| 309 </dl> | |
| 310 <a NAME="BookmarksModel.flags" ID="BookmarksModel.flags"></a> | |
| 311 <h4>BookmarksModel.flags</h4> | |
| 312 <b>flags</b>(<i>index</i>) | |
| 313 | |
| 314 <p> | |
| 315 Public method to get flags for a node cell. | |
| 316 </p> | |
| 317 <dl> | |
| 318 | |
| 319 <dt><i>index</i></dt> | |
| 320 <dd> | |
| 321 index of the node cell (QModelIndex) | |
| 322 </dd> | |
| 323 </dl> | |
| 324 <dl> | |
| 325 <dt>Return:</dt> | |
| 326 <dd> | |
| 327 flags (Qt.ItemFlags) | |
| 328 </dd> | |
| 329 </dl> | |
| 330 <a NAME="BookmarksModel.hasChildren" ID="BookmarksModel.hasChildren"></a> | |
| 331 <h4>BookmarksModel.hasChildren</h4> | |
| 332 <b>hasChildren</b>(<i>parent=None</i>) | |
| 333 | |
| 334 <p> | |
| 335 Public method to check, if a parent node has some children. | |
| 336 </p> | |
| 337 <dl> | |
| 338 | |
| 339 <dt><i>parent</i></dt> | |
| 340 <dd> | |
| 341 index of the parent node (QModelIndex) | |
| 342 </dd> | |
| 343 </dl> | |
| 344 <dl> | |
| 345 <dt>Return:</dt> | |
| 346 <dd> | |
| 347 flag indicating the presence of children (boolean) | |
| 348 </dd> | |
| 349 </dl> | |
| 350 <a NAME="BookmarksModel.headerData" ID="BookmarksModel.headerData"></a> | |
| 351 <h4>BookmarksModel.headerData</h4> | |
| 352 <b>headerData</b>(<i>section, orientation, role=Qt.ItemDataRole.DisplayRole</i>) | |
| 353 | |
| 354 <p> | |
| 355 Public method to get the header data. | |
| 356 </p> | |
| 357 <dl> | |
| 358 | |
| 359 <dt><i>section</i></dt> | |
| 360 <dd> | |
| 361 section number (integer) | |
| 362 </dd> | |
| 363 <dt><i>orientation</i></dt> | |
| 364 <dd> | |
| 365 header orientation (Qt.Orientation) | |
| 366 </dd> | |
| 367 <dt><i>role</i></dt> | |
| 368 <dd> | |
| 369 data role (Qt.ItemDataRole) | |
| 370 </dd> | |
| 371 </dl> | |
| 372 <dl> | |
| 373 <dt>Return:</dt> | |
| 374 <dd> | |
| 375 header data | |
| 376 </dd> | |
| 377 </dl> | |
| 378 <a NAME="BookmarksModel.index" ID="BookmarksModel.index"></a> | |
| 379 <h4>BookmarksModel.index</h4> | |
| 380 <b>index</b>(<i>row, column, parent=None</i>) | |
| 381 | |
| 382 <p> | |
| 383 Public method to get a model index for a node cell. | |
| 384 </p> | |
| 385 <dl> | |
| 386 | |
| 387 <dt><i>row</i></dt> | |
| 388 <dd> | |
| 389 row number (integer) | |
| 390 </dd> | |
| 391 <dt><i>column</i></dt> | |
| 392 <dd> | |
| 393 column number (integer) | |
| 394 </dd> | |
| 395 <dt><i>parent</i></dt> | |
| 396 <dd> | |
| 397 index of the parent (QModelIndex) | |
| 398 </dd> | |
| 399 </dl> | |
| 400 <dl> | |
| 401 <dt>Return:</dt> | |
| 402 <dd> | |
| 403 index (QModelIndex) | |
| 404 </dd> | |
| 405 </dl> | |
| 406 <a NAME="BookmarksModel.mimeData" ID="BookmarksModel.mimeData"></a> | |
| 407 <h4>BookmarksModel.mimeData</h4> | |
| 408 <b>mimeData</b>(<i>indexes</i>) | |
| 409 | |
| 410 <p> | |
| 411 Public method to return the mime data. | |
| 412 </p> | |
| 413 <dl> | |
| 414 | |
| 415 <dt><i>indexes</i></dt> | |
| 416 <dd> | |
| 417 list of indexes (QModelIndexList) | |
| 418 </dd> | |
| 419 </dl> | |
| 420 <dl> | |
| 421 <dt>Return:</dt> | |
| 422 <dd> | |
| 423 mime data (QMimeData) | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <a NAME="BookmarksModel.mimeTypes" ID="BookmarksModel.mimeTypes"></a> | |
| 427 <h4>BookmarksModel.mimeTypes</h4> | |
| 428 <b>mimeTypes</b>(<i></i>) | |
| 429 | |
| 430 <p> | |
| 431 Public method to report the supported mime types. | |
| 432 </p> | |
| 433 <dl> | |
| 434 <dt>Return:</dt> | |
| 435 <dd> | |
| 436 supported mime types (list of strings) | |
| 437 </dd> | |
| 438 </dl> | |
| 439 <a NAME="BookmarksModel.node" ID="BookmarksModel.node"></a> | |
| 440 <h4>BookmarksModel.node</h4> | |
| 441 <b>node</b>(<i>index</i>) | |
| 442 | |
| 443 <p> | |
| 444 Public method to get a bookmark node given its index. | |
| 445 </p> | |
| 446 <dl> | |
| 447 | |
| 448 <dt><i>index</i></dt> | |
| 449 <dd> | |
| 450 index of the node (QModelIndex) | |
| 451 </dd> | |
| 452 </dl> | |
| 453 <dl> | |
| 454 <dt>Return:</dt> | |
| 455 <dd> | |
| 456 bookmark node (BookmarkNode) | |
| 457 </dd> | |
| 458 </dl> | |
| 459 <a NAME="BookmarksModel.nodeIndex" ID="BookmarksModel.nodeIndex"></a> | |
| 460 <h4>BookmarksModel.nodeIndex</h4> | |
| 461 <b>nodeIndex</b>(<i>node</i>) | |
| 462 | |
| 463 <p> | |
| 464 Public method to get a model index. | |
| 465 </p> | |
| 466 <dl> | |
| 467 | |
| 468 <dt><i>node</i></dt> | |
| 469 <dd> | |
| 470 reference to the node to get the index for (BookmarkNode) | |
| 471 </dd> | |
| 472 </dl> | |
| 473 <dl> | |
| 474 <dt>Return:</dt> | |
| 475 <dd> | |
| 476 model index (QModelIndex) | |
| 477 </dd> | |
| 478 </dl> | |
| 479 <a NAME="BookmarksModel.parent" ID="BookmarksModel.parent"></a> | |
| 480 <h4>BookmarksModel.parent</h4> | |
| 481 <b>parent</b>(<i>index=None</i>) | |
| 482 | |
| 483 <p> | |
| 484 Public method to get the index of the parent node. | |
| 485 </p> | |
| 486 <dl> | |
| 487 | |
| 488 <dt><i>index</i></dt> | |
| 489 <dd> | |
| 490 index of the child node (QModelIndex) | |
| 491 </dd> | |
| 492 </dl> | |
| 493 <dl> | |
| 494 <dt>Return:</dt> | |
| 495 <dd> | |
| 496 index of the parent node (QModelIndex) | |
| 497 </dd> | |
| 498 </dl> | |
| 499 <a NAME="BookmarksModel.removeRows" ID="BookmarksModel.removeRows"></a> | |
| 500 <h4>BookmarksModel.removeRows</h4> | |
| 501 <b>removeRows</b>(<i>row, count, parent=None</i>) | |
| 502 | |
| 503 <p> | |
| 504 Public method to remove bookmarks from the model. | |
| 505 </p> | |
| 506 <dl> | |
| 507 | |
| 508 <dt><i>row</i></dt> | |
| 509 <dd> | |
| 510 row of the first bookmark to remove (integer) | |
| 511 </dd> | |
| 512 <dt><i>count</i></dt> | |
| 513 <dd> | |
| 514 number of bookmarks to remove (integer) | |
| 515 </dd> | |
| 516 <dt><i>parent</i></dt> | |
| 517 <dd> | |
| 518 index of the parent bookmark node (QModelIndex) | |
| 519 </dd> | |
| 520 </dl> | |
| 521 <dl> | |
| 522 <dt>Return:</dt> | |
| 523 <dd> | |
| 524 flag indicating successful removal (boolean) | |
| 525 </dd> | |
| 526 </dl> | |
| 527 <a NAME="BookmarksModel.rowCount" ID="BookmarksModel.rowCount"></a> | |
| 528 <h4>BookmarksModel.rowCount</h4> | |
| 529 <b>rowCount</b>(<i>parent=None</i>) | |
| 530 | |
| 531 <p> | |
| 532 Public method to determine the number of rows. | |
| 533 </p> | |
| 534 <dl> | |
| 535 | |
| 536 <dt><i>parent</i></dt> | |
| 537 <dd> | |
| 538 index of parent (QModelIndex) | |
| 539 </dd> | |
| 540 </dl> | |
| 541 <dl> | |
| 542 <dt>Return:</dt> | |
| 543 <dd> | |
| 544 number of rows (integer) | |
| 545 </dd> | |
| 546 </dl> | |
| 547 <a NAME="BookmarksModel.setData" ID="BookmarksModel.setData"></a> | |
| 548 <h4>BookmarksModel.setData</h4> | |
| 549 <b>setData</b>(<i>index, value, role=Qt.ItemDataRole.EditRole</i>) | |
| 550 | |
| 551 <p> | |
| 552 Public method to set the data of a node cell. | |
| 553 </p> | |
| 554 <dl> | |
| 555 | |
| 556 <dt><i>index</i></dt> | |
| 557 <dd> | |
| 558 index of the node cell (QModelIndex) | |
| 559 </dd> | |
| 560 <dt><i>value</i></dt> | |
| 561 <dd> | |
| 562 value to be set | |
| 563 </dd> | |
| 564 <dt><i>role</i></dt> | |
| 565 <dd> | |
| 566 role of the data (integer) | |
| 567 </dd> | |
| 568 </dl> | |
| 569 <dl> | |
| 570 <dt>Return:</dt> | |
| 571 <dd> | |
| 572 flag indicating success (boolean) | |
| 573 </dd> | |
| 574 </dl> | |
| 575 <a NAME="BookmarksModel.supportedDropActions" ID="BookmarksModel.supportedDropActions"></a> | |
| 576 <h4>BookmarksModel.supportedDropActions</h4> | |
| 577 <b>supportedDropActions</b>(<i></i>) | |
| 578 | |
| 579 <p> | |
| 580 Public method to report the supported drop actions. | |
| 581 </p> | |
| 582 <dl> | |
| 583 <dt>Return:</dt> | |
| 584 <dd> | |
| 585 supported drop actions (Qt.DropAction) | |
| 586 </dd> | |
| 587 </dl> | |
| 588 <div align="right"><a href="#top">Up</a></div> | |
| 589 <hr /> | |
| 590 </body></html> |
