diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksManager.html --- a/src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksManager.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksManager.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,19 +7,21 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.WebBrowser.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>StartMenu</td></tr><tr><td>StartRoot</td></tr><tr><td>StartToolBar</td></tr> +<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> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#BookmarksManager">BookmarksManager</a></td> <td>Class implementing the bookmarks manager.</td> @@ -37,19 +39,20 @@ <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> + <h3>Signals</h3> <dl> @@ -80,23 +83,20 @@ <h3>Derived from</h3> QObject <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> - <tr> <td><a href="#BookmarksManager.getFileName">getFileName</a></td> <td>Class method to get the file name of the bookmark file.</td> </tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#BookmarksManager.__init__">BookmarksManager</a></td> <td>Constructor</td> @@ -206,19 +206,20 @@ <td>Public method to get a reference to the undo stack.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="BookmarksManager.getFileName" ID="BookmarksManager.getFileName"></a> <h4>BookmarksManager.getFileName (class method)</h4> <b>getFileName</b>(<i></i>) - <p> Class method to get the file name of the bookmark file. </p> + <dl> <dt>Return:</dt> <dd> @@ -234,10 +235,10 @@ <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> (QObject)</dt> @@ -248,17 +249,17 @@ <a NAME="BookmarksManager.__initialize" ID="BookmarksManager.__initialize"></a> <h4>BookmarksManager.__initialize</h4> <b>__initialize</b>(<i></i>) - <p> Private method to initialize some data. </p> + <a NAME="BookmarksManager.__searchBookmark" ID="BookmarksManager.__searchBookmark"></a> <h4>BookmarksManager.__searchBookmark</h4> <b>__searchBookmark</b>(<i>url, startNode</i>) - <p> Private method get a bookmark node for a given URL. </p> + <dl> <dt><i>url</i> (str)</dt> @@ -285,10 +286,10 @@ <a NAME="BookmarksManager.__searchBookmarks" ID="BookmarksManager.__searchBookmarks"></a> <h4>BookmarksManager.__searchBookmarks</h4> <b>__searchBookmarks</b>(<i>url, startNode</i>) - <p> Private method get a list of bookmark nodes for a given URL. </p> + <dl> <dt><i>url</i> (str)</dt> @@ -315,10 +316,10 @@ <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> (BookmarkNode)</dt> @@ -337,10 +338,10 @@ <a NAME="BookmarksManager.bookmarkForUrl" ID="BookmarksManager.bookmarkForUrl"></a> <h4>BookmarksManager.bookmarkForUrl</h4> <b>bookmarkForUrl</b>(<i>url, start=StartRoot</i>) - <p> Public method to get a bookmark node for a given URL. </p> + <dl> <dt><i>url</i> (QUrl or str)</dt> @@ -368,10 +369,10 @@ <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>Return:</dt> <dd> @@ -387,10 +388,10 @@ <a NAME="BookmarksManager.bookmarksForUrl" ID="BookmarksManager.bookmarksForUrl"></a> <h4>BookmarksManager.bookmarksForUrl</h4> <b>bookmarksForUrl</b>(<i>url, start=StartRoot</i>) - <p> Public method to get a list of bookmark nodes for a given URL. </p> + <dl> <dt><i>url</i> (QUrl or str)</dt> @@ -418,10 +419,10 @@ <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>Return:</dt> <dd> @@ -437,31 +438,31 @@ <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.faviconChanged" ID="BookmarksManager.faviconChanged"></a> <h4>BookmarksManager.faviconChanged</h4> <b>faviconChanged</b>(<i>url</i>) - <p> Public slot to update the icon image for an URL. </p> + <dl> <dt><i>url</i> (QUrl or str)</dt> @@ -472,17 +473,17 @@ <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.incVisitCount" ID="BookmarksManager.incVisitCount"></a> <h4>BookmarksManager.incVisitCount</h4> <b>incVisitCount</b>(<i>node</i>) - <p> Public method to increment the visit count of a bookmark. </p> + <dl> <dt><i>node</i> (BookmarkNode)</dt> @@ -493,10 +494,10 @@ <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> + <dl> <dt>Raises <b>RuntimeError</b>:</dt> @@ -508,10 +509,10 @@ <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>Return:</dt> <dd> @@ -527,17 +528,17 @@ <a NAME="BookmarksManager.reload" ID="BookmarksManager.reload"></a> <h4>BookmarksManager.reload</h4> <b>reload</b>(<i></i>) - <p> Public method used to initiate a reloading of the bookmarks. </p> + <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> (BookmarkNode)</dt> @@ -548,25 +549,25 @@ <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.setNodeChanged" ID="BookmarksManager.setNodeChanged"></a> <h4>BookmarksManager.setNodeChanged</h4> <b>setNodeChanged</b>(<i></i>) - <p> Public method to signal changes of bookmarks other than title, URL or timestamp. </p> + <a NAME="BookmarksManager.setTimestamp" ID="BookmarksManager.setTimestamp"></a> <h4>BookmarksManager.setTimestamp</h4> <b>setTimestamp</b>(<i>node, timestampType, timestamp</i>) - <p> Public method to set the URL of a bookmark. </p> + <dl> <dt><i>node</i> (BookmarkNode)</dt> @@ -587,10 +588,10 @@ <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> (BookmarkNode)</dt> @@ -605,10 +606,10 @@ <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> (BookmarkNode)</dt> @@ -623,10 +624,10 @@ <a NAME="BookmarksManager.setVisitCount" ID="BookmarksManager.setVisitCount"></a> <h4>BookmarksManager.setVisitCount</h4> <b>setVisitCount</b>(<i>node, count</i>) - <p> Public method to set the visit count of a bookmark. </p> + <dl> <dt><i>node</i> (BookmarkNode)</dt> @@ -641,10 +642,10 @@ <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>Return:</dt> <dd> @@ -660,10 +661,10 @@ <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>Return:</dt> <dd> @@ -681,26 +682,24 @@ <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>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#ChangeBookmarkCommand.__init__">ChangeBookmarkCommand</a></td> <td>Constructor</td> @@ -714,19 +713,20 @@ <td>Public slot to perform the undo action.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</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> (BookmarksManager)</dt> @@ -750,42 +750,40 @@ <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>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#InsertBookmarksCommand.__init__">InsertBookmarksCommand</a></td> <td>Constructor</td> @@ -799,19 +797,20 @@ <td>Public slot to perform the undo action.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</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> (BookmarksManager)</dt> @@ -834,42 +833,40 @@ <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>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#RemoveBookmarksCommand.__init__">RemoveBookmarksCommand</a></td> <td>Constructor</td> @@ -883,19 +880,20 @@ <td>Public slot to perform the undo action.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</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> (BookmarksManager)</dt> @@ -914,17 +912,17 @@ <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 +</body></html>