--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.Helpviewer.Bookmarks.BookmarksManager.html Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,447 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.Helpviewer.Bookmarks.BookmarksManager</title>
+<style>
+body {
+ background:white;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.Helpviewer.Bookmarks.BookmarksManager</h1>
+<p>
+Module implementing the bookmarks manager.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>BOOKMARKBAR</td></tr><tr><td>BOOKMARKMENU</td></tr><tr><td>extract_js</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#BookmarksManager">BookmarksManager</a></td>
+<td>Class implementing the bookmarks manager.</td>
+</tr><tr>
+<td><a href="#ChangeBookmarkCommand">ChangeBookmarkCommand</a></td>
+<td>Class implementing the Insert undo command.</td>
+</tr><tr>
+<td><a href="#InsertBookmarksCommand">InsertBookmarksCommand</a></td>
+<td>Class implementing the Insert undo command.</td>
+</tr><tr>
+<td><a href="#RemoveBookmarksCommand">RemoveBookmarksCommand</a></td>
+<td>Class implementing the Remove undo command.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="BookmarksManager" ID="BookmarksManager"></a>
+<h2>BookmarksManager</h2>
+<p>
+ Class implementing the bookmarks manager.
+</p><h4>Signals</h4>
+<dl>
+<dt>entryAdded</dt>
+<dd>
+emitted after a bookmark node has been added
+</dd><dt>entryChanged</dt>
+<dd>
+emitted after a bookmark node has been changed
+</dd><dt>entryRemoved</dt>
+<dd>
+emitted after a bookmark
+ node has been removed
+</dd>
+</dl>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#BookmarksManager.__init__">BookmarksManager</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#BookmarksManager.__convertFromOldBookmarks">__convertFromOldBookmarks</a></td>
+<td>Private method to convert the old bookmarks into the new ones.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.addBookmark">addBookmark</a></td>
+<td>Public method to add a bookmark.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.bookmarks">bookmarks</a></td>
+<td>Public method to get a reference to the root bookmark node.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.bookmarksModel">bookmarksModel</a></td>
+<td>Public method to get a reference to the bookmarks model.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.changeExpanded">changeExpanded</a></td>
+<td>Public method to handle a change of the expanded state.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.close">close</a></td>
+<td>Public method to close the bookmark manager.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.exportBookmarks">exportBookmarks</a></td>
+<td>Public method to export the bookmarks.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.importBookmarks">importBookmarks</a></td>
+<td>Public method to import bookmarks.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.load">load</a></td>
+<td>Public method to load the bookmarks.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.menu">menu</a></td>
+<td>Public method to get a reference to the bookmarks menu node.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.removeBookmark">removeBookmark</a></td>
+<td>Public method to remove a bookmark.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.save">save</a></td>
+<td>Public method to save the bookmarks.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.setTitle">setTitle</a></td>
+<td>Public method to set the title of a bookmark.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.setUrl">setUrl</a></td>
+<td>Public method to set the URL of a bookmark.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.toolbar">toolbar</a></td>
+<td>Public method to get a reference to the bookmarks toolbar node.</td>
+</tr><tr>
+<td><a href="#BookmarksManager.undoRedoStack">undoRedoStack</a></td>
+<td>Public method to get a reference to the undo stack.</td>
+</tr>
+</table>
+<a NAME="BookmarksManager.__init__" ID="BookmarksManager.__init__"></a>
+<h4>BookmarksManager (Constructor)</h4>
+<b>BookmarksManager</b>(<i>parent = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent object (QObject)
+</dd>
+</dl><a NAME="BookmarksManager.__convertFromOldBookmarks" ID="BookmarksManager.__convertFromOldBookmarks"></a>
+<h4>BookmarksManager.__convertFromOldBookmarks</h4>
+<b>__convertFromOldBookmarks</b>(<i></i>)
+<p>
+ Private method to convert the old bookmarks into the new ones.
+</p><a NAME="BookmarksManager.addBookmark" ID="BookmarksManager.addBookmark"></a>
+<h4>BookmarksManager.addBookmark</h4>
+<b>addBookmark</b>(<i>parent, node, row = -1</i>)
+<p>
+ Public method to add a bookmark.
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the node to add to (BookmarkNode)
+</dd><dt><i>node</i></dt>
+<dd>
+reference to the node to add (BookmarkNode)
+</dd><dt><i>row</i></dt>
+<dd>
+row number (integer)
+</dd>
+</dl><a NAME="BookmarksManager.bookmarks" ID="BookmarksManager.bookmarks"></a>
+<h4>BookmarksManager.bookmarks</h4>
+<b>bookmarks</b>(<i></i>)
+<p>
+ Public method to get a reference to the root bookmark node.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the root bookmark node (BookmarkNode)
+</dd>
+</dl><a NAME="BookmarksManager.bookmarksModel" ID="BookmarksManager.bookmarksModel"></a>
+<h4>BookmarksManager.bookmarksModel</h4>
+<b>bookmarksModel</b>(<i></i>)
+<p>
+ Public method to get a reference to the bookmarks model.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the bookmarks model (BookmarksModel)
+</dd>
+</dl><a NAME="BookmarksManager.changeExpanded" ID="BookmarksManager.changeExpanded"></a>
+<h4>BookmarksManager.changeExpanded</h4>
+<b>changeExpanded</b>(<i></i>)
+<p>
+ Public method to handle a change of the expanded state.
+</p><a NAME="BookmarksManager.close" ID="BookmarksManager.close"></a>
+<h4>BookmarksManager.close</h4>
+<b>close</b>(<i></i>)
+<p>
+ Public method to close the bookmark manager.
+</p><a NAME="BookmarksManager.exportBookmarks" ID="BookmarksManager.exportBookmarks"></a>
+<h4>BookmarksManager.exportBookmarks</h4>
+<b>exportBookmarks</b>(<i></i>)
+<p>
+ Public method to export the bookmarks.
+</p><a NAME="BookmarksManager.importBookmarks" ID="BookmarksManager.importBookmarks"></a>
+<h4>BookmarksManager.importBookmarks</h4>
+<b>importBookmarks</b>(<i></i>)
+<p>
+ Public method to import bookmarks.
+</p><a NAME="BookmarksManager.load" ID="BookmarksManager.load"></a>
+<h4>BookmarksManager.load</h4>
+<b>load</b>(<i></i>)
+<p>
+ Public method to load the bookmarks.
+</p><a NAME="BookmarksManager.menu" ID="BookmarksManager.menu"></a>
+<h4>BookmarksManager.menu</h4>
+<b>menu</b>(<i></i>)
+<p>
+ Public method to get a reference to the bookmarks menu node.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the bookmarks menu node (BookmarkNode)
+</dd>
+</dl><a NAME="BookmarksManager.removeBookmark" ID="BookmarksManager.removeBookmark"></a>
+<h4>BookmarksManager.removeBookmark</h4>
+<b>removeBookmark</b>(<i>node</i>)
+<p>
+ Public method to remove a bookmark.
+</p><dl>
+<dt><i>node</i></dt>
+<dd>
+reference to the node to be removed (BookmarkNode)
+</dd>
+</dl><a NAME="BookmarksManager.save" ID="BookmarksManager.save"></a>
+<h4>BookmarksManager.save</h4>
+<b>save</b>(<i></i>)
+<p>
+ Public method to save the bookmarks.
+</p><a NAME="BookmarksManager.setTitle" ID="BookmarksManager.setTitle"></a>
+<h4>BookmarksManager.setTitle</h4>
+<b>setTitle</b>(<i>node, newTitle</i>)
+<p>
+ Public method to set the title of a bookmark.
+</p><dl>
+<dt><i>node</i></dt>
+<dd>
+reference to the node to be changed (BookmarkNode)
+</dd><dt><i>newTitle</i></dt>
+<dd>
+title to be set (string)
+</dd>
+</dl><a NAME="BookmarksManager.setUrl" ID="BookmarksManager.setUrl"></a>
+<h4>BookmarksManager.setUrl</h4>
+<b>setUrl</b>(<i>node, newUrl</i>)
+<p>
+ Public method to set the URL of a bookmark.
+</p><dl>
+<dt><i>node</i></dt>
+<dd>
+reference to the node to be changed (BookmarkNode)
+</dd><dt><i>newUrl</i></dt>
+<dd>
+URL to be set (string)
+</dd>
+</dl><a NAME="BookmarksManager.toolbar" ID="BookmarksManager.toolbar"></a>
+<h4>BookmarksManager.toolbar</h4>
+<b>toolbar</b>(<i></i>)
+<p>
+ Public method to get a reference to the bookmarks toolbar node.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the bookmarks toolbar node (BookmarkNode)
+</dd>
+</dl><a NAME="BookmarksManager.undoRedoStack" ID="BookmarksManager.undoRedoStack"></a>
+<h4>BookmarksManager.undoRedoStack</h4>
+<b>undoRedoStack</b>(<i></i>)
+<p>
+ Public method to get a reference to the undo stack.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the undo stack (QUndoStack)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="ChangeBookmarkCommand" ID="ChangeBookmarkCommand"></a>
+<h2>ChangeBookmarkCommand</h2>
+<p>
+ Class implementing the Insert undo command.
+</p>
+<h3>Derived from</h3>
+QUndoCommand
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#ChangeBookmarkCommand.__init__">ChangeBookmarkCommand</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#ChangeBookmarkCommand.redo">redo</a></td>
+<td>Public slot to perform the redo action.</td>
+</tr><tr>
+<td><a href="#ChangeBookmarkCommand.undo">undo</a></td>
+<td>Public slot to perform the undo action.</td>
+</tr>
+</table>
+<a NAME="ChangeBookmarkCommand.__init__" ID="ChangeBookmarkCommand.__init__"></a>
+<h4>ChangeBookmarkCommand (Constructor)</h4>
+<b>ChangeBookmarkCommand</b>(<i>bookmarksManager, node, newValue, title</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>bookmarksManager</i></dt>
+<dd>
+reference to the bookmarks manager (BookmarksManager)
+</dd><dt><i>node</i></dt>
+<dd>
+reference to the node to be changed (BookmarkNode)
+</dd><dt><i>newValue</i></dt>
+<dd>
+new value to be set (string)
+</dd><dt><i>title</i></dt>
+<dd>
+flag indicating a change of the title (True) or
+ the URL (False) (boolean)
+</dd>
+</dl><a NAME="ChangeBookmarkCommand.redo" ID="ChangeBookmarkCommand.redo"></a>
+<h4>ChangeBookmarkCommand.redo</h4>
+<b>redo</b>(<i></i>)
+<p>
+ Public slot to perform the redo action.
+</p><a NAME="ChangeBookmarkCommand.undo" ID="ChangeBookmarkCommand.undo"></a>
+<h4>ChangeBookmarkCommand.undo</h4>
+<b>undo</b>(<i></i>)
+<p>
+ Public slot to perform the undo action.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="InsertBookmarksCommand" ID="InsertBookmarksCommand"></a>
+<h2>InsertBookmarksCommand</h2>
+<p>
+ Class implementing the Insert undo command.
+</p>
+<h3>Derived from</h3>
+RemoveBookmarksCommand
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#InsertBookmarksCommand.__init__">InsertBookmarksCommand</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#InsertBookmarksCommand.redo">redo</a></td>
+<td>Public slot to perform the redo action.</td>
+</tr><tr>
+<td><a href="#InsertBookmarksCommand.undo">undo</a></td>
+<td>Public slot to perform the undo action.</td>
+</tr>
+</table>
+<a NAME="InsertBookmarksCommand.__init__" ID="InsertBookmarksCommand.__init__"></a>
+<h4>InsertBookmarksCommand (Constructor)</h4>
+<b>InsertBookmarksCommand</b>(<i>bookmarksManager, parent, node, row</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>bookmarksManager</i></dt>
+<dd>
+reference to the bookmarks manager (BookmarksManager)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent node (BookmarkNode)
+</dd><dt><i>node</i></dt>
+<dd>
+reference to the node to be inserted (BookmarkNode)
+</dd><dt><i>row</i></dt>
+<dd>
+row number of bookmark (integer)
+</dd>
+</dl><a NAME="InsertBookmarksCommand.redo" ID="InsertBookmarksCommand.redo"></a>
+<h4>InsertBookmarksCommand.redo</h4>
+<b>redo</b>(<i></i>)
+<p>
+ Public slot to perform the redo action.
+</p><a NAME="InsertBookmarksCommand.undo" ID="InsertBookmarksCommand.undo"></a>
+<h4>InsertBookmarksCommand.undo</h4>
+<b>undo</b>(<i></i>)
+<p>
+ Public slot to perform the undo action.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="RemoveBookmarksCommand" ID="RemoveBookmarksCommand"></a>
+<h2>RemoveBookmarksCommand</h2>
+<p>
+ Class implementing the Remove undo command.
+</p>
+<h3>Derived from</h3>
+QUndoCommand
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#RemoveBookmarksCommand.__init__">RemoveBookmarksCommand</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#RemoveBookmarksCommand.redo">redo</a></td>
+<td>Public slot to perform the redo action.</td>
+</tr><tr>
+<td><a href="#RemoveBookmarksCommand.undo">undo</a></td>
+<td>Public slot to perform the undo action.</td>
+</tr>
+</table>
+<a NAME="RemoveBookmarksCommand.__init__" ID="RemoveBookmarksCommand.__init__"></a>
+<h4>RemoveBookmarksCommand (Constructor)</h4>
+<b>RemoveBookmarksCommand</b>(<i>bookmarksManager, parent, row</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>bookmarksManager</i></dt>
+<dd>
+reference to the bookmarks manager (BookmarksManager)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent node (BookmarkNode)
+</dd><dt><i>row</i></dt>
+<dd>
+row number of bookmark (integer)
+</dd>
+</dl><a NAME="RemoveBookmarksCommand.redo" ID="RemoveBookmarksCommand.redo"></a>
+<h4>RemoveBookmarksCommand.redo</h4>
+<b>redo</b>(<i></i>)
+<p>
+ Public slot to perform the redo action.
+</p><a NAME="RemoveBookmarksCommand.undo" ID="RemoveBookmarksCommand.undo"></a>
+<h4>RemoveBookmarksCommand.undo</h4>
+<b>undo</b>(<i></i>)
+<p>
+ Public slot to perform the undo action.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
