--- a/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.BookmarksImporters.XbelImporter.html Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.WebBrowser.Bookmarks.BookmarksImporters.XbelImporter.html Wed Sep 25 19:42:44 2019 +0200
@@ -18,122 +18,159 @@
</style>
</head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
<h1>eric6.WebBrowser.Bookmarks.BookmarksImporters.XbelImporter</h1>
+
<p>
Module implementing an importer for XBEL files.
</p>
<h3>Global Attributes</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
+
<table>
+
<tr>
<td><a href="#XbelImporter">XbelImporter</a></td>
<td>Class implementing the XBEL bookmarks importer.</td>
</tr>
</table>
<h3>Functions</h3>
+
<table>
+
<tr>
<td><a href="#getImporterInfo">getImporterInfo</a></td>
<td>Module function to get information for the given XBEL source id.</td>
</tr>
</table>
-<hr /><hr />
+<hr />
+<hr />
<a NAME="XbelImporter" ID="XbelImporter"></a>
<h2>XbelImporter</h2>
+
<p>
Class implementing the XBEL bookmarks importer.
</p>
<h3>Derived from</h3>
BookmarksImporter
<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="#XbelImporter.__init__">XbelImporter</a></td>
<td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#XbelImporter.importedBookmarks">importedBookmarks</a></td>
<td>Public method to get the imported bookmarks.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#XbelImporter.open">open</a></td>
<td>Public method to open the bookmarks file.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#XbelImporter.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="XbelImporter.__init__" ID="XbelImporter.__init__"></a>
<h4>XbelImporter (Constructor)</h4>
<b>XbelImporter</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="XbelImporter.importedBookmarks" ID="XbelImporter.importedBookmarks"></a>
+</dl>
+<a NAME="XbelImporter.importedBookmarks" ID="XbelImporter.importedBookmarks"></a>
<h4>XbelImporter.importedBookmarks</h4>
<b>importedBookmarks</b>(<i></i>)
+
<p>
Public method to get the imported bookmarks.
-</p><dl>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
imported bookmarks (BookmarkNode)
</dd>
-</dl><a NAME="XbelImporter.open" ID="XbelImporter.open"></a>
+</dl>
+<a NAME="XbelImporter.open" ID="XbelImporter.open"></a>
<h4>XbelImporter.open</h4>
<b>open</b>(<i></i>)
+
<p>
Public method to open the bookmarks file.
-</p><dl>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
flag indicating success (boolean)
</dd>
-</dl><a NAME="XbelImporter.setPath" ID="XbelImporter.setPath"></a>
+</dl>
+<a NAME="XbelImporter.setPath" ID="XbelImporter.setPath"></a>
<h4>XbelImporter.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>
<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
<a NAME="getImporterInfo" ID="getImporterInfo"></a>
<h2>getImporterInfo</h2>
<b>getImporterInfo</b>(<i>sourceId</i>)
+
<p>
Module function to get information for the given XBEL source id.
-</p><dl>
+</p>
+<dl>
+
<dt><i>sourceId</i></dt>
<dd>
id of the browser ("chrome" or "chromium")
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
tuple with an icon (QPixmap), readable name (string), name of
@@ -141,7 +178,9 @@
a prompt (string) and the default directory of the bookmarks file
(string)
</dd>
-</dl><dl>
+</dl>
+<dl>
+
<dt>Raises <b>ValueError</b>:</dt>
<dd>
raised to indicate an invalid browser ID
