Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksManager.html
src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksManager.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.Bookmarks.BookmarksManager</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.BookmarksManager</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the bookmarks manager. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>BOOKMARKBAR</td></tr><tr><td>BOOKMARKMENU</td></tr><tr><td>StartMenu</td></tr><tr><td>StartRoot</td></tr><tr><td>StartToolBar</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#BookmarksManager">BookmarksManager</a></td> | |
| 25 <td>Class implementing the bookmarks manager.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#ChangeBookmarkCommand">ChangeBookmarkCommand</a></td> | |
| 29 <td>Class implementing the Insert undo command.</td> | |
| 30 </tr> | |
| 31 <tr> | |
| 32 <td><a href="#InsertBookmarksCommand">InsertBookmarksCommand</a></td> | |
| 33 <td>Class implementing the Insert undo command.</td> | |
| 34 </tr> | |
| 35 <tr> | |
| 36 <td><a href="#RemoveBookmarksCommand">RemoveBookmarksCommand</a></td> | |
| 37 <td>Class implementing the Remove undo command.</td> | |
| 38 </tr> | |
| 39 </table> | |
| 40 <h3>Functions</h3> | |
| 41 | |
| 42 <table> | |
| 43 <tr><td>None</td></tr> | |
| 44 </table> | |
| 45 <hr /> | |
| 46 <hr /> | |
| 47 <a NAME="BookmarksManager" ID="BookmarksManager"></a> | |
| 48 <h2>BookmarksManager</h2> | |
| 49 | |
| 50 <p> | |
| 51 Class implementing the bookmarks manager. | |
| 52 </p> | |
| 53 <h3>Signals</h3> | |
| 54 <dl> | |
| 55 | |
| 56 <dt>bookmarksReloaded()</dt> | |
| 57 <dd> | |
| 58 emitted after the bookmarks were reloaded | |
| 59 </dd> | |
| 60 <dt>bookmarksSaved()</dt> | |
| 61 <dd> | |
| 62 emitted after the bookmarks were saved | |
| 63 </dd> | |
| 64 <dt>entryAdded(BookmarkNode)</dt> | |
| 65 <dd> | |
| 66 emitted after a bookmark node has been | |
| 67 added | |
| 68 </dd> | |
| 69 <dt>entryChanged(BookmarkNode)</dt> | |
| 70 <dd> | |
| 71 emitted after a bookmark node has been | |
| 72 changed | |
| 73 </dd> | |
| 74 <dt>entryRemoved(BookmarkNode, int, BookmarkNode)</dt> | |
| 75 <dd> | |
| 76 emitted after a | |
| 77 bookmark node has been removed | |
| 78 </dd> | |
| 79 </dl> | |
| 80 <h3>Derived from</h3> | |
| 81 QObject | |
| 82 <h3>Class Attributes</h3> | |
| 83 | |
| 84 <table> | |
| 85 <tr><td>None</td></tr> | |
| 86 </table> | |
| 87 <h3>Class Methods</h3> | |
| 88 | |
| 89 <table> | |
| 90 | |
| 91 <tr> | |
| 92 <td><a href="#BookmarksManager.getFileName">getFileName</a></td> | |
| 93 <td>Class method to get the file name of the bookmark file.</td> | |
| 94 </tr> | |
| 95 </table> | |
| 96 <h3>Methods</h3> | |
| 97 | |
| 98 <table> | |
| 99 | |
| 100 <tr> | |
| 101 <td><a href="#BookmarksManager.__init__">BookmarksManager</a></td> | |
| 102 <td>Constructor</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#BookmarksManager.__initialize">__initialize</a></td> | |
| 106 <td>Private method to initialize some data.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#BookmarksManager.__searchBookmark">__searchBookmark</a></td> | |
| 110 <td>Private method get a bookmark node for a given URL.</td> | |
| 111 </tr> | |
| 112 <tr> | |
| 113 <td><a href="#BookmarksManager.__searchBookmarks">__searchBookmarks</a></td> | |
| 114 <td>Private method get a list of bookmark nodes for a given URL.</td> | |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#BookmarksManager.addBookmark">addBookmark</a></td> | |
| 118 <td>Public method to add a bookmark.</td> | |
| 119 </tr> | |
| 120 <tr> | |
| 121 <td><a href="#BookmarksManager.bookmarkForUrl">bookmarkForUrl</a></td> | |
| 122 <td>Public method to get a bookmark node for a given URL.</td> | |
| 123 </tr> | |
| 124 <tr> | |
| 125 <td><a href="#BookmarksManager.bookmarks">bookmarks</a></td> | |
| 126 <td>Public method to get a reference to the root bookmark node.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 129 <td><a href="#BookmarksManager.bookmarksForUrl">bookmarksForUrl</a></td> | |
| 130 <td>Public method to get a list of bookmark nodes for a given URL.</td> | |
| 131 </tr> | |
| 132 <tr> | |
| 133 <td><a href="#BookmarksManager.bookmarksModel">bookmarksModel</a></td> | |
| 134 <td>Public method to get a reference to the bookmarks model.</td> | |
| 135 </tr> | |
| 136 <tr> | |
| 137 <td><a href="#BookmarksManager.changeExpanded">changeExpanded</a></td> | |
| 138 <td>Public method to handle a change of the expanded state.</td> | |
| 139 </tr> | |
| 140 <tr> | |
| 141 <td><a href="#BookmarksManager.close">close</a></td> | |
| 142 <td>Public method to close the bookmark manager.</td> | |
| 143 </tr> | |
| 144 <tr> | |
| 145 <td><a href="#BookmarksManager.exportBookmarks">exportBookmarks</a></td> | |
| 146 <td>Public method to export the bookmarks.</td> | |
| 147 </tr> | |
| 148 <tr> | |
| 149 <td><a href="#BookmarksManager.faviconChanged">faviconChanged</a></td> | |
| 150 <td>Public slot to update the icon image for an URL.</td> | |
| 151 </tr> | |
| 152 <tr> | |
| 153 <td><a href="#BookmarksManager.importBookmarks">importBookmarks</a></td> | |
| 154 <td>Public method to import bookmarks.</td> | |
| 155 </tr> | |
| 156 <tr> | |
| 157 <td><a href="#BookmarksManager.incVisitCount">incVisitCount</a></td> | |
| 158 <td>Public method to increment the visit count of a bookmark.</td> | |
| 159 </tr> | |
| 160 <tr> | |
| 161 <td><a href="#BookmarksManager.load">load</a></td> | |
| 162 <td>Public method to load the bookmarks.</td> | |
| 163 </tr> | |
| 164 <tr> | |
| 165 <td><a href="#BookmarksManager.menu">menu</a></td> | |
| 166 <td>Public method to get a reference to the bookmarks menu node.</td> | |
| 167 </tr> | |
| 168 <tr> | |
| 169 <td><a href="#BookmarksManager.reload">reload</a></td> | |
| 170 <td>Public method used to initiate a reloading of the bookmarks.</td> | |
| 171 </tr> | |
| 172 <tr> | |
| 173 <td><a href="#BookmarksManager.removeBookmark">removeBookmark</a></td> | |
| 174 <td>Public method to remove a bookmark.</td> | |
| 175 </tr> | |
| 176 <tr> | |
| 177 <td><a href="#BookmarksManager.save">save</a></td> | |
| 178 <td>Public method to save the bookmarks.</td> | |
| 179 </tr> | |
| 180 <tr> | |
| 181 <td><a href="#BookmarksManager.setNodeChanged">setNodeChanged</a></td> | |
| 182 <td>Public method to signal changes of bookmarks other than title, URL or timestamp.</td> | |
| 183 </tr> | |
| 184 <tr> | |
| 185 <td><a href="#BookmarksManager.setTimestamp">setTimestamp</a></td> | |
| 186 <td>Public method to set the URL of a bookmark.</td> | |
| 187 </tr> | |
| 188 <tr> | |
| 189 <td><a href="#BookmarksManager.setTitle">setTitle</a></td> | |
| 190 <td>Public method to set the title of a bookmark.</td> | |
| 191 </tr> | |
| 192 <tr> | |
| 193 <td><a href="#BookmarksManager.setUrl">setUrl</a></td> | |
| 194 <td>Public method to set the URL of a bookmark.</td> | |
| 195 </tr> | |
| 196 <tr> | |
| 197 <td><a href="#BookmarksManager.setVisitCount">setVisitCount</a></td> | |
| 198 <td>Public method to set the visit count of a bookmark.</td> | |
| 199 </tr> | |
| 200 <tr> | |
| 201 <td><a href="#BookmarksManager.toolbar">toolbar</a></td> | |
| 202 <td>Public method to get a reference to the bookmarks toolbar node.</td> | |
| 203 </tr> | |
| 204 <tr> | |
| 205 <td><a href="#BookmarksManager.undoRedoStack">undoRedoStack</a></td> | |
| 206 <td>Public method to get a reference to the undo stack.</td> | |
| 207 </tr> | |
| 208 </table> | |
| 209 <h3>Static Methods</h3> | |
| 210 | |
| 211 <table> | |
| 212 <tr><td>None</td></tr> | |
| 213 </table> | |
| 214 | |
| 215 <a NAME="BookmarksManager.getFileName" ID="BookmarksManager.getFileName"></a> | |
| 216 <h4>BookmarksManager.getFileName (class method)</h4> | |
| 217 <b>getFileName</b>(<i></i>) | |
| 218 | |
| 219 <p> | |
| 220 Class method to get the file name of the bookmark file. | |
| 221 </p> | |
| 222 <dl> | |
| 223 <dt>Return:</dt> | |
| 224 <dd> | |
| 225 name of the bookmark file (string) | |
| 226 </dd> | |
| 227 </dl> | |
| 228 <a NAME="BookmarksManager.__init__" ID="BookmarksManager.__init__"></a> | |
| 229 <h4>BookmarksManager (Constructor)</h4> | |
| 230 <b>BookmarksManager</b>(<i>parent=None</i>) | |
| 231 | |
| 232 <p> | |
| 233 Constructor | |
| 234 </p> | |
| 235 <dl> | |
| 236 | |
| 237 <dt><i>parent</i></dt> | |
| 238 <dd> | |
| 239 reference to the parent object (QObject) | |
| 240 </dd> | |
| 241 </dl> | |
| 242 <a NAME="BookmarksManager.__initialize" ID="BookmarksManager.__initialize"></a> | |
| 243 <h4>BookmarksManager.__initialize</h4> | |
| 244 <b>__initialize</b>(<i></i>) | |
| 245 | |
| 246 <p> | |
| 247 Private method to initialize some data. | |
| 248 </p> | |
| 249 <a NAME="BookmarksManager.__searchBookmark" ID="BookmarksManager.__searchBookmark"></a> | |
| 250 <h4>BookmarksManager.__searchBookmark</h4> | |
| 251 <b>__searchBookmark</b>(<i>url, startNode</i>) | |
| 252 | |
| 253 <p> | |
| 254 Private method get a bookmark node for a given URL. | |
| 255 </p> | |
| 256 <dl> | |
| 257 | |
| 258 <dt><i>url</i></dt> | |
| 259 <dd> | |
| 260 URL of the bookmark to search for (string) | |
| 261 </dd> | |
| 262 <dt><i>startNode</i></dt> | |
| 263 <dd> | |
| 264 reference to the node to start searching | |
| 265 (BookmarkNode) | |
| 266 </dd> | |
| 267 </dl> | |
| 268 <dl> | |
| 269 <dt>Return:</dt> | |
| 270 <dd> | |
| 271 bookmark node for the given url (BookmarkNode) | |
| 272 </dd> | |
| 273 </dl> | |
| 274 <a NAME="BookmarksManager.__searchBookmarks" ID="BookmarksManager.__searchBookmarks"></a> | |
| 275 <h4>BookmarksManager.__searchBookmarks</h4> | |
| 276 <b>__searchBookmarks</b>(<i>url, startNode</i>) | |
| 277 | |
| 278 <p> | |
| 279 Private method get a list of bookmark nodes for a given URL. | |
| 280 </p> | |
| 281 <dl> | |
| 282 | |
| 283 <dt><i>url</i></dt> | |
| 284 <dd> | |
| 285 URL of the bookmarks to search for (string) | |
| 286 </dd> | |
| 287 <dt><i>startNode</i></dt> | |
| 288 <dd> | |
| 289 reference to the node to start searching | |
| 290 (BookmarkNode) | |
| 291 </dd> | |
| 292 </dl> | |
| 293 <dl> | |
| 294 <dt>Return:</dt> | |
| 295 <dd> | |
| 296 list of bookmark nodes for the given url (list of BookmarkNode) | |
| 297 </dd> | |
| 298 </dl> | |
| 299 <a NAME="BookmarksManager.addBookmark" ID="BookmarksManager.addBookmark"></a> | |
| 300 <h4>BookmarksManager.addBookmark</h4> | |
| 301 <b>addBookmark</b>(<i>parent, node, row=-1</i>) | |
| 302 | |
| 303 <p> | |
| 304 Public method to add a bookmark. | |
| 305 </p> | |
| 306 <dl> | |
| 307 | |
| 308 <dt><i>parent</i></dt> | |
| 309 <dd> | |
| 310 reference to the node to add to (BookmarkNode) | |
| 311 </dd> | |
| 312 <dt><i>node</i></dt> | |
| 313 <dd> | |
| 314 reference to the node to add (BookmarkNode) | |
| 315 </dd> | |
| 316 <dt><i>row</i></dt> | |
| 317 <dd> | |
| 318 row number (integer) | |
| 319 </dd> | |
| 320 </dl> | |
| 321 <a NAME="BookmarksManager.bookmarkForUrl" ID="BookmarksManager.bookmarkForUrl"></a> | |
| 322 <h4>BookmarksManager.bookmarkForUrl</h4> | |
| 323 <b>bookmarkForUrl</b>(<i>url, start=StartRoot</i>) | |
| 324 | |
| 325 <p> | |
| 326 Public method to get a bookmark node for a given URL. | |
| 327 </p> | |
| 328 <dl> | |
| 329 | |
| 330 <dt><i>url</i></dt> | |
| 331 <dd> | |
| 332 URL of the bookmark to search for (QUrl or string) | |
| 333 </dd> | |
| 334 <dt><i>start</i></dt> | |
| 335 <dd> | |
| 336 indicator for the start of the search | |
| 337 (StartRoot, StartMenu, StartToolBar) | |
| 338 </dd> | |
| 339 </dl> | |
| 340 <dl> | |
| 341 <dt>Return:</dt> | |
| 342 <dd> | |
| 343 bookmark node for the given url (BookmarkNode) | |
| 344 </dd> | |
| 345 </dl> | |
| 346 <a NAME="BookmarksManager.bookmarks" ID="BookmarksManager.bookmarks"></a> | |
| 347 <h4>BookmarksManager.bookmarks</h4> | |
| 348 <b>bookmarks</b>(<i></i>) | |
| 349 | |
| 350 <p> | |
| 351 Public method to get a reference to the root bookmark node. | |
| 352 </p> | |
| 353 <dl> | |
| 354 <dt>Return:</dt> | |
| 355 <dd> | |
| 356 reference to the root bookmark node (BookmarkNode) | |
| 357 </dd> | |
| 358 </dl> | |
| 359 <a NAME="BookmarksManager.bookmarksForUrl" ID="BookmarksManager.bookmarksForUrl"></a> | |
| 360 <h4>BookmarksManager.bookmarksForUrl</h4> | |
| 361 <b>bookmarksForUrl</b>(<i>url, start=StartRoot</i>) | |
| 362 | |
| 363 <p> | |
| 364 Public method to get a list of bookmark nodes for a given URL. | |
| 365 </p> | |
| 366 <dl> | |
| 367 | |
| 368 <dt><i>url</i></dt> | |
| 369 <dd> | |
| 370 URL of the bookmarks to search for (QUrl or string) | |
| 371 </dd> | |
| 372 <dt><i>start</i></dt> | |
| 373 <dd> | |
| 374 indicator for the start of the search | |
| 375 (StartRoot, StartMenu, StartToolBar) | |
| 376 </dd> | |
| 377 </dl> | |
| 378 <dl> | |
| 379 <dt>Return:</dt> | |
| 380 <dd> | |
| 381 list of bookmark nodes for the given url (list of BookmarkNode) | |
| 382 </dd> | |
| 383 </dl> | |
| 384 <a NAME="BookmarksManager.bookmarksModel" ID="BookmarksManager.bookmarksModel"></a> | |
| 385 <h4>BookmarksManager.bookmarksModel</h4> | |
| 386 <b>bookmarksModel</b>(<i></i>) | |
| 387 | |
| 388 <p> | |
| 389 Public method to get a reference to the bookmarks model. | |
| 390 </p> | |
| 391 <dl> | |
| 392 <dt>Return:</dt> | |
| 393 <dd> | |
| 394 reference to the bookmarks model (BookmarksModel) | |
| 395 </dd> | |
| 396 </dl> | |
| 397 <a NAME="BookmarksManager.changeExpanded" ID="BookmarksManager.changeExpanded"></a> | |
| 398 <h4>BookmarksManager.changeExpanded</h4> | |
| 399 <b>changeExpanded</b>(<i></i>) | |
| 400 | |
| 401 <p> | |
| 402 Public method to handle a change of the expanded state. | |
| 403 </p> | |
| 404 <a NAME="BookmarksManager.close" ID="BookmarksManager.close"></a> | |
| 405 <h4>BookmarksManager.close</h4> | |
| 406 <b>close</b>(<i></i>) | |
| 407 | |
| 408 <p> | |
| 409 Public method to close the bookmark manager. | |
| 410 </p> | |
| 411 <a NAME="BookmarksManager.exportBookmarks" ID="BookmarksManager.exportBookmarks"></a> | |
| 412 <h4>BookmarksManager.exportBookmarks</h4> | |
| 413 <b>exportBookmarks</b>(<i></i>) | |
| 414 | |
| 415 <p> | |
| 416 Public method to export the bookmarks. | |
| 417 </p> | |
| 418 <a NAME="BookmarksManager.faviconChanged" ID="BookmarksManager.faviconChanged"></a> | |
| 419 <h4>BookmarksManager.faviconChanged</h4> | |
| 420 <b>faviconChanged</b>(<i>url</i>) | |
| 421 | |
| 422 <p> | |
| 423 Public slot to update the icon image for an URL. | |
| 424 </p> | |
| 425 <dl> | |
| 426 | |
| 427 <dt><i>url</i></dt> | |
| 428 <dd> | |
| 429 URL of the icon to update (QUrl or string) | |
| 430 </dd> | |
| 431 </dl> | |
| 432 <a NAME="BookmarksManager.importBookmarks" ID="BookmarksManager.importBookmarks"></a> | |
| 433 <h4>BookmarksManager.importBookmarks</h4> | |
| 434 <b>importBookmarks</b>(<i></i>) | |
| 435 | |
| 436 <p> | |
| 437 Public method to import bookmarks. | |
| 438 </p> | |
| 439 <a NAME="BookmarksManager.incVisitCount" ID="BookmarksManager.incVisitCount"></a> | |
| 440 <h4>BookmarksManager.incVisitCount</h4> | |
| 441 <b>incVisitCount</b>(<i>node</i>) | |
| 442 | |
| 443 <p> | |
| 444 Public method to increment the visit count of a bookmark. | |
| 445 </p> | |
| 446 <dl> | |
| 447 | |
| 448 <dt><i>node</i></dt> | |
| 449 <dd> | |
| 450 reference to the node to be changed (BookmarkNode) | |
| 451 </dd> | |
| 452 </dl> | |
| 453 <a NAME="BookmarksManager.load" ID="BookmarksManager.load"></a> | |
| 454 <h4>BookmarksManager.load</h4> | |
| 455 <b>load</b>(<i></i>) | |
| 456 | |
| 457 <p> | |
| 458 Public method to load the bookmarks. | |
| 459 </p> | |
| 460 <dl> | |
| 461 | |
| 462 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 463 <dd> | |
| 464 raised to indicate an error loading the | |
| 465 bookmarks | |
| 466 </dd> | |
| 467 </dl> | |
| 468 <a NAME="BookmarksManager.menu" ID="BookmarksManager.menu"></a> | |
| 469 <h4>BookmarksManager.menu</h4> | |
| 470 <b>menu</b>(<i></i>) | |
| 471 | |
| 472 <p> | |
| 473 Public method to get a reference to the bookmarks menu node. | |
| 474 </p> | |
| 475 <dl> | |
| 476 <dt>Return:</dt> | |
| 477 <dd> | |
| 478 reference to the bookmarks menu node (BookmarkNode) | |
| 479 </dd> | |
| 480 </dl> | |
| 481 <a NAME="BookmarksManager.reload" ID="BookmarksManager.reload"></a> | |
| 482 <h4>BookmarksManager.reload</h4> | |
| 483 <b>reload</b>(<i></i>) | |
| 484 | |
| 485 <p> | |
| 486 Public method used to initiate a reloading of the bookmarks. | |
| 487 </p> | |
| 488 <a NAME="BookmarksManager.removeBookmark" ID="BookmarksManager.removeBookmark"></a> | |
| 489 <h4>BookmarksManager.removeBookmark</h4> | |
| 490 <b>removeBookmark</b>(<i>node</i>) | |
| 491 | |
| 492 <p> | |
| 493 Public method to remove a bookmark. | |
| 494 </p> | |
| 495 <dl> | |
| 496 | |
| 497 <dt><i>node</i></dt> | |
| 498 <dd> | |
| 499 reference to the node to be removed (BookmarkNode) | |
| 500 </dd> | |
| 501 </dl> | |
| 502 <a NAME="BookmarksManager.save" ID="BookmarksManager.save"></a> | |
| 503 <h4>BookmarksManager.save</h4> | |
| 504 <b>save</b>(<i></i>) | |
| 505 | |
| 506 <p> | |
| 507 Public method to save the bookmarks. | |
| 508 </p> | |
| 509 <a NAME="BookmarksManager.setNodeChanged" ID="BookmarksManager.setNodeChanged"></a> | |
| 510 <h4>BookmarksManager.setNodeChanged</h4> | |
| 511 <b>setNodeChanged</b>(<i>node</i>) | |
| 512 | |
| 513 <p> | |
| 514 Public method to signal changes of bookmarks other than title, URL | |
| 515 or timestamp. | |
| 516 </p> | |
| 517 <dl> | |
| 518 | |
| 519 <dt><i>node</i></dt> | |
| 520 <dd> | |
| 521 reference to the bookmark (BookmarkNode) | |
| 522 </dd> | |
| 523 </dl> | |
| 524 <a NAME="BookmarksManager.setTimestamp" ID="BookmarksManager.setTimestamp"></a> | |
| 525 <h4>BookmarksManager.setTimestamp</h4> | |
| 526 <b>setTimestamp</b>(<i>node, timestampType, timestamp</i>) | |
| 527 | |
| 528 <p> | |
| 529 Public method to set the URL of a bookmark. | |
| 530 </p> | |
| 531 <dl> | |
| 532 | |
| 533 <dt><i>node</i></dt> | |
| 534 <dd> | |
| 535 reference to the node to be changed (BookmarkNode) | |
| 536 </dd> | |
| 537 <dt><i>timestampType</i></dt> | |
| 538 <dd> | |
| 539 type of the timestamp to set | |
| 540 (BookmarkNode.TsAdded, BookmarkNode.TsModified, | |
| 541 BookmarkNode.TsVisited) | |
| 542 </dd> | |
| 543 <dt><i>timestamp</i></dt> | |
| 544 <dd> | |
| 545 timestamp to set (QDateTime) | |
| 546 </dd> | |
| 547 </dl> | |
| 548 <a NAME="BookmarksManager.setTitle" ID="BookmarksManager.setTitle"></a> | |
| 549 <h4>BookmarksManager.setTitle</h4> | |
| 550 <b>setTitle</b>(<i>node, newTitle</i>) | |
| 551 | |
| 552 <p> | |
| 553 Public method to set the title of a bookmark. | |
| 554 </p> | |
| 555 <dl> | |
| 556 | |
| 557 <dt><i>node</i></dt> | |
| 558 <dd> | |
| 559 reference to the node to be changed (BookmarkNode) | |
| 560 </dd> | |
| 561 <dt><i>newTitle</i></dt> | |
| 562 <dd> | |
| 563 title to be set (string) | |
| 564 </dd> | |
| 565 </dl> | |
| 566 <a NAME="BookmarksManager.setUrl" ID="BookmarksManager.setUrl"></a> | |
| 567 <h4>BookmarksManager.setUrl</h4> | |
| 568 <b>setUrl</b>(<i>node, newUrl</i>) | |
| 569 | |
| 570 <p> | |
| 571 Public method to set the URL of a bookmark. | |
| 572 </p> | |
| 573 <dl> | |
| 574 | |
| 575 <dt><i>node</i></dt> | |
| 576 <dd> | |
| 577 reference to the node to be changed (BookmarkNode) | |
| 578 </dd> | |
| 579 <dt><i>newUrl</i></dt> | |
| 580 <dd> | |
| 581 URL to be set (string) | |
| 582 </dd> | |
| 583 </dl> | |
| 584 <a NAME="BookmarksManager.setVisitCount" ID="BookmarksManager.setVisitCount"></a> | |
| 585 <h4>BookmarksManager.setVisitCount</h4> | |
| 586 <b>setVisitCount</b>(<i>node, count</i>) | |
| 587 | |
| 588 <p> | |
| 589 Public method to set the visit count of a bookmark. | |
| 590 </p> | |
| 591 <dl> | |
| 592 | |
| 593 <dt><i>node</i></dt> | |
| 594 <dd> | |
| 595 reference to the node to be changed (BookmarkNode) | |
| 596 </dd> | |
| 597 <dt><i>count</i></dt> | |
| 598 <dd> | |
| 599 visit count to be set (int or str) | |
| 600 </dd> | |
| 601 </dl> | |
| 602 <a NAME="BookmarksManager.toolbar" ID="BookmarksManager.toolbar"></a> | |
| 603 <h4>BookmarksManager.toolbar</h4> | |
| 604 <b>toolbar</b>(<i></i>) | |
| 605 | |
| 606 <p> | |
| 607 Public method to get a reference to the bookmarks toolbar node. | |
| 608 </p> | |
| 609 <dl> | |
| 610 <dt>Return:</dt> | |
| 611 <dd> | |
| 612 reference to the bookmarks toolbar node (BookmarkNode) | |
| 613 </dd> | |
| 614 </dl> | |
| 615 <a NAME="BookmarksManager.undoRedoStack" ID="BookmarksManager.undoRedoStack"></a> | |
| 616 <h4>BookmarksManager.undoRedoStack</h4> | |
| 617 <b>undoRedoStack</b>(<i></i>) | |
| 618 | |
| 619 <p> | |
| 620 Public method to get a reference to the undo stack. | |
| 621 </p> | |
| 622 <dl> | |
| 623 <dt>Return:</dt> | |
| 624 <dd> | |
| 625 reference to the undo stack (QUndoStack) | |
| 626 </dd> | |
| 627 </dl> | |
| 628 <div align="right"><a href="#top">Up</a></div> | |
| 629 <hr /> | |
| 630 <hr /> | |
| 631 <a NAME="ChangeBookmarkCommand" ID="ChangeBookmarkCommand"></a> | |
| 632 <h2>ChangeBookmarkCommand</h2> | |
| 633 | |
| 634 <p> | |
| 635 Class implementing the Insert undo command. | |
| 636 </p> | |
| 637 <h3>Derived from</h3> | |
| 638 QUndoCommand | |
| 639 <h3>Class Attributes</h3> | |
| 640 | |
| 641 <table> | |
| 642 <tr><td>None</td></tr> | |
| 643 </table> | |
| 644 <h3>Class Methods</h3> | |
| 645 | |
| 646 <table> | |
| 647 <tr><td>None</td></tr> | |
| 648 </table> | |
| 649 <h3>Methods</h3> | |
| 650 | |
| 651 <table> | |
| 652 | |
| 653 <tr> | |
| 654 <td><a href="#ChangeBookmarkCommand.__init__">ChangeBookmarkCommand</a></td> | |
| 655 <td>Constructor</td> | |
| 656 </tr> | |
| 657 <tr> | |
| 658 <td><a href="#ChangeBookmarkCommand.redo">redo</a></td> | |
| 659 <td>Public slot to perform the redo action.</td> | |
| 660 </tr> | |
| 661 <tr> | |
| 662 <td><a href="#ChangeBookmarkCommand.undo">undo</a></td> | |
| 663 <td>Public slot to perform the undo action.</td> | |
| 664 </tr> | |
| 665 </table> | |
| 666 <h3>Static Methods</h3> | |
| 667 | |
| 668 <table> | |
| 669 <tr><td>None</td></tr> | |
| 670 </table> | |
| 671 | |
| 672 <a NAME="ChangeBookmarkCommand.__init__" ID="ChangeBookmarkCommand.__init__"></a> | |
| 673 <h4>ChangeBookmarkCommand (Constructor)</h4> | |
| 674 <b>ChangeBookmarkCommand</b>(<i>bookmarksManager, node, newValue, title</i>) | |
| 675 | |
| 676 <p> | |
| 677 Constructor | |
| 678 </p> | |
| 679 <dl> | |
| 680 | |
| 681 <dt><i>bookmarksManager</i></dt> | |
| 682 <dd> | |
| 683 reference to the bookmarks manager | |
| 684 (BookmarksManager) | |
| 685 </dd> | |
| 686 <dt><i>node</i></dt> | |
| 687 <dd> | |
| 688 reference to the node to be changed (BookmarkNode) | |
| 689 </dd> | |
| 690 <dt><i>newValue</i></dt> | |
| 691 <dd> | |
| 692 new value to be set (string) | |
| 693 </dd> | |
| 694 <dt><i>title</i></dt> | |
| 695 <dd> | |
| 696 flag indicating a change of the title (True) or | |
| 697 the URL (False) (boolean) | |
| 698 </dd> | |
| 699 </dl> | |
| 700 <a NAME="ChangeBookmarkCommand.redo" ID="ChangeBookmarkCommand.redo"></a> | |
| 701 <h4>ChangeBookmarkCommand.redo</h4> | |
| 702 <b>redo</b>(<i></i>) | |
| 703 | |
| 704 <p> | |
| 705 Public slot to perform the redo action. | |
| 706 </p> | |
| 707 <a NAME="ChangeBookmarkCommand.undo" ID="ChangeBookmarkCommand.undo"></a> | |
| 708 <h4>ChangeBookmarkCommand.undo</h4> | |
| 709 <b>undo</b>(<i></i>) | |
| 710 | |
| 711 <p> | |
| 712 Public slot to perform the undo action. | |
| 713 </p> | |
| 714 <div align="right"><a href="#top">Up</a></div> | |
| 715 <hr /> | |
| 716 <hr /> | |
| 717 <a NAME="InsertBookmarksCommand" ID="InsertBookmarksCommand"></a> | |
| 718 <h2>InsertBookmarksCommand</h2> | |
| 719 | |
| 720 <p> | |
| 721 Class implementing the Insert undo command. | |
| 722 </p> | |
| 723 <h3>Derived from</h3> | |
| 724 RemoveBookmarksCommand | |
| 725 <h3>Class Attributes</h3> | |
| 726 | |
| 727 <table> | |
| 728 <tr><td>None</td></tr> | |
| 729 </table> | |
| 730 <h3>Class Methods</h3> | |
| 731 | |
| 732 <table> | |
| 733 <tr><td>None</td></tr> | |
| 734 </table> | |
| 735 <h3>Methods</h3> | |
| 736 | |
| 737 <table> | |
| 738 | |
| 739 <tr> | |
| 740 <td><a href="#InsertBookmarksCommand.__init__">InsertBookmarksCommand</a></td> | |
| 741 <td>Constructor</td> | |
| 742 </tr> | |
| 743 <tr> | |
| 744 <td><a href="#InsertBookmarksCommand.redo">redo</a></td> | |
| 745 <td>Public slot to perform the redo action.</td> | |
| 746 </tr> | |
| 747 <tr> | |
| 748 <td><a href="#InsertBookmarksCommand.undo">undo</a></td> | |
| 749 <td>Public slot to perform the undo action.</td> | |
| 750 </tr> | |
| 751 </table> | |
| 752 <h3>Static Methods</h3> | |
| 753 | |
| 754 <table> | |
| 755 <tr><td>None</td></tr> | |
| 756 </table> | |
| 757 | |
| 758 <a NAME="InsertBookmarksCommand.__init__" ID="InsertBookmarksCommand.__init__"></a> | |
| 759 <h4>InsertBookmarksCommand (Constructor)</h4> | |
| 760 <b>InsertBookmarksCommand</b>(<i>bookmarksManager, parent, node, row</i>) | |
| 761 | |
| 762 <p> | |
| 763 Constructor | |
| 764 </p> | |
| 765 <dl> | |
| 766 | |
| 767 <dt><i>bookmarksManager</i></dt> | |
| 768 <dd> | |
| 769 reference to the bookmarks manager | |
| 770 (BookmarksManager) | |
| 771 </dd> | |
| 772 <dt><i>parent</i></dt> | |
| 773 <dd> | |
| 774 reference to the parent node (BookmarkNode) | |
| 775 </dd> | |
| 776 <dt><i>node</i></dt> | |
| 777 <dd> | |
| 778 reference to the node to be inserted (BookmarkNode) | |
| 779 </dd> | |
| 780 <dt><i>row</i></dt> | |
| 781 <dd> | |
| 782 row number of bookmark (integer) | |
| 783 </dd> | |
| 784 </dl> | |
| 785 <a NAME="InsertBookmarksCommand.redo" ID="InsertBookmarksCommand.redo"></a> | |
| 786 <h4>InsertBookmarksCommand.redo</h4> | |
| 787 <b>redo</b>(<i></i>) | |
| 788 | |
| 789 <p> | |
| 790 Public slot to perform the redo action. | |
| 791 </p> | |
| 792 <a NAME="InsertBookmarksCommand.undo" ID="InsertBookmarksCommand.undo"></a> | |
| 793 <h4>InsertBookmarksCommand.undo</h4> | |
| 794 <b>undo</b>(<i></i>) | |
| 795 | |
| 796 <p> | |
| 797 Public slot to perform the undo action. | |
| 798 </p> | |
| 799 <div align="right"><a href="#top">Up</a></div> | |
| 800 <hr /> | |
| 801 <hr /> | |
| 802 <a NAME="RemoveBookmarksCommand" ID="RemoveBookmarksCommand"></a> | |
| 803 <h2>RemoveBookmarksCommand</h2> | |
| 804 | |
| 805 <p> | |
| 806 Class implementing the Remove undo command. | |
| 807 </p> | |
| 808 <h3>Derived from</h3> | |
| 809 QUndoCommand | |
| 810 <h3>Class Attributes</h3> | |
| 811 | |
| 812 <table> | |
| 813 <tr><td>None</td></tr> | |
| 814 </table> | |
| 815 <h3>Class Methods</h3> | |
| 816 | |
| 817 <table> | |
| 818 <tr><td>None</td></tr> | |
| 819 </table> | |
| 820 <h3>Methods</h3> | |
| 821 | |
| 822 <table> | |
| 823 | |
| 824 <tr> | |
| 825 <td><a href="#RemoveBookmarksCommand.__init__">RemoveBookmarksCommand</a></td> | |
| 826 <td>Constructor</td> | |
| 827 </tr> | |
| 828 <tr> | |
| 829 <td><a href="#RemoveBookmarksCommand.redo">redo</a></td> | |
| 830 <td>Public slot to perform the redo action.</td> | |
| 831 </tr> | |
| 832 <tr> | |
| 833 <td><a href="#RemoveBookmarksCommand.undo">undo</a></td> | |
| 834 <td>Public slot to perform the undo action.</td> | |
| 835 </tr> | |
| 836 </table> | |
| 837 <h3>Static Methods</h3> | |
| 838 | |
| 839 <table> | |
| 840 <tr><td>None</td></tr> | |
| 841 </table> | |
| 842 | |
| 843 <a NAME="RemoveBookmarksCommand.__init__" ID="RemoveBookmarksCommand.__init__"></a> | |
| 844 <h4>RemoveBookmarksCommand (Constructor)</h4> | |
| 845 <b>RemoveBookmarksCommand</b>(<i>bookmarksManager, parent, row</i>) | |
| 846 | |
| 847 <p> | |
| 848 Constructor | |
| 849 </p> | |
| 850 <dl> | |
| 851 | |
| 852 <dt><i>bookmarksManager</i></dt> | |
| 853 <dd> | |
| 854 reference to the bookmarks manager | |
| 855 (BookmarksManager) | |
| 856 </dd> | |
| 857 <dt><i>parent</i></dt> | |
| 858 <dd> | |
| 859 reference to the parent node (BookmarkNode) | |
| 860 </dd> | |
| 861 <dt><i>row</i></dt> | |
| 862 <dd> | |
| 863 row number of bookmark (integer) | |
| 864 </dd> | |
| 865 </dl> | |
| 866 <a NAME="RemoveBookmarksCommand.redo" ID="RemoveBookmarksCommand.redo"></a> | |
| 867 <h4>RemoveBookmarksCommand.redo</h4> | |
| 868 <b>redo</b>(<i></i>) | |
| 869 | |
| 870 <p> | |
| 871 Public slot to perform the redo action. | |
| 872 </p> | |
| 873 <a NAME="RemoveBookmarksCommand.undo" ID="RemoveBookmarksCommand.undo"></a> | |
| 874 <h4>RemoveBookmarksCommand.undo</h4> | |
| 875 <b>undo</b>(<i></i>) | |
| 876 | |
| 877 <p> | |
| 878 Public slot to perform the undo action. | |
| 879 </p> | |
| 880 <div align="right"><a href="#top">Up</a></div> | |
| 881 <hr /> | |
| 882 </body></html> |
