|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.WebBrowser.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.WebBrowser.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.__initialize">__initialize</a></td> |
|
97 <td>Private method to initialize some data.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#BookmarksManager.__searchBookmark">__searchBookmark</a></td> |
|
100 <td>Private method get a bookmark node for a given URL.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#BookmarksManager.__searchBookmarks">__searchBookmarks</a></td> |
|
103 <td>Private method get a list of bookmark nodes for a given URL.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#BookmarksManager.addBookmark">addBookmark</a></td> |
|
106 <td>Public method to add a bookmark.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#BookmarksManager.bookmarkForUrl">bookmarkForUrl</a></td> |
|
109 <td>Public method to get a bookmark node for a given URL.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#BookmarksManager.bookmarks">bookmarks</a></td> |
|
112 <td>Public method to get a reference to the root bookmark node.</td> |
|
113 </tr><tr> |
|
114 <td><a href="#BookmarksManager.bookmarksForUrl">bookmarksForUrl</a></td> |
|
115 <td>Public method to get a list of bookmark nodes for a given URL.</td> |
|
116 </tr><tr> |
|
117 <td><a href="#BookmarksManager.bookmarksModel">bookmarksModel</a></td> |
|
118 <td>Public method to get a reference to the bookmarks model.</td> |
|
119 </tr><tr> |
|
120 <td><a href="#BookmarksManager.changeExpanded">changeExpanded</a></td> |
|
121 <td>Public method to handle a change of the expanded state.</td> |
|
122 </tr><tr> |
|
123 <td><a href="#BookmarksManager.close">close</a></td> |
|
124 <td>Public method to close the bookmark manager.</td> |
|
125 </tr><tr> |
|
126 <td><a href="#BookmarksManager.exportBookmarks">exportBookmarks</a></td> |
|
127 <td>Public method to export the bookmarks.</td> |
|
128 </tr><tr> |
|
129 <td><a href="#BookmarksManager.faviconChanged">faviconChanged</a></td> |
|
130 <td>Public slot to update the icon image for an URL.</td> |
|
131 </tr><tr> |
|
132 <td><a href="#BookmarksManager.importBookmarks">importBookmarks</a></td> |
|
133 <td>Public method to import bookmarks.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#BookmarksManager.incVisitCount">incVisitCount</a></td> |
|
136 <td>Public method to increment the visit count of a bookmark.</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.setVisitCount">setVisitCount</a></td> |
|
166 <td>Public method to set the visit count of a bookmark.</td> |
|
167 </tr><tr> |
|
168 <td><a href="#BookmarksManager.toolbar">toolbar</a></td> |
|
169 <td>Public method to get a reference to the bookmarks toolbar node.</td> |
|
170 </tr><tr> |
|
171 <td><a href="#BookmarksManager.undoRedoStack">undoRedoStack</a></td> |
|
172 <td>Public method to get a reference to the undo stack.</td> |
|
173 </tr> |
|
174 </table> |
|
175 <h3>Static Methods</h3> |
|
176 <table> |
|
177 <tr><td>None</td></tr> |
|
178 </table> |
|
179 <a NAME="BookmarksManager.getFileName" ID="BookmarksManager.getFileName"></a> |
|
180 <h4>BookmarksManager.getFileName (class method)</h4> |
|
181 <b>getFileName</b>(<i></i>) |
|
182 <p> |
|
183 Class method to get the file name of the bookmark file. |
|
184 </p><dl> |
|
185 <dt>Returns:</dt> |
|
186 <dd> |
|
187 name of the bookmark file (string) |
|
188 </dd> |
|
189 </dl><a NAME="BookmarksManager.__init__" ID="BookmarksManager.__init__"></a> |
|
190 <h4>BookmarksManager (Constructor)</h4> |
|
191 <b>BookmarksManager</b>(<i>parent=None</i>) |
|
192 <p> |
|
193 Constructor |
|
194 </p><dl> |
|
195 <dt><i>parent</i></dt> |
|
196 <dd> |
|
197 reference to the parent object (QObject) |
|
198 </dd> |
|
199 </dl><a NAME="BookmarksManager.__initialize" ID="BookmarksManager.__initialize"></a> |
|
200 <h4>BookmarksManager.__initialize</h4> |
|
201 <b>__initialize</b>(<i></i>) |
|
202 <p> |
|
203 Private method to initialize some data. |
|
204 </p><a NAME="BookmarksManager.__searchBookmark" ID="BookmarksManager.__searchBookmark"></a> |
|
205 <h4>BookmarksManager.__searchBookmark</h4> |
|
206 <b>__searchBookmark</b>(<i>url, startNode</i>) |
|
207 <p> |
|
208 Private method get a bookmark node for a given URL. |
|
209 </p><dl> |
|
210 <dt><i>url</i></dt> |
|
211 <dd> |
|
212 URL of the bookmark to search for (string) |
|
213 </dd><dt><i>startNode</i></dt> |
|
214 <dd> |
|
215 reference to the node to start searching |
|
216 (BookmarkNode) |
|
217 </dd> |
|
218 </dl><dl> |
|
219 <dt>Returns:</dt> |
|
220 <dd> |
|
221 bookmark node for the given url (BookmarkNode) |
|
222 </dd> |
|
223 </dl><a NAME="BookmarksManager.__searchBookmarks" ID="BookmarksManager.__searchBookmarks"></a> |
|
224 <h4>BookmarksManager.__searchBookmarks</h4> |
|
225 <b>__searchBookmarks</b>(<i>url, startNode</i>) |
|
226 <p> |
|
227 Private method get a list of bookmark nodes for a given URL. |
|
228 </p><dl> |
|
229 <dt><i>url</i></dt> |
|
230 <dd> |
|
231 URL of the bookmarks to search for (string) |
|
232 </dd><dt><i>startNode</i></dt> |
|
233 <dd> |
|
234 reference to the node to start searching |
|
235 (BookmarkNode) |
|
236 </dd> |
|
237 </dl><dl> |
|
238 <dt>Returns:</dt> |
|
239 <dd> |
|
240 list of bookmark nodes for the given url (list of BookmarkNode) |
|
241 </dd> |
|
242 </dl><a NAME="BookmarksManager.addBookmark" ID="BookmarksManager.addBookmark"></a> |
|
243 <h4>BookmarksManager.addBookmark</h4> |
|
244 <b>addBookmark</b>(<i>parent, node, row=-1</i>) |
|
245 <p> |
|
246 Public method to add a bookmark. |
|
247 </p><dl> |
|
248 <dt><i>parent</i></dt> |
|
249 <dd> |
|
250 reference to the node to add to (BookmarkNode) |
|
251 </dd><dt><i>node</i></dt> |
|
252 <dd> |
|
253 reference to the node to add (BookmarkNode) |
|
254 </dd><dt><i>row</i></dt> |
|
255 <dd> |
|
256 row number (integer) |
|
257 </dd> |
|
258 </dl><a NAME="BookmarksManager.bookmarkForUrl" ID="BookmarksManager.bookmarkForUrl"></a> |
|
259 <h4>BookmarksManager.bookmarkForUrl</h4> |
|
260 <b>bookmarkForUrl</b>(<i>url, start=StartRoot</i>) |
|
261 <p> |
|
262 Public method to get a bookmark node for a given URL. |
|
263 </p><dl> |
|
264 <dt><i>url</i></dt> |
|
265 <dd> |
|
266 URL of the bookmark to search for (QUrl or string) |
|
267 </dd><dt><i>start=</i></dt> |
|
268 <dd> |
|
269 indicator for the start of the search |
|
270 (StartRoot, StartMenu, StartToolBar) |
|
271 </dd> |
|
272 </dl><dl> |
|
273 <dt>Returns:</dt> |
|
274 <dd> |
|
275 bookmark node for the given url (BookmarkNode) |
|
276 </dd> |
|
277 </dl><a NAME="BookmarksManager.bookmarks" ID="BookmarksManager.bookmarks"></a> |
|
278 <h4>BookmarksManager.bookmarks</h4> |
|
279 <b>bookmarks</b>(<i></i>) |
|
280 <p> |
|
281 Public method to get a reference to the root bookmark node. |
|
282 </p><dl> |
|
283 <dt>Returns:</dt> |
|
284 <dd> |
|
285 reference to the root bookmark node (BookmarkNode) |
|
286 </dd> |
|
287 </dl><a NAME="BookmarksManager.bookmarksForUrl" ID="BookmarksManager.bookmarksForUrl"></a> |
|
288 <h4>BookmarksManager.bookmarksForUrl</h4> |
|
289 <b>bookmarksForUrl</b>(<i>url, start=StartRoot</i>) |
|
290 <p> |
|
291 Public method to get a list of bookmark nodes for a given URL. |
|
292 </p><dl> |
|
293 <dt><i>url</i></dt> |
|
294 <dd> |
|
295 URL of the bookmarks to search for (QUrl or string) |
|
296 </dd><dt><i>start=</i></dt> |
|
297 <dd> |
|
298 indicator for the start of the search |
|
299 (StartRoot, StartMenu, StartToolBar) |
|
300 </dd> |
|
301 </dl><dl> |
|
302 <dt>Returns:</dt> |
|
303 <dd> |
|
304 list of bookmark nodes for the given url (list of BookmarkNode) |
|
305 </dd> |
|
306 </dl><a NAME="BookmarksManager.bookmarksModel" ID="BookmarksManager.bookmarksModel"></a> |
|
307 <h4>BookmarksManager.bookmarksModel</h4> |
|
308 <b>bookmarksModel</b>(<i></i>) |
|
309 <p> |
|
310 Public method to get a reference to the bookmarks model. |
|
311 </p><dl> |
|
312 <dt>Returns:</dt> |
|
313 <dd> |
|
314 reference to the bookmarks model (BookmarksModel) |
|
315 </dd> |
|
316 </dl><a NAME="BookmarksManager.changeExpanded" ID="BookmarksManager.changeExpanded"></a> |
|
317 <h4>BookmarksManager.changeExpanded</h4> |
|
318 <b>changeExpanded</b>(<i></i>) |
|
319 <p> |
|
320 Public method to handle a change of the expanded state. |
|
321 </p><a NAME="BookmarksManager.close" ID="BookmarksManager.close"></a> |
|
322 <h4>BookmarksManager.close</h4> |
|
323 <b>close</b>(<i></i>) |
|
324 <p> |
|
325 Public method to close the bookmark manager. |
|
326 </p><a NAME="BookmarksManager.exportBookmarks" ID="BookmarksManager.exportBookmarks"></a> |
|
327 <h4>BookmarksManager.exportBookmarks</h4> |
|
328 <b>exportBookmarks</b>(<i></i>) |
|
329 <p> |
|
330 Public method to export the bookmarks. |
|
331 </p><a NAME="BookmarksManager.faviconChanged" ID="BookmarksManager.faviconChanged"></a> |
|
332 <h4>BookmarksManager.faviconChanged</h4> |
|
333 <b>faviconChanged</b>(<i>url</i>) |
|
334 <p> |
|
335 Public slot to update the icon image for an URL. |
|
336 </p><dl> |
|
337 <dt><i>url</i></dt> |
|
338 <dd> |
|
339 URL of the icon to update (QUrl or string) |
|
340 </dd> |
|
341 </dl><a NAME="BookmarksManager.importBookmarks" ID="BookmarksManager.importBookmarks"></a> |
|
342 <h4>BookmarksManager.importBookmarks</h4> |
|
343 <b>importBookmarks</b>(<i></i>) |
|
344 <p> |
|
345 Public method to import bookmarks. |
|
346 </p><a NAME="BookmarksManager.incVisitCount" ID="BookmarksManager.incVisitCount"></a> |
|
347 <h4>BookmarksManager.incVisitCount</h4> |
|
348 <b>incVisitCount</b>(<i>node</i>) |
|
349 <p> |
|
350 Public method to increment the visit count of a bookmark. |
|
351 </p><dl> |
|
352 <dt><i>node</i></dt> |
|
353 <dd> |
|
354 reference to the node to be changed (BookmarkNode) |
|
355 </dd> |
|
356 </dl><a NAME="BookmarksManager.load" ID="BookmarksManager.load"></a> |
|
357 <h4>BookmarksManager.load</h4> |
|
358 <b>load</b>(<i></i>) |
|
359 <p> |
|
360 Public method to load the bookmarks. |
|
361 </p><dl> |
|
362 <dt>Raises <b>RuntimeError</b>:</dt> |
|
363 <dd> |
|
364 raised to indicate an error loading the |
|
365 bookmarks |
|
366 </dd> |
|
367 </dl><a NAME="BookmarksManager.menu" ID="BookmarksManager.menu"></a> |
|
368 <h4>BookmarksManager.menu</h4> |
|
369 <b>menu</b>(<i></i>) |
|
370 <p> |
|
371 Public method to get a reference to the bookmarks menu node. |
|
372 </p><dl> |
|
373 <dt>Returns:</dt> |
|
374 <dd> |
|
375 reference to the bookmarks menu node (BookmarkNode) |
|
376 </dd> |
|
377 </dl><a NAME="BookmarksManager.reload" ID="BookmarksManager.reload"></a> |
|
378 <h4>BookmarksManager.reload</h4> |
|
379 <b>reload</b>(<i></i>) |
|
380 <p> |
|
381 Public method used to initiate a reloading of the bookmarks. |
|
382 </p><a NAME="BookmarksManager.removeBookmark" ID="BookmarksManager.removeBookmark"></a> |
|
383 <h4>BookmarksManager.removeBookmark</h4> |
|
384 <b>removeBookmark</b>(<i>node</i>) |
|
385 <p> |
|
386 Public method to remove a bookmark. |
|
387 </p><dl> |
|
388 <dt><i>node</i></dt> |
|
389 <dd> |
|
390 reference to the node to be removed (BookmarkNode) |
|
391 </dd> |
|
392 </dl><a NAME="BookmarksManager.save" ID="BookmarksManager.save"></a> |
|
393 <h4>BookmarksManager.save</h4> |
|
394 <b>save</b>(<i></i>) |
|
395 <p> |
|
396 Public method to save the bookmarks. |
|
397 </p><a NAME="BookmarksManager.setNodeChanged" ID="BookmarksManager.setNodeChanged"></a> |
|
398 <h4>BookmarksManager.setNodeChanged</h4> |
|
399 <b>setNodeChanged</b>(<i>node</i>) |
|
400 <p> |
|
401 Public method to signal changes of bookmarks other than title, URL |
|
402 or timestamp. |
|
403 </p><dl> |
|
404 <dt><i>node</i></dt> |
|
405 <dd> |
|
406 reference to the bookmark (BookmarkNode) |
|
407 </dd> |
|
408 </dl><a NAME="BookmarksManager.setTimestamp" ID="BookmarksManager.setTimestamp"></a> |
|
409 <h4>BookmarksManager.setTimestamp</h4> |
|
410 <b>setTimestamp</b>(<i>node, timestampType, timestamp</i>) |
|
411 <p> |
|
412 Public method to set the URL of a bookmark. |
|
413 </p><dl> |
|
414 <dt><i>node</i></dt> |
|
415 <dd> |
|
416 reference to the node to be changed (BookmarkNode) |
|
417 </dd><dt><i>timestampType</i></dt> |
|
418 <dd> |
|
419 type of the timestamp to set |
|
420 (BookmarkNode.TsAdded, BookmarkNode.TsModified, |
|
421 BookmarkNode.TsVisited) |
|
422 </dd><dt><i>timestamp</i></dt> |
|
423 <dd> |
|
424 timestamp to set (QDateTime) |
|
425 </dd> |
|
426 </dl><a NAME="BookmarksManager.setTitle" ID="BookmarksManager.setTitle"></a> |
|
427 <h4>BookmarksManager.setTitle</h4> |
|
428 <b>setTitle</b>(<i>node, newTitle</i>) |
|
429 <p> |
|
430 Public method to set the title of a bookmark. |
|
431 </p><dl> |
|
432 <dt><i>node</i></dt> |
|
433 <dd> |
|
434 reference to the node to be changed (BookmarkNode) |
|
435 </dd><dt><i>newTitle</i></dt> |
|
436 <dd> |
|
437 title to be set (string) |
|
438 </dd> |
|
439 </dl><a NAME="BookmarksManager.setUrl" ID="BookmarksManager.setUrl"></a> |
|
440 <h4>BookmarksManager.setUrl</h4> |
|
441 <b>setUrl</b>(<i>node, newUrl</i>) |
|
442 <p> |
|
443 Public method to set the URL of a bookmark. |
|
444 </p><dl> |
|
445 <dt><i>node</i></dt> |
|
446 <dd> |
|
447 reference to the node to be changed (BookmarkNode) |
|
448 </dd><dt><i>newUrl</i></dt> |
|
449 <dd> |
|
450 URL to be set (string) |
|
451 </dd> |
|
452 </dl><a NAME="BookmarksManager.setVisitCount" ID="BookmarksManager.setVisitCount"></a> |
|
453 <h4>BookmarksManager.setVisitCount</h4> |
|
454 <b>setVisitCount</b>(<i>node, count</i>) |
|
455 <p> |
|
456 Public method to set the visit count of a bookmark. |
|
457 </p><dl> |
|
458 <dt><i>node</i></dt> |
|
459 <dd> |
|
460 reference to the node to be changed (BookmarkNode) |
|
461 </dd><dt><i>count</i></dt> |
|
462 <dd> |
|
463 visit count to be set (int or str) |
|
464 </dd> |
|
465 </dl><a NAME="BookmarksManager.toolbar" ID="BookmarksManager.toolbar"></a> |
|
466 <h4>BookmarksManager.toolbar</h4> |
|
467 <b>toolbar</b>(<i></i>) |
|
468 <p> |
|
469 Public method to get a reference to the bookmarks toolbar node. |
|
470 </p><dl> |
|
471 <dt>Returns:</dt> |
|
472 <dd> |
|
473 reference to the bookmarks toolbar node (BookmarkNode) |
|
474 </dd> |
|
475 </dl><a NAME="BookmarksManager.undoRedoStack" ID="BookmarksManager.undoRedoStack"></a> |
|
476 <h4>BookmarksManager.undoRedoStack</h4> |
|
477 <b>undoRedoStack</b>(<i></i>) |
|
478 <p> |
|
479 Public method to get a reference to the undo stack. |
|
480 </p><dl> |
|
481 <dt>Returns:</dt> |
|
482 <dd> |
|
483 reference to the undo stack (QUndoStack) |
|
484 </dd> |
|
485 </dl> |
|
486 <div align="right"><a href="#top">Up</a></div> |
|
487 <hr /><hr /> |
|
488 <a NAME="ChangeBookmarkCommand" ID="ChangeBookmarkCommand"></a> |
|
489 <h2>ChangeBookmarkCommand</h2> |
|
490 <p> |
|
491 Class implementing the Insert undo command. |
|
492 </p> |
|
493 <h3>Derived from</h3> |
|
494 QUndoCommand |
|
495 <h3>Class Attributes</h3> |
|
496 <table> |
|
497 <tr><td>None</td></tr> |
|
498 </table> |
|
499 <h3>Class Methods</h3> |
|
500 <table> |
|
501 <tr><td>None</td></tr> |
|
502 </table> |
|
503 <h3>Methods</h3> |
|
504 <table> |
|
505 <tr> |
|
506 <td><a href="#ChangeBookmarkCommand.__init__">ChangeBookmarkCommand</a></td> |
|
507 <td>Constructor</td> |
|
508 </tr><tr> |
|
509 <td><a href="#ChangeBookmarkCommand.redo">redo</a></td> |
|
510 <td>Public slot to perform the redo action.</td> |
|
511 </tr><tr> |
|
512 <td><a href="#ChangeBookmarkCommand.undo">undo</a></td> |
|
513 <td>Public slot to perform the undo action.</td> |
|
514 </tr> |
|
515 </table> |
|
516 <h3>Static Methods</h3> |
|
517 <table> |
|
518 <tr><td>None</td></tr> |
|
519 </table> |
|
520 <a NAME="ChangeBookmarkCommand.__init__" ID="ChangeBookmarkCommand.__init__"></a> |
|
521 <h4>ChangeBookmarkCommand (Constructor)</h4> |
|
522 <b>ChangeBookmarkCommand</b>(<i>bookmarksManager, node, newValue, title</i>) |
|
523 <p> |
|
524 Constructor |
|
525 </p><dl> |
|
526 <dt><i>bookmarksManager</i></dt> |
|
527 <dd> |
|
528 reference to the bookmarks manager |
|
529 (BookmarksManager) |
|
530 </dd><dt><i>node</i></dt> |
|
531 <dd> |
|
532 reference to the node to be changed (BookmarkNode) |
|
533 </dd><dt><i>newValue</i></dt> |
|
534 <dd> |
|
535 new value to be set (string) |
|
536 </dd><dt><i>title</i></dt> |
|
537 <dd> |
|
538 flag indicating a change of the title (True) or |
|
539 the URL (False) (boolean) |
|
540 </dd> |
|
541 </dl><a NAME="ChangeBookmarkCommand.redo" ID="ChangeBookmarkCommand.redo"></a> |
|
542 <h4>ChangeBookmarkCommand.redo</h4> |
|
543 <b>redo</b>(<i></i>) |
|
544 <p> |
|
545 Public slot to perform the redo action. |
|
546 </p><a NAME="ChangeBookmarkCommand.undo" ID="ChangeBookmarkCommand.undo"></a> |
|
547 <h4>ChangeBookmarkCommand.undo</h4> |
|
548 <b>undo</b>(<i></i>) |
|
549 <p> |
|
550 Public slot to perform the undo action. |
|
551 </p> |
|
552 <div align="right"><a href="#top">Up</a></div> |
|
553 <hr /><hr /> |
|
554 <a NAME="InsertBookmarksCommand" ID="InsertBookmarksCommand"></a> |
|
555 <h2>InsertBookmarksCommand</h2> |
|
556 <p> |
|
557 Class implementing the Insert undo command. |
|
558 </p> |
|
559 <h3>Derived from</h3> |
|
560 RemoveBookmarksCommand |
|
561 <h3>Class Attributes</h3> |
|
562 <table> |
|
563 <tr><td>None</td></tr> |
|
564 </table> |
|
565 <h3>Class Methods</h3> |
|
566 <table> |
|
567 <tr><td>None</td></tr> |
|
568 </table> |
|
569 <h3>Methods</h3> |
|
570 <table> |
|
571 <tr> |
|
572 <td><a href="#InsertBookmarksCommand.__init__">InsertBookmarksCommand</a></td> |
|
573 <td>Constructor</td> |
|
574 </tr><tr> |
|
575 <td><a href="#InsertBookmarksCommand.redo">redo</a></td> |
|
576 <td>Public slot to perform the redo action.</td> |
|
577 </tr><tr> |
|
578 <td><a href="#InsertBookmarksCommand.undo">undo</a></td> |
|
579 <td>Public slot to perform the undo action.</td> |
|
580 </tr> |
|
581 </table> |
|
582 <h3>Static Methods</h3> |
|
583 <table> |
|
584 <tr><td>None</td></tr> |
|
585 </table> |
|
586 <a NAME="InsertBookmarksCommand.__init__" ID="InsertBookmarksCommand.__init__"></a> |
|
587 <h4>InsertBookmarksCommand (Constructor)</h4> |
|
588 <b>InsertBookmarksCommand</b>(<i>bookmarksManager, parent, node, row</i>) |
|
589 <p> |
|
590 Constructor |
|
591 </p><dl> |
|
592 <dt><i>bookmarksManager</i></dt> |
|
593 <dd> |
|
594 reference to the bookmarks manager |
|
595 (BookmarksManager) |
|
596 </dd><dt><i>parent</i></dt> |
|
597 <dd> |
|
598 reference to the parent node (BookmarkNode) |
|
599 </dd><dt><i>node</i></dt> |
|
600 <dd> |
|
601 reference to the node to be inserted (BookmarkNode) |
|
602 </dd><dt><i>row</i></dt> |
|
603 <dd> |
|
604 row number of bookmark (integer) |
|
605 </dd> |
|
606 </dl><a NAME="InsertBookmarksCommand.redo" ID="InsertBookmarksCommand.redo"></a> |
|
607 <h4>InsertBookmarksCommand.redo</h4> |
|
608 <b>redo</b>(<i></i>) |
|
609 <p> |
|
610 Public slot to perform the redo action. |
|
611 </p><a NAME="InsertBookmarksCommand.undo" ID="InsertBookmarksCommand.undo"></a> |
|
612 <h4>InsertBookmarksCommand.undo</h4> |
|
613 <b>undo</b>(<i></i>) |
|
614 <p> |
|
615 Public slot to perform the undo action. |
|
616 </p> |
|
617 <div align="right"><a href="#top">Up</a></div> |
|
618 <hr /><hr /> |
|
619 <a NAME="RemoveBookmarksCommand" ID="RemoveBookmarksCommand"></a> |
|
620 <h2>RemoveBookmarksCommand</h2> |
|
621 <p> |
|
622 Class implementing the Remove undo command. |
|
623 </p> |
|
624 <h3>Derived from</h3> |
|
625 QUndoCommand |
|
626 <h3>Class Attributes</h3> |
|
627 <table> |
|
628 <tr><td>None</td></tr> |
|
629 </table> |
|
630 <h3>Class Methods</h3> |
|
631 <table> |
|
632 <tr><td>None</td></tr> |
|
633 </table> |
|
634 <h3>Methods</h3> |
|
635 <table> |
|
636 <tr> |
|
637 <td><a href="#RemoveBookmarksCommand.__init__">RemoveBookmarksCommand</a></td> |
|
638 <td>Constructor</td> |
|
639 </tr><tr> |
|
640 <td><a href="#RemoveBookmarksCommand.redo">redo</a></td> |
|
641 <td>Public slot to perform the redo action.</td> |
|
642 </tr><tr> |
|
643 <td><a href="#RemoveBookmarksCommand.undo">undo</a></td> |
|
644 <td>Public slot to perform the undo action.</td> |
|
645 </tr> |
|
646 </table> |
|
647 <h3>Static Methods</h3> |
|
648 <table> |
|
649 <tr><td>None</td></tr> |
|
650 </table> |
|
651 <a NAME="RemoveBookmarksCommand.__init__" ID="RemoveBookmarksCommand.__init__"></a> |
|
652 <h4>RemoveBookmarksCommand (Constructor)</h4> |
|
653 <b>RemoveBookmarksCommand</b>(<i>bookmarksManager, parent, row</i>) |
|
654 <p> |
|
655 Constructor |
|
656 </p><dl> |
|
657 <dt><i>bookmarksManager</i></dt> |
|
658 <dd> |
|
659 reference to the bookmarks manager |
|
660 (BookmarksManager) |
|
661 </dd><dt><i>parent</i></dt> |
|
662 <dd> |
|
663 reference to the parent node (BookmarkNode) |
|
664 </dd><dt><i>row</i></dt> |
|
665 <dd> |
|
666 row number of bookmark (integer) |
|
667 </dd> |
|
668 </dl><a NAME="RemoveBookmarksCommand.redo" ID="RemoveBookmarksCommand.redo"></a> |
|
669 <h4>RemoveBookmarksCommand.redo</h4> |
|
670 <b>redo</b>(<i></i>) |
|
671 <p> |
|
672 Public slot to perform the redo action. |
|
673 </p><a NAME="RemoveBookmarksCommand.undo" ID="RemoveBookmarksCommand.undo"></a> |
|
674 <h4>RemoveBookmarksCommand.undo</h4> |
|
675 <b>undo</b>(<i></i>) |
|
676 <p> |
|
677 Public slot to perform the undo action. |
|
678 </p> |
|
679 <div align="right"><a href="#top">Up</a></div> |
|
680 <hr /> |
|
681 </body></html> |