Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Helpviewer.Bookmarks.BookmarksManager.html

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

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

Mercurial Repository: eric

eric ide

mercurial