Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksManager.html
Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksManager.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.Helpviewer.Bookmarks.BookmarksManager</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.Helpviewer.Bookmarks.BookmarksManager</h1> | |
| 12 <p> | |
| 13 Module implementing the bookmarks manager. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>BOOKMARKBAR</td></tr><tr><td>BOOKMARKMENU</td></tr><tr><td>extract_js</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#BookmarksManager">BookmarksManager</a></td> | |
| 23 <td>Class implementing the bookmarks manager.</td> | |
| 24 </tr><tr> | |
| 25 <td><a href="#ChangeBookmarkCommand">ChangeBookmarkCommand</a></td> | |
| 26 <td>Class implementing the Insert undo command.</td> | |
| 27 </tr><tr> | |
| 28 <td><a href="#InsertBookmarksCommand">InsertBookmarksCommand</a></td> | |
| 29 <td>Class implementing the Insert undo command.</td> | |
| 30 </tr><tr> | |
| 31 <td><a href="#RemoveBookmarksCommand">RemoveBookmarksCommand</a></td> | |
| 32 <td>Class implementing the Remove undo command.</td> | |
| 33 </tr> | |
| 34 </table> | |
| 35 <h3>Functions</h3> | |
| 36 <table> | |
| 37 <tr><td>None</td></tr> | |
| 38 </table> | |
| 39 <hr /><hr /> | |
| 40 <a NAME="BookmarksManager" ID="BookmarksManager"></a> | |
| 41 <h2>BookmarksManager</h2> | |
| 42 <p> | |
| 43 Class implementing the bookmarks manager. | |
| 44 </p><h4>Signals</h4> | |
| 45 <dl> | |
| 46 <dt>entryAdded</dt> | |
| 47 <dd> | |
| 48 emitted after a bookmark node has been added | |
| 49 </dd><dt>entryChanged</dt> | |
| 50 <dd> | |
| 51 emitted after a bookmark node has been changed | |
| 52 </dd><dt>entryRemoved</dt> | |
| 53 <dd> | |
| 54 emitted after a bookmark | |
| 55 node has been removed | |
| 56 </dd> | |
| 57 </dl> | |
| 58 <h3>Derived from</h3> | |
| 59 QObject | |
| 60 <h3>Class Attributes</h3> | |
| 61 <table> | |
| 62 <tr><td>None</td></tr> | |
| 63 </table> | |
| 64 <h3>Methods</h3> | |
| 65 <table> | |
| 66 <tr> | |
| 67 <td><a href="#BookmarksManager.__init__">BookmarksManager</a></td> | |
| 68 <td>Constructor</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#BookmarksManager.__convertFromOldBookmarks">__convertFromOldBookmarks</a></td> | |
| 71 <td>Private method to convert the old bookmarks into the new ones.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#BookmarksManager.addBookmark">addBookmark</a></td> | |
| 74 <td>Public method to add a bookmark.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#BookmarksManager.bookmarks">bookmarks</a></td> | |
| 77 <td>Public method to get a reference to the root bookmark node.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#BookmarksManager.bookmarksModel">bookmarksModel</a></td> | |
| 80 <td>Public method to get a reference to the bookmarks model.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#BookmarksManager.changeExpanded">changeExpanded</a></td> | |
| 83 <td>Public method to handle a change of the expanded state.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#BookmarksManager.close">close</a></td> | |
| 86 <td>Public method to close the bookmark manager.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#BookmarksManager.exportBookmarks">exportBookmarks</a></td> | |
| 89 <td>Public method to export the bookmarks.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#BookmarksManager.importBookmarks">importBookmarks</a></td> | |
| 92 <td>Public method to import bookmarks.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#BookmarksManager.load">load</a></td> | |
| 95 <td>Public method to load the bookmarks.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#BookmarksManager.menu">menu</a></td> | |
| 98 <td>Public method to get a reference to the bookmarks menu node.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#BookmarksManager.removeBookmark">removeBookmark</a></td> | |
| 101 <td>Public method to remove a bookmark.</td> | |
| 102 </tr><tr> | |
| 103 <td><a href="#BookmarksManager.save">save</a></td> | |
| 104 <td>Public method to save the bookmarks.</td> | |
| 105 </tr><tr> | |
| 106 <td><a href="#BookmarksManager.setTitle">setTitle</a></td> | |
| 107 <td>Public method to set the title of a bookmark.</td> | |
| 108 </tr><tr> | |
| 109 <td><a href="#BookmarksManager.setUrl">setUrl</a></td> | |
| 110 <td>Public method to set the URL of a bookmark.</td> | |
| 111 </tr><tr> | |
| 112 <td><a href="#BookmarksManager.toolbar">toolbar</a></td> | |
| 113 <td>Public method to get a reference to the bookmarks toolbar node.</td> | |
| 114 </tr><tr> | |
| 115 <td><a href="#BookmarksManager.undoRedoStack">undoRedoStack</a></td> | |
| 116 <td>Public method to get a reference to the undo stack.</td> | |
| 117 </tr> | |
| 118 </table> | |
| 119 <a NAME="BookmarksManager.__init__" ID="BookmarksManager.__init__"></a> | |
| 120 <h4>BookmarksManager (Constructor)</h4> | |
| 121 <b>BookmarksManager</b>(<i>parent = None</i>) | |
| 122 <p> | |
| 123 Constructor | |
| 124 </p><dl> | |
| 125 <dt><i>parent</i></dt> | |
| 126 <dd> | |
| 127 reference to the parent object (QObject) | |
| 128 </dd> | |
| 129 </dl><a NAME="BookmarksManager.__convertFromOldBookmarks" ID="BookmarksManager.__convertFromOldBookmarks"></a> | |
| 130 <h4>BookmarksManager.__convertFromOldBookmarks</h4> | |
| 131 <b>__convertFromOldBookmarks</b>(<i></i>) | |
| 132 <p> | |
| 133 Private method to convert the old bookmarks into the new ones. | |
| 134 </p><a NAME="BookmarksManager.addBookmark" ID="BookmarksManager.addBookmark"></a> | |
| 135 <h4>BookmarksManager.addBookmark</h4> | |
| 136 <b>addBookmark</b>(<i>parent, node, row = -1</i>) | |
| 137 <p> | |
| 138 Public method to add a bookmark. | |
| 139 </p><dl> | |
| 140 <dt><i>parent</i></dt> | |
| 141 <dd> | |
| 142 reference to the node to add to (BookmarkNode) | |
| 143 </dd><dt><i>node</i></dt> | |
| 144 <dd> | |
| 145 reference to the node to add (BookmarkNode) | |
| 146 </dd><dt><i>row</i></dt> | |
| 147 <dd> | |
| 148 row number (integer) | |
| 149 </dd> | |
| 150 </dl><a NAME="BookmarksManager.bookmarks" ID="BookmarksManager.bookmarks"></a> | |
| 151 <h4>BookmarksManager.bookmarks</h4> | |
| 152 <b>bookmarks</b>(<i></i>) | |
| 153 <p> | |
| 154 Public method to get a reference to the root bookmark node. | |
| 155 </p><dl> | |
| 156 <dt>Returns:</dt> | |
| 157 <dd> | |
| 158 reference to the root bookmark node (BookmarkNode) | |
| 159 </dd> | |
| 160 </dl><a NAME="BookmarksManager.bookmarksModel" ID="BookmarksManager.bookmarksModel"></a> | |
| 161 <h4>BookmarksManager.bookmarksModel</h4> | |
| 162 <b>bookmarksModel</b>(<i></i>) | |
| 163 <p> | |
| 164 Public method to get a reference to the bookmarks model. | |
| 165 </p><dl> | |
| 166 <dt>Returns:</dt> | |
| 167 <dd> | |
| 168 reference to the bookmarks model (BookmarksModel) | |
| 169 </dd> | |
| 170 </dl><a NAME="BookmarksManager.changeExpanded" ID="BookmarksManager.changeExpanded"></a> | |
| 171 <h4>BookmarksManager.changeExpanded</h4> | |
| 172 <b>changeExpanded</b>(<i></i>) | |
| 173 <p> | |
| 174 Public method to handle a change of the expanded state. | |
| 175 </p><a NAME="BookmarksManager.close" ID="BookmarksManager.close"></a> | |
| 176 <h4>BookmarksManager.close</h4> | |
| 177 <b>close</b>(<i></i>) | |
| 178 <p> | |
| 179 Public method to close the bookmark manager. | |
| 180 </p><a NAME="BookmarksManager.exportBookmarks" ID="BookmarksManager.exportBookmarks"></a> | |
| 181 <h4>BookmarksManager.exportBookmarks</h4> | |
| 182 <b>exportBookmarks</b>(<i></i>) | |
| 183 <p> | |
| 184 Public method to export the bookmarks. | |
| 185 </p><a NAME="BookmarksManager.importBookmarks" ID="BookmarksManager.importBookmarks"></a> | |
| 186 <h4>BookmarksManager.importBookmarks</h4> | |
| 187 <b>importBookmarks</b>(<i></i>) | |
| 188 <p> | |
| 189 Public method to import bookmarks. | |
| 190 </p><a NAME="BookmarksManager.load" ID="BookmarksManager.load"></a> | |
| 191 <h4>BookmarksManager.load</h4> | |
| 192 <b>load</b>(<i></i>) | |
| 193 <p> | |
| 194 Public method to load the bookmarks. | |
| 195 </p><a NAME="BookmarksManager.menu" ID="BookmarksManager.menu"></a> | |
| 196 <h4>BookmarksManager.menu</h4> | |
| 197 <b>menu</b>(<i></i>) | |
| 198 <p> | |
| 199 Public method to get a reference to the bookmarks menu node. | |
| 200 </p><dl> | |
| 201 <dt>Returns:</dt> | |
| 202 <dd> | |
| 203 reference to the bookmarks menu node (BookmarkNode) | |
| 204 </dd> | |
| 205 </dl><a NAME="BookmarksManager.removeBookmark" ID="BookmarksManager.removeBookmark"></a> | |
| 206 <h4>BookmarksManager.removeBookmark</h4> | |
| 207 <b>removeBookmark</b>(<i>node</i>) | |
| 208 <p> | |
| 209 Public method to remove a bookmark. | |
| 210 </p><dl> | |
| 211 <dt><i>node</i></dt> | |
| 212 <dd> | |
| 213 reference to the node to be removed (BookmarkNode) | |
| 214 </dd> | |
| 215 </dl><a NAME="BookmarksManager.save" ID="BookmarksManager.save"></a> | |
| 216 <h4>BookmarksManager.save</h4> | |
| 217 <b>save</b>(<i></i>) | |
| 218 <p> | |
| 219 Public method to save the bookmarks. | |
| 220 </p><a NAME="BookmarksManager.setTitle" ID="BookmarksManager.setTitle"></a> | |
| 221 <h4>BookmarksManager.setTitle</h4> | |
| 222 <b>setTitle</b>(<i>node, newTitle</i>) | |
| 223 <p> | |
| 224 Public method to set the title of a bookmark. | |
| 225 </p><dl> | |
| 226 <dt><i>node</i></dt> | |
| 227 <dd> | |
| 228 reference to the node to be changed (BookmarkNode) | |
| 229 </dd><dt><i>newTitle</i></dt> | |
| 230 <dd> | |
| 231 title to be set (string) | |
| 232 </dd> | |
| 233 </dl><a NAME="BookmarksManager.setUrl" ID="BookmarksManager.setUrl"></a> | |
| 234 <h4>BookmarksManager.setUrl</h4> | |
| 235 <b>setUrl</b>(<i>node, newUrl</i>) | |
| 236 <p> | |
| 237 Public method to set the URL of a bookmark. | |
| 238 </p><dl> | |
| 239 <dt><i>node</i></dt> | |
| 240 <dd> | |
| 241 reference to the node to be changed (BookmarkNode) | |
| 242 </dd><dt><i>newUrl</i></dt> | |
| 243 <dd> | |
| 244 URL to be set (string) | |
| 245 </dd> | |
| 246 </dl><a NAME="BookmarksManager.toolbar" ID="BookmarksManager.toolbar"></a> | |
| 247 <h4>BookmarksManager.toolbar</h4> | |
| 248 <b>toolbar</b>(<i></i>) | |
| 249 <p> | |
| 250 Public method to get a reference to the bookmarks toolbar node. | |
| 251 </p><dl> | |
| 252 <dt>Returns:</dt> | |
| 253 <dd> | |
| 254 reference to the bookmarks toolbar node (BookmarkNode) | |
| 255 </dd> | |
| 256 </dl><a NAME="BookmarksManager.undoRedoStack" ID="BookmarksManager.undoRedoStack"></a> | |
| 257 <h4>BookmarksManager.undoRedoStack</h4> | |
| 258 <b>undoRedoStack</b>(<i></i>) | |
| 259 <p> | |
| 260 Public method to get a reference to the undo stack. | |
| 261 </p><dl> | |
| 262 <dt>Returns:</dt> | |
| 263 <dd> | |
| 264 reference to the undo stack (QUndoStack) | |
| 265 </dd> | |
| 266 </dl> | |
| 267 <div align="right"><a href="#top">Up</a></div> | |
| 268 <hr /><hr /> | |
| 269 <a NAME="ChangeBookmarkCommand" ID="ChangeBookmarkCommand"></a> | |
| 270 <h2>ChangeBookmarkCommand</h2> | |
| 271 <p> | |
| 272 Class implementing the Insert undo command. | |
| 273 </p> | |
| 274 <h3>Derived from</h3> | |
| 275 QUndoCommand | |
| 276 <h3>Class Attributes</h3> | |
| 277 <table> | |
| 278 <tr><td>None</td></tr> | |
| 279 </table> | |
| 280 <h3>Methods</h3> | |
| 281 <table> | |
| 282 <tr> | |
| 283 <td><a href="#ChangeBookmarkCommand.__init__">ChangeBookmarkCommand</a></td> | |
| 284 <td>Constructor</td> | |
| 285 </tr><tr> | |
| 286 <td><a href="#ChangeBookmarkCommand.redo">redo</a></td> | |
| 287 <td>Public slot to perform the redo action.</td> | |
| 288 </tr><tr> | |
| 289 <td><a href="#ChangeBookmarkCommand.undo">undo</a></td> | |
| 290 <td>Public slot to perform the undo action.</td> | |
| 291 </tr> | |
| 292 </table> | |
| 293 <a NAME="ChangeBookmarkCommand.__init__" ID="ChangeBookmarkCommand.__init__"></a> | |
| 294 <h4>ChangeBookmarkCommand (Constructor)</h4> | |
| 295 <b>ChangeBookmarkCommand</b>(<i>bookmarksManager, node, newValue, title</i>) | |
| 296 <p> | |
| 297 Constructor | |
| 298 </p><dl> | |
| 299 <dt><i>bookmarksManager</i></dt> | |
| 300 <dd> | |
| 301 reference to the bookmarks manager (BookmarksManager) | |
| 302 </dd><dt><i>node</i></dt> | |
| 303 <dd> | |
| 304 reference to the node to be changed (BookmarkNode) | |
| 305 </dd><dt><i>newValue</i></dt> | |
| 306 <dd> | |
| 307 new value to be set (string) | |
| 308 </dd><dt><i>title</i></dt> | |
| 309 <dd> | |
| 310 flag indicating a change of the title (True) or | |
| 311 the URL (False) (boolean) | |
| 312 </dd> | |
| 313 </dl><a NAME="ChangeBookmarkCommand.redo" ID="ChangeBookmarkCommand.redo"></a> | |
| 314 <h4>ChangeBookmarkCommand.redo</h4> | |
| 315 <b>redo</b>(<i></i>) | |
| 316 <p> | |
| 317 Public slot to perform the redo action. | |
| 318 </p><a NAME="ChangeBookmarkCommand.undo" ID="ChangeBookmarkCommand.undo"></a> | |
| 319 <h4>ChangeBookmarkCommand.undo</h4> | |
| 320 <b>undo</b>(<i></i>) | |
| 321 <p> | |
| 322 Public slot to perform the undo action. | |
| 323 </p> | |
| 324 <div align="right"><a href="#top">Up</a></div> | |
| 325 <hr /><hr /> | |
| 326 <a NAME="InsertBookmarksCommand" ID="InsertBookmarksCommand"></a> | |
| 327 <h2>InsertBookmarksCommand</h2> | |
| 328 <p> | |
| 329 Class implementing the Insert undo command. | |
| 330 </p> | |
| 331 <h3>Derived from</h3> | |
| 332 RemoveBookmarksCommand | |
| 333 <h3>Class Attributes</h3> | |
| 334 <table> | |
| 335 <tr><td>None</td></tr> | |
| 336 </table> | |
| 337 <h3>Methods</h3> | |
| 338 <table> | |
| 339 <tr> | |
| 340 <td><a href="#InsertBookmarksCommand.__init__">InsertBookmarksCommand</a></td> | |
| 341 <td>Constructor</td> | |
| 342 </tr><tr> | |
| 343 <td><a href="#InsertBookmarksCommand.redo">redo</a></td> | |
| 344 <td>Public slot to perform the redo action.</td> | |
| 345 </tr><tr> | |
| 346 <td><a href="#InsertBookmarksCommand.undo">undo</a></td> | |
| 347 <td>Public slot to perform the undo action.</td> | |
| 348 </tr> | |
| 349 </table> | |
| 350 <a NAME="InsertBookmarksCommand.__init__" ID="InsertBookmarksCommand.__init__"></a> | |
| 351 <h4>InsertBookmarksCommand (Constructor)</h4> | |
| 352 <b>InsertBookmarksCommand</b>(<i>bookmarksManager, parent, node, row</i>) | |
| 353 <p> | |
| 354 Constructor | |
| 355 </p><dl> | |
| 356 <dt><i>bookmarksManager</i></dt> | |
| 357 <dd> | |
| 358 reference to the bookmarks manager (BookmarksManager) | |
| 359 </dd><dt><i>parent</i></dt> | |
| 360 <dd> | |
| 361 reference to the parent node (BookmarkNode) | |
| 362 </dd><dt><i>node</i></dt> | |
| 363 <dd> | |
| 364 reference to the node to be inserted (BookmarkNode) | |
| 365 </dd><dt><i>row</i></dt> | |
| 366 <dd> | |
| 367 row number of bookmark (integer) | |
| 368 </dd> | |
| 369 </dl><a NAME="InsertBookmarksCommand.redo" ID="InsertBookmarksCommand.redo"></a> | |
| 370 <h4>InsertBookmarksCommand.redo</h4> | |
| 371 <b>redo</b>(<i></i>) | |
| 372 <p> | |
| 373 Public slot to perform the redo action. | |
| 374 </p><a NAME="InsertBookmarksCommand.undo" ID="InsertBookmarksCommand.undo"></a> | |
| 375 <h4>InsertBookmarksCommand.undo</h4> | |
| 376 <b>undo</b>(<i></i>) | |
| 377 <p> | |
| 378 Public slot to perform the undo action. | |
| 379 </p> | |
| 380 <div align="right"><a href="#top">Up</a></div> | |
| 381 <hr /><hr /> | |
| 382 <a NAME="RemoveBookmarksCommand" ID="RemoveBookmarksCommand"></a> | |
| 383 <h2>RemoveBookmarksCommand</h2> | |
| 384 <p> | |
| 385 Class implementing the Remove undo command. | |
| 386 </p> | |
| 387 <h3>Derived from</h3> | |
| 388 QUndoCommand | |
| 389 <h3>Class Attributes</h3> | |
| 390 <table> | |
| 391 <tr><td>None</td></tr> | |
| 392 </table> | |
| 393 <h3>Methods</h3> | |
| 394 <table> | |
| 395 <tr> | |
| 396 <td><a href="#RemoveBookmarksCommand.__init__">RemoveBookmarksCommand</a></td> | |
| 397 <td>Constructor</td> | |
| 398 </tr><tr> | |
| 399 <td><a href="#RemoveBookmarksCommand.redo">redo</a></td> | |
| 400 <td>Public slot to perform the redo action.</td> | |
| 401 </tr><tr> | |
| 402 <td><a href="#RemoveBookmarksCommand.undo">undo</a></td> | |
| 403 <td>Public slot to perform the undo action.</td> | |
| 404 </tr> | |
| 405 </table> | |
| 406 <a NAME="RemoveBookmarksCommand.__init__" ID="RemoveBookmarksCommand.__init__"></a> | |
| 407 <h4>RemoveBookmarksCommand (Constructor)</h4> | |
| 408 <b>RemoveBookmarksCommand</b>(<i>bookmarksManager, parent, row</i>) | |
| 409 <p> | |
| 410 Constructor | |
| 411 </p><dl> | |
| 412 <dt><i>bookmarksManager</i></dt> | |
| 413 <dd> | |
| 414 reference to the bookmarks manager (BookmarksManager) | |
| 415 </dd><dt><i>parent</i></dt> | |
| 416 <dd> | |
| 417 reference to the parent node (BookmarkNode) | |
| 418 </dd><dt><i>row</i></dt> | |
| 419 <dd> | |
| 420 row number of bookmark (integer) | |
| 421 </dd> | |
| 422 </dl><a NAME="RemoveBookmarksCommand.redo" ID="RemoveBookmarksCommand.redo"></a> | |
| 423 <h4>RemoveBookmarksCommand.redo</h4> | |
| 424 <b>redo</b>(<i></i>) | |
| 425 <p> | |
| 426 Public slot to perform the redo action. | |
| 427 </p><a NAME="RemoveBookmarksCommand.undo" ID="RemoveBookmarksCommand.undo"></a> | |
| 428 <h4>RemoveBookmarksCommand.undo</h4> | |
| 429 <b>undo</b>(<i></i>) | |
| 430 <p> | |
| 431 Public slot to perform the undo action. | |
| 432 </p> | |
| 433 <div align="right"><a href="#top">Up</a></div> | |
| 434 <hr /> | |
| 435 </body></html> |
