src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImporters.__init__.html

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.Bookmarks.BookmarksImporters.__init__</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.Bookmarks.BookmarksImporters.__init__</h1>

<p>
Package implementing bookmarks importers for various sources.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#getImporter">getImporter</a></td>
<td>Module function to get an importer for the given source id.</td>
</tr>
<tr>
<td><a href="#getImporterInfo">getImporterInfo</a></td>
<td>Module function to get information for the given source id.</td>
</tr>
<tr>
<td><a href="#getImporterModule">getImporterModule</a></td>
<td>Function to get a bookmark importer module for a given source.</td>
</tr>
<tr>
<td><a href="#getImporters">getImporters</a></td>
<td>Module function to get a list of supported importers.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="getImporter" ID="getImporter"></a>
<h2>getImporter</h2>
<b>getImporter</b>(<i>sourceId, parent=None</i>)

<p>
    Module function to get an importer for the given source id.
</p>
<dl>

<dt><i>sourceId</i> (str)</dt>
<dd>
source id to get an importer for
</dd>
<dt><i>parent</i> (QObject)</dt>
<dd>
reference to the parent object
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
bookmarks importer
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
BookmarksImporter
</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 source id.
</p>
<dl>

<dt><i>sourceId</i> (str)</dt>
<dd>
source id to get info for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
tuple with an icon, readable name, name of the default bookmarks file,
        an info text, a prompt and the default directory of the bookmarks file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (QPixmap, str, str, str, str, str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="getImporterModule" ID="getImporterModule"></a>
<h2>getImporterModule</h2>
<b>getImporterModule</b>(<i>sourceId</i>)

<p>
    Function to get a bookmark importer module for a given source.
</p>
<dl>

<dt><i>sourceId</i> (str)</dt>
<dd>
source id to get an importer module for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the imported module
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
module
</dd>
</dl>
<dl>

<dt>Raises <b>ValueError</b>:</dt>
<dd>
raised to indicate an unsupported importer
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="getImporters" ID="getImporters"></a>
<h2>getImporters</h2>
<b>getImporters</b>(<i></i>)

<p>
    Module function to get a list of supported importers.
</p>
<dl>
<dt>Return:</dt>
<dd>
list of tuples with an icon, readable name and internal name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of tuples of (QIcon, str, str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>