eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarksManager.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7226
babe80d84a3e
parent 7285
1ff497f33f31
child 7287
1c17f2191bdd
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.Bookmarks.BookmarksManager</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Helpviewer.Bookmarks.BookmarksManager</h1>
23 <p>
24 Module implementing the bookmarks manager.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <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>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#BookmarksManager">BookmarksManager</a></td>
34 <td>Class implementing the bookmarks manager.</td>
35 </tr><tr>
36 <td><a href="#ChangeBookmarkCommand">ChangeBookmarkCommand</a></td>
37 <td>Class implementing the Insert undo command.</td>
38 </tr><tr>
39 <td><a href="#InsertBookmarksCommand">InsertBookmarksCommand</a></td>
40 <td>Class implementing the Insert undo command.</td>
41 </tr><tr>
42 <td><a href="#RemoveBookmarksCommand">RemoveBookmarksCommand</a></td>
43 <td>Class implementing the Remove undo command.</td>
44 </tr>
45 </table>
46 <h3>Functions</h3>
47 <table>
48 <tr><td>None</td></tr>
49 </table>
50 <hr /><hr />
51 <a NAME="BookmarksManager" ID="BookmarksManager"></a>
52 <h2>BookmarksManager</h2>
53 <p>
54 Class implementing the bookmarks manager.
55 </p><h3>Signals</h3>
56 <dl>
57 <dt>bookmarksReloaded()</dt>
58 <dd>
59 emitted after the bookmarks were reloaded
60 </dd><dt>bookmarksSaved()</dt>
61 <dd>
62 emitted after the bookmarks were saved
63 </dd><dt>entryAdded(BookmarkNode)</dt>
64 <dd>
65 emitted after a bookmark node has been
66 added
67 </dd><dt>entryChanged(BookmarkNode)</dt>
68 <dd>
69 emitted after a bookmark node has been
70 changed
71 </dd><dt>entryRemoved(BookmarkNode, int, BookmarkNode)</dt>
72 <dd>
73 emitted after a
74 bookmark node has been removed
75 </dd>
76 </dl>
77 <h3>Derived from</h3>
78 QObject
79 <h3>Class Attributes</h3>
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83 <h3>Class Methods</h3>
84 <table>
85 <tr>
86 <td><a href="#BookmarksManager.getFileName">getFileName</a></td>
87 <td>Class method to get the file name of the bookmark file.</td>
88 </tr>
89 </table>
90 <h3>Methods</h3>
91 <table>
92 <tr>
93 <td><a href="#BookmarksManager.__init__">BookmarksManager</a></td>
94 <td>Constructor</td>
95 </tr><tr>
96 <td><a href="#BookmarksManager.__convertFromOldBookmarks">__convertFromOldBookmarks</a></td>
97 <td>Private method to convert the old bookmarks into the new ones.</td>
98 </tr><tr>
99 <td><a href="#BookmarksManager.__initialize">__initialize</a></td>
100 <td>Private method to initialize some data.</td>
101 </tr><tr>
102 <td><a href="#BookmarksManager.__searchBookmark">__searchBookmark</a></td>
103 <td>Private method get a bookmark node for a given URL.</td>
104 </tr><tr>
105 <td><a href="#BookmarksManager.__searchBookmarks">__searchBookmarks</a></td>
106 <td>Private method get a list of bookmark nodes for a given URL.</td>
107 </tr><tr>
108 <td><a href="#BookmarksManager.addBookmark">addBookmark</a></td>
109 <td>Public method to add a bookmark.</td>
110 </tr><tr>
111 <td><a href="#BookmarksManager.bookmarkForUrl">bookmarkForUrl</a></td>
112 <td>Public method to get a bookmark node for a given URL.</td>
113 </tr><tr>
114 <td><a href="#BookmarksManager.bookmarks">bookmarks</a></td>
115 <td>Public method to get a reference to the root bookmark node.</td>
116 </tr><tr>
117 <td><a href="#BookmarksManager.bookmarksForUrl">bookmarksForUrl</a></td>
118 <td>Public method to get a list of bookmark nodes for a given URL.</td>
119 </tr><tr>
120 <td><a href="#BookmarksManager.bookmarksModel">bookmarksModel</a></td>
121 <td>Public method to get a reference to the bookmarks model.</td>
122 </tr><tr>
123 <td><a href="#BookmarksManager.changeExpanded">changeExpanded</a></td>
124 <td>Public method to handle a change of the expanded state.</td>
125 </tr><tr>
126 <td><a href="#BookmarksManager.close">close</a></td>
127 <td>Public method to close the bookmark manager.</td>
128 </tr><tr>
129 <td><a href="#BookmarksManager.exportBookmarks">exportBookmarks</a></td>
130 <td>Public method to export the bookmarks.</td>
131 </tr><tr>
132 <td><a href="#BookmarksManager.iconChanged">iconChanged</a></td>
133 <td>Public slot to update the icon image for an URL.</td>
134 </tr><tr>
135 <td><a href="#BookmarksManager.importBookmarks">importBookmarks</a></td>
136 <td>Public method to import bookmarks.</td>
137 </tr><tr>
138 <td><a href="#BookmarksManager.load">load</a></td>
139 <td>Public method to load the bookmarks.</td>
140 </tr><tr>
141 <td><a href="#BookmarksManager.menu">menu</a></td>
142 <td>Public method to get a reference to the bookmarks menu node.</td>
143 </tr><tr>
144 <td><a href="#BookmarksManager.reload">reload</a></td>
145 <td>Public method used to initiate a reloading of the bookmarks.</td>
146 </tr><tr>
147 <td><a href="#BookmarksManager.removeBookmark">removeBookmark</a></td>
148 <td>Public method to remove a bookmark.</td>
149 </tr><tr>
150 <td><a href="#BookmarksManager.save">save</a></td>
151 <td>Public method to save the bookmarks.</td>
152 </tr><tr>
153 <td><a href="#BookmarksManager.setNodeChanged">setNodeChanged</a></td>
154 <td>Public method to signal changes of bookmarks other than title, URL or timestamp.</td>
155 </tr><tr>
156 <td><a href="#BookmarksManager.setTimestamp">setTimestamp</a></td>
157 <td>Public method to set the URL of a bookmark.</td>
158 </tr><tr>
159 <td><a href="#BookmarksManager.setTitle">setTitle</a></td>
160 <td>Public method to set the title of a bookmark.</td>
161 </tr><tr>
162 <td><a href="#BookmarksManager.setUrl">setUrl</a></td>
163 <td>Public method to set the URL of a bookmark.</td>
164 </tr><tr>
165 <td><a href="#BookmarksManager.toolbar">toolbar</a></td>
166 <td>Public method to get a reference to the bookmarks toolbar node.</td>
167 </tr><tr>
168 <td><a href="#BookmarksManager.undoRedoStack">undoRedoStack</a></td>
169 <td>Public method to get a reference to the undo stack.</td>
170 </tr>
171 </table>
172 <h3>Static Methods</h3>
173 <table>
174 <tr><td>None</td></tr>
175 </table>
176 <a NAME="BookmarksManager.getFileName" ID="BookmarksManager.getFileName"></a>
177 <h4>BookmarksManager.getFileName (class method)</h4>
178 <b>getFileName</b>(<i></i>)
179 <p>
180 Class method to get the file name of the bookmark file.
181 </p><dl>
182 <dt>Returns:</dt>
183 <dd>
184 name of the bookmark file (string)
185 </dd>
186 </dl><a NAME="BookmarksManager.__init__" ID="BookmarksManager.__init__"></a>
187 <h4>BookmarksManager (Constructor)</h4>
188 <b>BookmarksManager</b>(<i>parent=None</i>)
189 <p>
190 Constructor
191 </p><dl>
192 <dt><i>parent</i></dt>
193 <dd>
194 reference to the parent object (QObject)
195 </dd>
196 </dl><a NAME="BookmarksManager.__convertFromOldBookmarks" ID="BookmarksManager.__convertFromOldBookmarks"></a>
197 <h4>BookmarksManager.__convertFromOldBookmarks</h4>
198 <b>__convertFromOldBookmarks</b>(<i></i>)
199 <p>
200 Private method to convert the old bookmarks into the new ones.
201 </p><a NAME="BookmarksManager.__initialize" ID="BookmarksManager.__initialize"></a>
202 <h4>BookmarksManager.__initialize</h4>
203 <b>__initialize</b>(<i></i>)
204 <p>
205 Private method to initialize some data.
206 </p><a NAME="BookmarksManager.__searchBookmark" ID="BookmarksManager.__searchBookmark"></a>
207 <h4>BookmarksManager.__searchBookmark</h4>
208 <b>__searchBookmark</b>(<i>url, startNode</i>)
209 <p>
210 Private method get a bookmark node for a given URL.
211 </p><dl>
212 <dt><i>url</i></dt>
213 <dd>
214 URL of the bookmark to search for (string)
215 </dd><dt><i>startNode</i></dt>
216 <dd>
217 reference to the node to start searching
218 (BookmarkNode)
219 </dd>
220 </dl><dl>
221 <dt>Returns:</dt>
222 <dd>
223 bookmark node for the given url (BookmarkNode)
224 </dd>
225 </dl><a NAME="BookmarksManager.__searchBookmarks" ID="BookmarksManager.__searchBookmarks"></a>
226 <h4>BookmarksManager.__searchBookmarks</h4>
227 <b>__searchBookmarks</b>(<i>url, startNode</i>)
228 <p>
229 Private method get a list of bookmark nodes for a given URL.
230 </p><dl>
231 <dt><i>url</i></dt>
232 <dd>
233 URL of the bookmarks to search for (string)
234 </dd><dt><i>startNode</i></dt>
235 <dd>
236 reference to the node to start searching
237 (BookmarkNode)
238 </dd>
239 </dl><dl>
240 <dt>Returns:</dt>
241 <dd>
242 list of bookmark nodes for the given url (list of BookmarkNode)
243 </dd>
244 </dl><a NAME="BookmarksManager.addBookmark" ID="BookmarksManager.addBookmark"></a>
245 <h4>BookmarksManager.addBookmark</h4>
246 <b>addBookmark</b>(<i>parent, node, row=-1</i>)
247 <p>
248 Public method to add a bookmark.
249 </p><dl>
250 <dt><i>parent</i></dt>
251 <dd>
252 reference to the node to add to (BookmarkNode)
253 </dd><dt><i>node</i></dt>
254 <dd>
255 reference to the node to add (BookmarkNode)
256 </dd><dt><i>row</i></dt>
257 <dd>
258 row number (integer)
259 </dd>
260 </dl><a NAME="BookmarksManager.bookmarkForUrl" ID="BookmarksManager.bookmarkForUrl"></a>
261 <h4>BookmarksManager.bookmarkForUrl</h4>
262 <b>bookmarkForUrl</b>(<i>url, start=StartRoot</i>)
263 <p>
264 Public method to get a bookmark node for a given URL.
265 </p><dl>
266 <dt><i>url</i></dt>
267 <dd>
268 URL of the bookmark to search for (QUrl or string)
269 </dd><dt><i>start=</i></dt>
270 <dd>
271 indicator for the start of the search
272 (StartRoot, StartMenu, StartToolBar)
273 </dd>
274 </dl><dl>
275 <dt>Returns:</dt>
276 <dd>
277 bookmark node for the given url (BookmarkNode)
278 </dd>
279 </dl><a NAME="BookmarksManager.bookmarks" ID="BookmarksManager.bookmarks"></a>
280 <h4>BookmarksManager.bookmarks</h4>
281 <b>bookmarks</b>(<i></i>)
282 <p>
283 Public method to get a reference to the root bookmark node.
284 </p><dl>
285 <dt>Returns:</dt>
286 <dd>
287 reference to the root bookmark node (BookmarkNode)
288 </dd>
289 </dl><a NAME="BookmarksManager.bookmarksForUrl" ID="BookmarksManager.bookmarksForUrl"></a>
290 <h4>BookmarksManager.bookmarksForUrl</h4>
291 <b>bookmarksForUrl</b>(<i>url, start=StartRoot</i>)
292 <p>
293 Public method to get a list of bookmark nodes for a given URL.
294 </p><dl>
295 <dt><i>url</i></dt>
296 <dd>
297 URL of the bookmarks to search for (QUrl or string)
298 </dd><dt><i>start=</i></dt>
299 <dd>
300 indicator for the start of the search
301 (StartRoot, StartMenu, StartToolBar)
302 </dd>
303 </dl><dl>
304 <dt>Returns:</dt>
305 <dd>
306 list of bookmark nodes for the given url (list of BookmarkNode)
307 </dd>
308 </dl><a NAME="BookmarksManager.bookmarksModel" ID="BookmarksManager.bookmarksModel"></a>
309 <h4>BookmarksManager.bookmarksModel</h4>
310 <b>bookmarksModel</b>(<i></i>)
311 <p>
312 Public method to get a reference to the bookmarks model.
313 </p><dl>
314 <dt>Returns:</dt>
315 <dd>
316 reference to the bookmarks model (BookmarksModel)
317 </dd>
318 </dl><a NAME="BookmarksManager.changeExpanded" ID="BookmarksManager.changeExpanded"></a>
319 <h4>BookmarksManager.changeExpanded</h4>
320 <b>changeExpanded</b>(<i></i>)
321 <p>
322 Public method to handle a change of the expanded state.
323 </p><a NAME="BookmarksManager.close" ID="BookmarksManager.close"></a>
324 <h4>BookmarksManager.close</h4>
325 <b>close</b>(<i></i>)
326 <p>
327 Public method to close the bookmark manager.
328 </p><a NAME="BookmarksManager.exportBookmarks" ID="BookmarksManager.exportBookmarks"></a>
329 <h4>BookmarksManager.exportBookmarks</h4>
330 <b>exportBookmarks</b>(<i></i>)
331 <p>
332 Public method to export the bookmarks.
333 </p><a NAME="BookmarksManager.iconChanged" ID="BookmarksManager.iconChanged"></a>
334 <h4>BookmarksManager.iconChanged</h4>
335 <b>iconChanged</b>(<i>url</i>)
336 <p>
337 Public slot to update the icon image for an URL.
338 </p><dl>
339 <dt><i>url</i></dt>
340 <dd>
341 URL of the icon to update (QUrl or string)
342 </dd>
343 </dl><a NAME="BookmarksManager.importBookmarks" ID="BookmarksManager.importBookmarks"></a>
344 <h4>BookmarksManager.importBookmarks</h4>
345 <b>importBookmarks</b>(<i></i>)
346 <p>
347 Public method to import bookmarks.
348 </p><a NAME="BookmarksManager.load" ID="BookmarksManager.load"></a>
349 <h4>BookmarksManager.load</h4>
350 <b>load</b>(<i></i>)
351 <p>
352 Public method to load the bookmarks.
353 </p><dl>
354 <dt>Raises <b>RuntimeError</b>:</dt>
355 <dd>
356 raised to indicate an error loading the
357 bookmarks
358 </dd>
359 </dl><a NAME="BookmarksManager.menu" ID="BookmarksManager.menu"></a>
360 <h4>BookmarksManager.menu</h4>
361 <b>menu</b>(<i></i>)
362 <p>
363 Public method to get a reference to the bookmarks menu node.
364 </p><dl>
365 <dt>Returns:</dt>
366 <dd>
367 reference to the bookmarks menu node (BookmarkNode)
368 </dd>
369 </dl><a NAME="BookmarksManager.reload" ID="BookmarksManager.reload"></a>
370 <h4>BookmarksManager.reload</h4>
371 <b>reload</b>(<i></i>)
372 <p>
373 Public method used to initiate a reloading of the bookmarks.
374 </p><a NAME="BookmarksManager.removeBookmark" ID="BookmarksManager.removeBookmark"></a>
375 <h4>BookmarksManager.removeBookmark</h4>
376 <b>removeBookmark</b>(<i>node</i>)
377 <p>
378 Public method to remove a bookmark.
379 </p><dl>
380 <dt><i>node</i></dt>
381 <dd>
382 reference to the node to be removed (BookmarkNode)
383 </dd>
384 </dl><a NAME="BookmarksManager.save" ID="BookmarksManager.save"></a>
385 <h4>BookmarksManager.save</h4>
386 <b>save</b>(<i></i>)
387 <p>
388 Public method to save the bookmarks.
389 </p><a NAME="BookmarksManager.setNodeChanged" ID="BookmarksManager.setNodeChanged"></a>
390 <h4>BookmarksManager.setNodeChanged</h4>
391 <b>setNodeChanged</b>(<i>node</i>)
392 <p>
393 Public method to signal changes of bookmarks other than title, URL
394 or timestamp.
395 </p><dl>
396 <dt><i>node</i></dt>
397 <dd>
398 reference to the bookmark (BookmarkNode)
399 </dd>
400 </dl><a NAME="BookmarksManager.setTimestamp" ID="BookmarksManager.setTimestamp"></a>
401 <h4>BookmarksManager.setTimestamp</h4>
402 <b>setTimestamp</b>(<i>node, timestampType, timestamp</i>)
403 <p>
404 Public method to set the URL of a bookmark.
405 </p><dl>
406 <dt><i>node</i></dt>
407 <dd>
408 reference to the node to be changed (BookmarkNode)
409 </dd><dt><i>timestampType</i></dt>
410 <dd>
411 type of the timestamp to set
412 (BookmarkNode.TsAdded, BookmarkNode.TsModified,
413 BookmarkNode.TsVisited)
414 </dd><dt><i>timestamp</i></dt>
415 <dd>
416 timestamp to set (QDateTime)
417 </dd>
418 </dl><a NAME="BookmarksManager.setTitle" ID="BookmarksManager.setTitle"></a>
419 <h4>BookmarksManager.setTitle</h4>
420 <b>setTitle</b>(<i>node, newTitle</i>)
421 <p>
422 Public method to set the title of a bookmark.
423 </p><dl>
424 <dt><i>node</i></dt>
425 <dd>
426 reference to the node to be changed (BookmarkNode)
427 </dd><dt><i>newTitle</i></dt>
428 <dd>
429 title to be set (string)
430 </dd>
431 </dl><a NAME="BookmarksManager.setUrl" ID="BookmarksManager.setUrl"></a>
432 <h4>BookmarksManager.setUrl</h4>
433 <b>setUrl</b>(<i>node, newUrl</i>)
434 <p>
435 Public method to set the URL of a bookmark.
436 </p><dl>
437 <dt><i>node</i></dt>
438 <dd>
439 reference to the node to be changed (BookmarkNode)
440 </dd><dt><i>newUrl</i></dt>
441 <dd>
442 URL to be set (string)
443 </dd>
444 </dl><a NAME="BookmarksManager.toolbar" ID="BookmarksManager.toolbar"></a>
445 <h4>BookmarksManager.toolbar</h4>
446 <b>toolbar</b>(<i></i>)
447 <p>
448 Public method to get a reference to the bookmarks toolbar node.
449 </p><dl>
450 <dt>Returns:</dt>
451 <dd>
452 reference to the bookmarks toolbar node (BookmarkNode)
453 </dd>
454 </dl><a NAME="BookmarksManager.undoRedoStack" ID="BookmarksManager.undoRedoStack"></a>
455 <h4>BookmarksManager.undoRedoStack</h4>
456 <b>undoRedoStack</b>(<i></i>)
457 <p>
458 Public method to get a reference to the undo stack.
459 </p><dl>
460 <dt>Returns:</dt>
461 <dd>
462 reference to the undo stack (QUndoStack)
463 </dd>
464 </dl>
465 <div align="right"><a href="#top">Up</a></div>
466 <hr /><hr />
467 <a NAME="ChangeBookmarkCommand" ID="ChangeBookmarkCommand"></a>
468 <h2>ChangeBookmarkCommand</h2>
469 <p>
470 Class implementing the Insert undo command.
471 </p>
472 <h3>Derived from</h3>
473 QUndoCommand
474 <h3>Class Attributes</h3>
475 <table>
476 <tr><td>None</td></tr>
477 </table>
478 <h3>Class Methods</h3>
479 <table>
480 <tr><td>None</td></tr>
481 </table>
482 <h3>Methods</h3>
483 <table>
484 <tr>
485 <td><a href="#ChangeBookmarkCommand.__init__">ChangeBookmarkCommand</a></td>
486 <td>Constructor</td>
487 </tr><tr>
488 <td><a href="#ChangeBookmarkCommand.redo">redo</a></td>
489 <td>Public slot to perform the redo action.</td>
490 </tr><tr>
491 <td><a href="#ChangeBookmarkCommand.undo">undo</a></td>
492 <td>Public slot to perform the undo action.</td>
493 </tr>
494 </table>
495 <h3>Static Methods</h3>
496 <table>
497 <tr><td>None</td></tr>
498 </table>
499 <a NAME="ChangeBookmarkCommand.__init__" ID="ChangeBookmarkCommand.__init__"></a>
500 <h4>ChangeBookmarkCommand (Constructor)</h4>
501 <b>ChangeBookmarkCommand</b>(<i>bookmarksManager, node, newValue, title</i>)
502 <p>
503 Constructor
504 </p><dl>
505 <dt><i>bookmarksManager</i></dt>
506 <dd>
507 reference to the bookmarks manager
508 (BookmarksManager)
509 </dd><dt><i>node</i></dt>
510 <dd>
511 reference to the node to be changed (BookmarkNode)
512 </dd><dt><i>newValue</i></dt>
513 <dd>
514 new value to be set (string)
515 </dd><dt><i>title</i></dt>
516 <dd>
517 flag indicating a change of the title (True) or
518 the URL (False) (boolean)
519 </dd>
520 </dl><a NAME="ChangeBookmarkCommand.redo" ID="ChangeBookmarkCommand.redo"></a>
521 <h4>ChangeBookmarkCommand.redo</h4>
522 <b>redo</b>(<i></i>)
523 <p>
524 Public slot to perform the redo action.
525 </p><a NAME="ChangeBookmarkCommand.undo" ID="ChangeBookmarkCommand.undo"></a>
526 <h4>ChangeBookmarkCommand.undo</h4>
527 <b>undo</b>(<i></i>)
528 <p>
529 Public slot to perform the undo action.
530 </p>
531 <div align="right"><a href="#top">Up</a></div>
532 <hr /><hr />
533 <a NAME="InsertBookmarksCommand" ID="InsertBookmarksCommand"></a>
534 <h2>InsertBookmarksCommand</h2>
535 <p>
536 Class implementing the Insert undo command.
537 </p>
538 <h3>Derived from</h3>
539 RemoveBookmarksCommand
540 <h3>Class Attributes</h3>
541 <table>
542 <tr><td>None</td></tr>
543 </table>
544 <h3>Class Methods</h3>
545 <table>
546 <tr><td>None</td></tr>
547 </table>
548 <h3>Methods</h3>
549 <table>
550 <tr>
551 <td><a href="#InsertBookmarksCommand.__init__">InsertBookmarksCommand</a></td>
552 <td>Constructor</td>
553 </tr><tr>
554 <td><a href="#InsertBookmarksCommand.redo">redo</a></td>
555 <td>Public slot to perform the redo action.</td>
556 </tr><tr>
557 <td><a href="#InsertBookmarksCommand.undo">undo</a></td>
558 <td>Public slot to perform the undo action.</td>
559 </tr>
560 </table>
561 <h3>Static Methods</h3>
562 <table>
563 <tr><td>None</td></tr>
564 </table>
565 <a NAME="InsertBookmarksCommand.__init__" ID="InsertBookmarksCommand.__init__"></a>
566 <h4>InsertBookmarksCommand (Constructor)</h4>
567 <b>InsertBookmarksCommand</b>(<i>bookmarksManager, parent, node, row</i>)
568 <p>
569 Constructor
570 </p><dl>
571 <dt><i>bookmarksManager</i></dt>
572 <dd>
573 reference to the bookmarks manager
574 (BookmarksManager)
575 </dd><dt><i>parent</i></dt>
576 <dd>
577 reference to the parent node (BookmarkNode)
578 </dd><dt><i>node</i></dt>
579 <dd>
580 reference to the node to be inserted (BookmarkNode)
581 </dd><dt><i>row</i></dt>
582 <dd>
583 row number of bookmark (integer)
584 </dd>
585 </dl><a NAME="InsertBookmarksCommand.redo" ID="InsertBookmarksCommand.redo"></a>
586 <h4>InsertBookmarksCommand.redo</h4>
587 <b>redo</b>(<i></i>)
588 <p>
589 Public slot to perform the redo action.
590 </p><a NAME="InsertBookmarksCommand.undo" ID="InsertBookmarksCommand.undo"></a>
591 <h4>InsertBookmarksCommand.undo</h4>
592 <b>undo</b>(<i></i>)
593 <p>
594 Public slot to perform the undo action.
595 </p>
596 <div align="right"><a href="#top">Up</a></div>
597 <hr /><hr />
598 <a NAME="RemoveBookmarksCommand" ID="RemoveBookmarksCommand"></a>
599 <h2>RemoveBookmarksCommand</h2>
600 <p>
601 Class implementing the Remove undo command.
602 </p>
603 <h3>Derived from</h3>
604 QUndoCommand
605 <h3>Class Attributes</h3>
606 <table>
607 <tr><td>None</td></tr>
608 </table>
609 <h3>Class Methods</h3>
610 <table>
611 <tr><td>None</td></tr>
612 </table>
613 <h3>Methods</h3>
614 <table>
615 <tr>
616 <td><a href="#RemoveBookmarksCommand.__init__">RemoveBookmarksCommand</a></td>
617 <td>Constructor</td>
618 </tr><tr>
619 <td><a href="#RemoveBookmarksCommand.redo">redo</a></td>
620 <td>Public slot to perform the redo action.</td>
621 </tr><tr>
622 <td><a href="#RemoveBookmarksCommand.undo">undo</a></td>
623 <td>Public slot to perform the undo action.</td>
624 </tr>
625 </table>
626 <h3>Static Methods</h3>
627 <table>
628 <tr><td>None</td></tr>
629 </table>
630 <a NAME="RemoveBookmarksCommand.__init__" ID="RemoveBookmarksCommand.__init__"></a>
631 <h4>RemoveBookmarksCommand (Constructor)</h4>
632 <b>RemoveBookmarksCommand</b>(<i>bookmarksManager, parent, row</i>)
633 <p>
634 Constructor
635 </p><dl>
636 <dt><i>bookmarksManager</i></dt>
637 <dd>
638 reference to the bookmarks manager
639 (BookmarksManager)
640 </dd><dt><i>parent</i></dt>
641 <dd>
642 reference to the parent node (BookmarkNode)
643 </dd><dt><i>row</i></dt>
644 <dd>
645 row number of bookmark (integer)
646 </dd>
647 </dl><a NAME="RemoveBookmarksCommand.redo" ID="RemoveBookmarksCommand.redo"></a>
648 <h4>RemoveBookmarksCommand.redo</h4>
649 <b>redo</b>(<i></i>)
650 <p>
651 Public slot to perform the redo action.
652 </p><a NAME="RemoveBookmarksCommand.undo" ID="RemoveBookmarksCommand.undo"></a>
653 <h4>RemoveBookmarksCommand.undo</h4>
654 <b>undo</b>(<i></i>)
655 <p>
656 Public slot to perform the undo action.
657 </p>
658 <div align="right"><a href="#top">Up</a></div>
659 <hr />
660 </body></html>

eric ide

mercurial