src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksModel.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.Bookmarks.BookmarksModel</h1> 9 <h1>eric7.WebBrowser.Bookmarks.BookmarksModel</h1>
10
11 <p> 10 <p>
12 Module implementing the bookmark model class. 11 Module implementing the bookmark model class.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#BookmarksModel">BookmarksModel</a></td> 22 <td><a href="#BookmarksModel">BookmarksModel</a></td>
25 <td>Class implementing the bookmark model.</td> 23 <td>Class implementing the bookmark model.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="BookmarksModel" ID="BookmarksModel"></a> 34 <a NAME="BookmarksModel" ID="BookmarksModel"></a>
36 <h2>BookmarksModel</h2> 35 <h2>BookmarksModel</h2>
37
38 <p> 36 <p>
39 Class implementing the bookmark model. 37 Class implementing the bookmark model.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QAbstractItemModel 41 QAbstractItemModel
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <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> 44 <tr><td>MIMETYPE</td></tr>
45 <tr><td>SeparatorRole</td></tr>
46 <tr><td>TypeRole</td></tr>
47 <tr><td>UrlRole</td></tr>
48 <tr><td>UrlStringRole</td></tr>
49 <tr><td>VisitCountRole</td></tr>
47 </table> 50 </table>
51
48 <h3>Class Methods</h3> 52 <h3>Class Methods</h3>
49
50 <table> 53 <table>
51 <tr><td>None</td></tr> 54 <tr><td>None</td></tr>
52 </table> 55 </table>
56
53 <h3>Methods</h3> 57 <h3>Methods</h3>
54
55 <table> 58 <table>
56
57 <tr> 59 <tr>
58 <td><a href="#BookmarksModel.__init__">BookmarksModel</a></td> 60 <td><a href="#BookmarksModel.__init__">BookmarksModel</a></td>
59 <td>Constructor</td> 61 <td>Constructor</td>
60 </tr> 62 </tr>
61 <tr> 63 <tr>
137 <tr> 139 <tr>
138 <td><a href="#BookmarksModel.supportedDropActions">supportedDropActions</a></td> 140 <td><a href="#BookmarksModel.supportedDropActions">supportedDropActions</a></td>
139 <td>Public method to report the supported drop actions.</td> 141 <td>Public method to report the supported drop actions.</td>
140 </tr> 142 </tr>
141 </table> 143 </table>
144
142 <h3>Static Methods</h3> 145 <h3>Static Methods</h3>
143
144 <table> 146 <table>
145 <tr><td>None</td></tr> 147 <tr><td>None</td></tr>
146 </table> 148 </table>
147 149
150
148 <a NAME="BookmarksModel.__init__" ID="BookmarksModel.__init__"></a> 151 <a NAME="BookmarksModel.__init__" ID="BookmarksModel.__init__"></a>
149 <h4>BookmarksModel (Constructor)</h4> 152 <h4>BookmarksModel (Constructor)</h4>
150 <b>BookmarksModel</b>(<i>manager, parent=None</i>) 153 <b>BookmarksModel</b>(<i>manager, parent=None</i>)
151
152 <p> 154 <p>
153 Constructor 155 Constructor
154 </p> 156 </p>
157
155 <dl> 158 <dl>
156 159
157 <dt><i>manager</i> (BookmarksManager)</dt> 160 <dt><i>manager</i> (BookmarksManager)</dt>
158 <dd> 161 <dd>
159 reference to the bookmarks manager object 162 reference to the bookmarks manager object
164 </dd> 167 </dd>
165 </dl> 168 </dl>
166 <a NAME="BookmarksModel.bookmarksManager" ID="BookmarksModel.bookmarksManager"></a> 169 <a NAME="BookmarksModel.bookmarksManager" ID="BookmarksModel.bookmarksManager"></a>
167 <h4>BookmarksModel.bookmarksManager</h4> 170 <h4>BookmarksModel.bookmarksManager</h4>
168 <b>bookmarksManager</b>(<i></i>) 171 <b>bookmarksManager</b>(<i></i>)
169
170 <p> 172 <p>
171 Public method to get a reference to the bookmarks manager. 173 Public method to get a reference to the bookmarks manager.
172 </p> 174 </p>
175
173 <dl> 176 <dl>
174 <dt>Return:</dt> 177 <dt>Return:</dt>
175 <dd> 178 <dd>
176 reference to the bookmarks manager object 179 reference to the bookmarks manager object
177 </dd> 180 </dd>
183 </dd> 186 </dd>
184 </dl> 187 </dl>
185 <a NAME="BookmarksModel.columnCount" ID="BookmarksModel.columnCount"></a> 188 <a NAME="BookmarksModel.columnCount" ID="BookmarksModel.columnCount"></a>
186 <h4>BookmarksModel.columnCount</h4> 189 <h4>BookmarksModel.columnCount</h4>
187 <b>columnCount</b>(<i>parent=None</i>) 190 <b>columnCount</b>(<i>parent=None</i>)
188
189 <p> 191 <p>
190 Public method to get the number of columns. 192 Public method to get the number of columns.
191 </p> 193 </p>
194
192 <dl> 195 <dl>
193 196
194 <dt><i>parent</i> (QModelIndex)</dt> 197 <dt><i>parent</i> (QModelIndex)</dt>
195 <dd> 198 <dd>
196 index of parent 199 index of parent
209 </dd> 212 </dd>
210 </dl> 213 </dl>
211 <a NAME="BookmarksModel.data" ID="BookmarksModel.data"></a> 214 <a NAME="BookmarksModel.data" ID="BookmarksModel.data"></a>
212 <h4>BookmarksModel.data</h4> 215 <h4>BookmarksModel.data</h4>
213 <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>) 216 <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>)
214
215 <p> 217 <p>
216 Public method to get data from the model. 218 Public method to get data from the model.
217 </p> 219 </p>
220
218 <dl> 221 <dl>
219 222
220 <dt><i>index</i> (QModelIndex)</dt> 223 <dt><i>index</i> (QModelIndex)</dt>
221 <dd> 224 <dd>
222 index of bookmark to get data for 225 index of bookmark to get data for
239 </dd> 242 </dd>
240 </dl> 243 </dl>
241 <a NAME="BookmarksModel.dropMimeData" ID="BookmarksModel.dropMimeData"></a> 244 <a NAME="BookmarksModel.dropMimeData" ID="BookmarksModel.dropMimeData"></a>
242 <h4>BookmarksModel.dropMimeData</h4> 245 <h4>BookmarksModel.dropMimeData</h4>
243 <b>dropMimeData</b>(<i>data, action, row, column, parent</i>) 246 <b>dropMimeData</b>(<i>data, action, row, column, parent</i>)
244
245 <p> 247 <p>
246 Public method to accept the mime data of a drop action. 248 Public method to accept the mime data of a drop action.
247 </p> 249 </p>
250
248 <dl> 251 <dl>
249 252
250 <dt><i>data</i> (QMimeData)</dt> 253 <dt><i>data</i> (QMimeData)</dt>
251 <dd> 254 <dd>
252 reference to the mime data 255 reference to the mime data
281 </dd> 284 </dd>
282 </dl> 285 </dl>
283 <a NAME="BookmarksModel.entryAdded" ID="BookmarksModel.entryAdded"></a> 286 <a NAME="BookmarksModel.entryAdded" ID="BookmarksModel.entryAdded"></a>
284 <h4>BookmarksModel.entryAdded</h4> 287 <h4>BookmarksModel.entryAdded</h4>
285 <b>entryAdded</b>(<i>node</i>) 288 <b>entryAdded</b>(<i>node</i>)
286
287 <p> 289 <p>
288 Public slot to add a bookmark node. 290 Public slot to add a bookmark node.
289 </p> 291 </p>
292
290 <dl> 293 <dl>
291 294
292 <dt><i>node</i> (BookmarkNode)</dt> 295 <dt><i>node</i> (BookmarkNode)</dt>
293 <dd> 296 <dd>
294 reference to the bookmark node to add 297 reference to the bookmark node to add
295 </dd> 298 </dd>
296 </dl> 299 </dl>
297 <a NAME="BookmarksModel.entryChanged" ID="BookmarksModel.entryChanged"></a> 300 <a NAME="BookmarksModel.entryChanged" ID="BookmarksModel.entryChanged"></a>
298 <h4>BookmarksModel.entryChanged</h4> 301 <h4>BookmarksModel.entryChanged</h4>
299 <b>entryChanged</b>(<i>node</i>) 302 <b>entryChanged</b>(<i>node</i>)
300
301 <p> 303 <p>
302 Public method to change a node. 304 Public method to change a node.
303 </p> 305 </p>
306
304 <dl> 307 <dl>
305 308
306 <dt><i>node</i> (BookmarkNode)</dt> 309 <dt><i>node</i> (BookmarkNode)</dt>
307 <dd> 310 <dd>
308 reference to the bookmark node to change 311 reference to the bookmark node to change
309 </dd> 312 </dd>
310 </dl> 313 </dl>
311 <a NAME="BookmarksModel.entryRemoved" ID="BookmarksModel.entryRemoved"></a> 314 <a NAME="BookmarksModel.entryRemoved" ID="BookmarksModel.entryRemoved"></a>
312 <h4>BookmarksModel.entryRemoved</h4> 315 <h4>BookmarksModel.entryRemoved</h4>
313 <b>entryRemoved</b>(<i>parent, row, node</i>) 316 <b>entryRemoved</b>(<i>parent, row, node</i>)
314
315 <p> 317 <p>
316 Public slot to remove a bookmark node. 318 Public slot to remove a bookmark node.
317 </p> 319 </p>
320
318 <dl> 321 <dl>
319 322
320 <dt><i>parent</i> (BookmarkNode)</dt> 323 <dt><i>parent</i> (BookmarkNode)</dt>
321 <dd> 324 <dd>
322 reference to the parent bookmark node 325 reference to the parent bookmark node
331 </dd> 334 </dd>
332 </dl> 335 </dl>
333 <a NAME="BookmarksModel.flags" ID="BookmarksModel.flags"></a> 336 <a NAME="BookmarksModel.flags" ID="BookmarksModel.flags"></a>
334 <h4>BookmarksModel.flags</h4> 337 <h4>BookmarksModel.flags</h4>
335 <b>flags</b>(<i>index</i>) 338 <b>flags</b>(<i>index</i>)
336
337 <p> 339 <p>
338 Public method to get flags for a node cell. 340 Public method to get flags for a node cell.
339 </p> 341 </p>
342
340 <dl> 343 <dl>
341 344
342 <dt><i>index</i> (QModelIndex)</dt> 345 <dt><i>index</i> (QModelIndex)</dt>
343 <dd> 346 <dd>
344 index of the node cell 347 index of the node cell
357 </dd> 360 </dd>
358 </dl> 361 </dl>
359 <a NAME="BookmarksModel.hasChildren" ID="BookmarksModel.hasChildren"></a> 362 <a NAME="BookmarksModel.hasChildren" ID="BookmarksModel.hasChildren"></a>
360 <h4>BookmarksModel.hasChildren</h4> 363 <h4>BookmarksModel.hasChildren</h4>
361 <b>hasChildren</b>(<i>parent=None</i>) 364 <b>hasChildren</b>(<i>parent=None</i>)
362
363 <p> 365 <p>
364 Public method to check, if a parent node has some children. 366 Public method to check, if a parent node has some children.
365 </p> 367 </p>
368
366 <dl> 369 <dl>
367 370
368 <dt><i>parent</i> (QModelIndex)</dt> 371 <dt><i>parent</i> (QModelIndex)</dt>
369 <dd> 372 <dd>
370 index of the parent node 373 index of the parent node
383 </dd> 386 </dd>
384 </dl> 387 </dl>
385 <a NAME="BookmarksModel.headerData" ID="BookmarksModel.headerData"></a> 388 <a NAME="BookmarksModel.headerData" ID="BookmarksModel.headerData"></a>
386 <h4>BookmarksModel.headerData</h4> 389 <h4>BookmarksModel.headerData</h4>
387 <b>headerData</b>(<i>section, orientation, role=Qt.ItemDataRole.DisplayRole</i>) 390 <b>headerData</b>(<i>section, orientation, role=Qt.ItemDataRole.DisplayRole</i>)
388
389 <p> 391 <p>
390 Public method to get the header data. 392 Public method to get the header data.
391 </p> 393 </p>
394
392 <dl> 395 <dl>
393 396
394 <dt><i>section</i> (int)</dt> 397 <dt><i>section</i> (int)</dt>
395 <dd> 398 <dd>
396 section number 399 section number
417 </dd> 420 </dd>
418 </dl> 421 </dl>
419 <a NAME="BookmarksModel.index" ID="BookmarksModel.index"></a> 422 <a NAME="BookmarksModel.index" ID="BookmarksModel.index"></a>
420 <h4>BookmarksModel.index</h4> 423 <h4>BookmarksModel.index</h4>
421 <b>index</b>(<i>row, column, parent=None</i>) 424 <b>index</b>(<i>row, column, parent=None</i>)
422
423 <p> 425 <p>
424 Public method to get a model index for a node cell. 426 Public method to get a model index for a node cell.
425 </p> 427 </p>
428
426 <dl> 429 <dl>
427 430
428 <dt><i>row</i> (int)</dt> 431 <dt><i>row</i> (int)</dt>
429 <dd> 432 <dd>
430 row number 433 row number
451 </dd> 454 </dd>
452 </dl> 455 </dl>
453 <a NAME="BookmarksModel.mimeData" ID="BookmarksModel.mimeData"></a> 456 <a NAME="BookmarksModel.mimeData" ID="BookmarksModel.mimeData"></a>
454 <h4>BookmarksModel.mimeData</h4> 457 <h4>BookmarksModel.mimeData</h4>
455 <b>mimeData</b>(<i>indexes</i>) 458 <b>mimeData</b>(<i>indexes</i>)
456
457 <p> 459 <p>
458 Public method to return the mime data. 460 Public method to return the mime data.
459 </p> 461 </p>
462
460 <dl> 463 <dl>
461 464
462 <dt><i>indexes</i> (QModelIndexList)</dt> 465 <dt><i>indexes</i> (QModelIndexList)</dt>
463 <dd> 466 <dd>
464 list of indexes 467 list of indexes
477 </dd> 480 </dd>
478 </dl> 481 </dl>
479 <a NAME="BookmarksModel.mimeTypes" ID="BookmarksModel.mimeTypes"></a> 482 <a NAME="BookmarksModel.mimeTypes" ID="BookmarksModel.mimeTypes"></a>
480 <h4>BookmarksModel.mimeTypes</h4> 483 <h4>BookmarksModel.mimeTypes</h4>
481 <b>mimeTypes</b>(<i></i>) 484 <b>mimeTypes</b>(<i></i>)
482
483 <p> 485 <p>
484 Public method to report the supported mime types. 486 Public method to report the supported mime types.
485 </p> 487 </p>
488
486 <dl> 489 <dl>
487 <dt>Return:</dt> 490 <dt>Return:</dt>
488 <dd> 491 <dd>
489 supported mime types 492 supported mime types
490 </dd> 493 </dd>
496 </dd> 499 </dd>
497 </dl> 500 </dl>
498 <a NAME="BookmarksModel.node" ID="BookmarksModel.node"></a> 501 <a NAME="BookmarksModel.node" ID="BookmarksModel.node"></a>
499 <h4>BookmarksModel.node</h4> 502 <h4>BookmarksModel.node</h4>
500 <b>node</b>(<i>index</i>) 503 <b>node</b>(<i>index</i>)
501
502 <p> 504 <p>
503 Public method to get a bookmark node given its index. 505 Public method to get a bookmark node given its index.
504 </p> 506 </p>
507
505 <dl> 508 <dl>
506 509
507 <dt><i>index</i> (QModelIndex)</dt> 510 <dt><i>index</i> (QModelIndex)</dt>
508 <dd> 511 <dd>
509 index of the node 512 index of the node
522 </dd> 525 </dd>
523 </dl> 526 </dl>
524 <a NAME="BookmarksModel.nodeIndex" ID="BookmarksModel.nodeIndex"></a> 527 <a NAME="BookmarksModel.nodeIndex" ID="BookmarksModel.nodeIndex"></a>
525 <h4>BookmarksModel.nodeIndex</h4> 528 <h4>BookmarksModel.nodeIndex</h4>
526 <b>nodeIndex</b>(<i>node</i>) 529 <b>nodeIndex</b>(<i>node</i>)
527
528 <p> 530 <p>
529 Public method to get a model index. 531 Public method to get a model index.
530 </p> 532 </p>
533
531 <dl> 534 <dl>
532 535
533 <dt><i>node</i> (BookmarkNode)</dt> 536 <dt><i>node</i> (BookmarkNode)</dt>
534 <dd> 537 <dd>
535 reference to the node to get the index for 538 reference to the node to get the index for
548 </dd> 551 </dd>
549 </dl> 552 </dl>
550 <a NAME="BookmarksModel.parent" ID="BookmarksModel.parent"></a> 553 <a NAME="BookmarksModel.parent" ID="BookmarksModel.parent"></a>
551 <h4>BookmarksModel.parent</h4> 554 <h4>BookmarksModel.parent</h4>
552 <b>parent</b>(<i>index=None</i>) 555 <b>parent</b>(<i>index=None</i>)
553
554 <p> 556 <p>
555 Public method to get the index of the parent node. 557 Public method to get the index of the parent node.
556 </p> 558 </p>
559
557 <dl> 560 <dl>
558 561
559 <dt><i>index</i> (QModelIndex)</dt> 562 <dt><i>index</i> (QModelIndex)</dt>
560 <dd> 563 <dd>
561 index of the child node 564 index of the child node
574 </dd> 577 </dd>
575 </dl> 578 </dl>
576 <a NAME="BookmarksModel.removeRows" ID="BookmarksModel.removeRows"></a> 579 <a NAME="BookmarksModel.removeRows" ID="BookmarksModel.removeRows"></a>
577 <h4>BookmarksModel.removeRows</h4> 580 <h4>BookmarksModel.removeRows</h4>
578 <b>removeRows</b>(<i>row, count, parent=None</i>) 581 <b>removeRows</b>(<i>row, count, parent=None</i>)
579
580 <p> 582 <p>
581 Public method to remove bookmarks from the model. 583 Public method to remove bookmarks from the model.
582 </p> 584 </p>
585
583 <dl> 586 <dl>
584 587
585 <dt><i>row</i> (int)</dt> 588 <dt><i>row</i> (int)</dt>
586 <dd> 589 <dd>
587 row of the first bookmark to remove 590 row of the first bookmark to remove
608 </dd> 611 </dd>
609 </dl> 612 </dl>
610 <a NAME="BookmarksModel.rowCount" ID="BookmarksModel.rowCount"></a> 613 <a NAME="BookmarksModel.rowCount" ID="BookmarksModel.rowCount"></a>
611 <h4>BookmarksModel.rowCount</h4> 614 <h4>BookmarksModel.rowCount</h4>
612 <b>rowCount</b>(<i>parent=None</i>) 615 <b>rowCount</b>(<i>parent=None</i>)
613
614 <p> 616 <p>
615 Public method to determine the number of rows. 617 Public method to determine the number of rows.
616 </p> 618 </p>
619
617 <dl> 620 <dl>
618 621
619 <dt><i>parent</i> (QModelIndex)</dt> 622 <dt><i>parent</i> (QModelIndex)</dt>
620 <dd> 623 <dd>
621 index of parent 624 index of parent
634 </dd> 637 </dd>
635 </dl> 638 </dl>
636 <a NAME="BookmarksModel.setData" ID="BookmarksModel.setData"></a> 639 <a NAME="BookmarksModel.setData" ID="BookmarksModel.setData"></a>
637 <h4>BookmarksModel.setData</h4> 640 <h4>BookmarksModel.setData</h4>
638 <b>setData</b>(<i>index, value, role=Qt.ItemDataRole.EditRole</i>) 641 <b>setData</b>(<i>index, value, role=Qt.ItemDataRole.EditRole</i>)
639
640 <p> 642 <p>
641 Public method to set the data of a node cell. 643 Public method to set the data of a node cell.
642 </p> 644 </p>
645
643 <dl> 646 <dl>
644 647
645 <dt><i>index</i> (QModelIndex)</dt> 648 <dt><i>index</i> (QModelIndex)</dt>
646 <dd> 649 <dd>
647 index of the node cell 650 index of the node cell
668 </dd> 671 </dd>
669 </dl> 672 </dl>
670 <a NAME="BookmarksModel.supportedDropActions" ID="BookmarksModel.supportedDropActions"></a> 673 <a NAME="BookmarksModel.supportedDropActions" ID="BookmarksModel.supportedDropActions"></a>
671 <h4>BookmarksModel.supportedDropActions</h4> 674 <h4>BookmarksModel.supportedDropActions</h4>
672 <b>supportedDropActions</b>(<i></i>) 675 <b>supportedDropActions</b>(<i></i>)
673
674 <p> 676 <p>
675 Public method to report the supported drop actions. 677 Public method to report the supported drop actions.
676 </p> 678 </p>
679
677 <dl> 680 <dl>
678 <dt>Return:</dt> 681 <dt>Return:</dt>
679 <dd> 682 <dd>
680 supported drop actions 683 supported drop actions
681 </dd> 684 </dd>

eric ide

mercurial