diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.BookmarksImporters.BookmarksImporter.html --- a/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.BookmarksImporters.BookmarksImporter.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.BookmarksImporters.BookmarksImporter.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,138 +18,183 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.Bookmarks.BookmarksImporters.BookmarksImporter</h1> + <p> Module implementing a base class for the bookmarks importers. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#BookmarksImporter">BookmarksImporter</a></td> <td>Class implementing the base class for the bookmarks importers.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="BookmarksImporter" ID="BookmarksImporter"></a> <h2>BookmarksImporter</h2> + <p> Class implementing the base class for the bookmarks importers. </p> <h3>Derived from</h3> QObject <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="#BookmarksImporter.__init__">BookmarksImporter</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#BookmarksImporter.error">error</a></td> <td>Public method to check for an error.</td> -</tr><tr> +</tr> +<tr> <td><a href="#BookmarksImporter.errorString">errorString</a></td> <td>Public method to get the error description.</td> -</tr><tr> +</tr> +<tr> <td><a href="#BookmarksImporter.importedBookmarks">importedBookmarks</a></td> <td>Public method to get the imported bookmarks.</td> -</tr><tr> +</tr> +<tr> <td><a href="#BookmarksImporter.open">open</a></td> <td>Public method to open the bookmarks file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#BookmarksImporter.setPath">setPath</a></td> <td>Public method to set the path of the bookmarks file or directory.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="BookmarksImporter.__init__" ID="BookmarksImporter.__init__"></a> <h4>BookmarksImporter (Constructor)</h4> <b>BookmarksImporter</b>(<i>sourceId="", parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>sourceId</i></dt> <dd> source ID (string) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent object (QObject) </dd> -</dl><a NAME="BookmarksImporter.error" ID="BookmarksImporter.error"></a> +</dl> +<a NAME="BookmarksImporter.error" ID="BookmarksImporter.error"></a> <h4>BookmarksImporter.error</h4> <b>error</b>(<i></i>) + <p> Public method to check for an error. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating an error (boolean) </dd> -</dl><a NAME="BookmarksImporter.errorString" ID="BookmarksImporter.errorString"></a> +</dl> +<a NAME="BookmarksImporter.errorString" ID="BookmarksImporter.errorString"></a> <h4>BookmarksImporter.errorString</h4> <b>errorString</b>(<i></i>) + <p> Public method to get the error description. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> error description (string) </dd> -</dl><a NAME="BookmarksImporter.importedBookmarks" ID="BookmarksImporter.importedBookmarks"></a> +</dl> +<a NAME="BookmarksImporter.importedBookmarks" ID="BookmarksImporter.importedBookmarks"></a> <h4>BookmarksImporter.importedBookmarks</h4> <b>importedBookmarks</b>(<i></i>) + <p> Public method to get the imported bookmarks. -</p><p> +</p> +<p> It must return the imported bookmarks (BookmarkNode). -</p><dl> +</p> +<dl> + <dt>Raises <b>NotImplementedError</b>:</dt> <dd> raised to indicate this method must be implemented by a subclass </dd> -</dl><a NAME="BookmarksImporter.open" ID="BookmarksImporter.open"></a> +</dl> +<a NAME="BookmarksImporter.open" ID="BookmarksImporter.open"></a> <h4>BookmarksImporter.open</h4> <b>open</b>(<i></i>) + <p> Public method to open the bookmarks file. -</p><p> +</p> +<p> It must return a flag indicating success (boolean). -</p><dl> +</p> +<dl> + <dt>Raises <b>NotImplementedError</b>:</dt> <dd> raised to indicate this method must be implemented by a subclass </dd> -</dl><a NAME="BookmarksImporter.setPath" ID="BookmarksImporter.setPath"></a> +</dl> +<a NAME="BookmarksImporter.setPath" ID="BookmarksImporter.setPath"></a> <h4>BookmarksImporter.setPath</h4> <b>setPath</b>(<i>path</i>) + <p> Public method to set the path of the bookmarks file or directory. -</p><dl> +</p> +<dl> + <dt><i>path</i></dt> <dd> bookmarks file or directory (string) </dd> -</dl><dl> +</dl> +<dl> + <dt>Raises <b>NotImplementedError</b>:</dt> <dd> raised to indicate this method must