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

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

<p>
Module implementing an importer for Apple Safari bookmarks.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#SafariImporter">SafariImporter</a></td>
<td>Class implementing the Apple Safari bookmarks importer.</td>
</tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#createImporter">createImporter</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#getImporterInfo">getImporterInfo</a></td>
<td>Module function to get information for the given source id.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="SafariImporter" ID="SafariImporter"></a>
<h2>SafariImporter</h2>

<p>
    Class implementing the Apple Safari 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="#SafariImporter.__init__">SafariImporter</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#SafariImporter.__processChildren">__processChildren</a></td>
<td>Private method to process the list of children.</td>
</tr>
<tr>
<td><a href="#SafariImporter.importedBookmarks">importedBookmarks</a></td>
<td>Public method to get the imported bookmarks.</td>
</tr>
<tr>
<td><a href="#SafariImporter.open">open</a></td>
<td>Public method to open the bookmarks file.</td>
</tr>
<tr>
<td><a href="#SafariImporter.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="SafariImporter.__init__" ID="SafariImporter.__init__"></a>
<h4>SafariImporter (Constructor)</h4>
<b>SafariImporter</b>(<i>sourceId="", parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>sourceId</i> (str (optional))</dt>
<dd>
source ID (defaults to "")
</dd>
<dt><i>parent</i> (QObject (optional))</dt>
<dd>
reference to the parent object (defaults to None)
</dd>
</dl>
<a NAME="SafariImporter.__processChildren" ID="SafariImporter.__processChildren"></a>
<h4>SafariImporter.__processChildren</h4>
<b>__processChildren</b>(<i>children, rootNode</i>)

<p>
        Private method to process the list of children.
</p>
<dl>

<dt><i>children</i> (list of dict)</dt>
<dd>
list of child nodes to be processed
</dd>
<dt><i>rootNode</i> (BookmarkNode)</dt>
<dd>
node to add the bookmarks to
</dd>
</dl>
<a NAME="SafariImporter.importedBookmarks" ID="SafariImporter.importedBookmarks"></a>
<h4>SafariImporter.importedBookmarks</h4>
<b>importedBookmarks</b>(<i></i>)

<p>
        Public method to get the imported bookmarks.
</p>
<dl>
<dt>Return:</dt>
<dd>
imported bookmarks
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
BookmarkNode
</dd>
</dl>
<a NAME="SafariImporter.open" ID="SafariImporter.open"></a>
<h4>SafariImporter.open</h4>
<b>open</b>(<i></i>)

<p>
        Public method to open the bookmarks file.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="SafariImporter.setPath" ID="SafariImporter.setPath"></a>
<h4>SafariImporter.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> (str)</dt>
<dd>
bookmarks file or directory
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="createImporter" ID="createImporter"></a>
<h2>createImporter</h2>
<b>createImporter</b>(<i>sourceId="", parent=None</i>)

<p>
    Constructor
</p>
<dl>

<dt><i>sourceId</i> (str (optional))</dt>
<dd>
source ID (defaults to "")
</dd>
<dt><i>parent</i> (QObject (optional))</dt>
<dd>
reference to the parent object (defaults to None)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the instantiated importer object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
SafariImporter
</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>
id of the browser
</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>
<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>