Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.OperaImporter.html

changeset 1715
558e44df025a
child 2367
78f6c8193d37
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.OperaImporter.html	Sun Mar 18 16:15:50 2012 +0100
@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Helpviewer.Bookmarks.BookmarksImporters.OperaImporter</title>
+<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>eric5.Helpviewer.Bookmarks.BookmarksImporters.OperaImporter</h1>
+<p>
+Module implementing an importer for Opera bookmarks.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#OperaImporter">OperaImporter</a></td>
+<td>Class implementing the Opera 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 source id.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="OperaImporter" ID="OperaImporter"></a>
+<h2>OperaImporter</h2>
+<p>
+    Class implementing the Opera 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="#OperaImporter.__init__">OperaImporter</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#OperaImporter.importedBookmarks">importedBookmarks</a></td>
+<td>Public method to get the imported bookmarks.</td>
+</tr><tr>
+<td><a href="#OperaImporter.open">open</a></td>
+<td>Public method to open the bookmarks file.</td>
+</tr><tr>
+<td><a href="#OperaImporter.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="OperaImporter.__init__" ID="OperaImporter.__init__"></a>
+<h4>OperaImporter (Constructor)</h4>
+<b>OperaImporter</b>(<i>id="", parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>id</i></dt>
+<dd>
+source ID (string)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent object (QObject)
+</dd>
+</dl><a NAME="OperaImporter.importedBookmarks" ID="OperaImporter.importedBookmarks"></a>
+<h4>OperaImporter.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="OperaImporter.open" ID="OperaImporter.open"></a>
+<h4>OperaImporter.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="OperaImporter.setPath" ID="OperaImporter.setPath"></a>
+<h4>OperaImporter.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>id</i>)
+<p>
+    Module function to get information for the given source id.
+</p><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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial