--- a/eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarksImporters.HtmlImporter.html Sat Sep 07 14:45:27 2019 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,152 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric6.Helpviewer.Bookmarks.BookmarksImporters.HtmlImporter</title> -<meta charset="UTF-8"> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> -</head> -<body><a NAME="top" ID="top"></a> -<h1>eric6.Helpviewer.Bookmarks.BookmarksImporters.HtmlImporter</h1> -<p> -Module implementing an importer for HTML bookmark files. -</p> -<h3>Global Attributes</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> -<table> -<tr> -<td><a href="#HtmlImporter">HtmlImporter</a></td> -<td>Class implementing the HTML 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 HTML source id.</td> -</tr> -</table> -<hr /><hr /> -<a NAME="HtmlImporter" ID="HtmlImporter"></a> -<h2>HtmlImporter</h2> -<p> - Class implementing the HTML 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="#HtmlImporter.__init__">HtmlImporter</a></td> -<td>Constructor</td> -</tr><tr> -<td><a href="#HtmlImporter.importedBookmarks">importedBookmarks</a></td> -<td>Public method to get the imported bookmarks.</td> -</tr><tr> -<td><a href="#HtmlImporter.open">open</a></td> -<td>Public method to open the bookmarks file.</td> -</tr><tr> -<td><a href="#HtmlImporter.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="HtmlImporter.__init__" ID="HtmlImporter.__init__"></a> -<h4>HtmlImporter (Constructor)</h4> -<b>HtmlImporter</b>(<i>sourceId="", parent=None</i>) -<p> - Constructor -</p><dl> -<dt><i>sourceId</i></dt> -<dd> -source ID (string) -</dd><dt><i>parent</i></dt> -<dd> -reference to the parent object (QObject) -</dd> -</dl><a NAME="HtmlImporter.importedBookmarks" ID="HtmlImporter.importedBookmarks"></a> -<h4>HtmlImporter.importedBookmarks</h4> -<b>importedBookmarks</b>(<i></i>) -<p> - Public method to get the imported bookmarks. -</p><dl> -<dt>Returns:</dt> -<dd> -imported bookmarks (BookmarkNode) -</dd> -</dl><a NAME="HtmlImporter.open" ID="HtmlImporter.open"></a> -<h4>HtmlImporter.open</h4> -<b>open</b>(<i></i>) -<p> - Public method to open the bookmarks file. -</p><dl> -<dt>Returns:</dt> -<dd> -flag indicating success (boolean) -</dd> -</dl><a NAME="HtmlImporter.setPath" ID="HtmlImporter.setPath"></a> -<h4>HtmlImporter.setPath</h4> -<b>setPath</b>(<i>path</i>) -<p> - Public method to set the path of the bookmarks file or directory. -</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 /> -<a NAME="getImporterInfo" ID="getImporterInfo"></a> -<h2>getImporterInfo</h2> -<b>getImporterInfo</b>(<i>sourceId</i>) -<p> - Module function to get information for the given HTML source id. -</p><dl> -<dt><i>sourceId</i></dt> -<dd> -id of the browser ("chrome" or "chromium") -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -tuple with an icon (QPixmap), readable name (string), name of - the default bookmarks file (string), an info text (string), - a prompt (string) and the default directory of the bookmarks file - (string) -</dd> -</dl><dl> -<dt>Raises <b>ValueError</b>:</dt> -<dd> -raised to indicate an invalid browser ID -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file