--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.BookmarksImporter.html Sun Mar 18 10:07:28 2012 +0100 @@ -0,0 +1,150 @@ +<?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.BookmarksImporter</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.BookmarksImporter</h1> +<p> +Module implementing a base class for the bookmarks importers. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#BookmarksImporter">BookmarksImporter</a></td> +<td>Class implementing the base class for the bookmarks importers.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="BookmarksImporter" ID="BookmarksImporter"></a> +<h2>BookmarksImporter</h2> +<p> + Class implementing the base class for the bookmarks importers. +</p> +<h3>Derived from</h3> +QObject +<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="#BookmarksImporter.__init__">BookmarksImporter</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#BookmarksImporter.error">error</a></td> +<td>Public method to check for an error.</td> +</tr><tr> +<td><a href="#BookmarksImporter.errorString">errorString</a></td> +<td>Public method to get the error description.</td> +</tr><tr> +<td><a href="#BookmarksImporter.importedBookmarks">importedBookmarks</a></td> +<td>Public method to get the imported bookmarks.</td> +</tr><tr> +<td><a href="#BookmarksImporter.open">open</a></td> +<td>Public method to open the bookmarks file.</td> +</tr><tr> +<td><a href="#BookmarksImporter.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="BookmarksImporter.__init__" ID="BookmarksImporter.__init__"></a> +<h4>BookmarksImporter (Constructor)</h4> +<b>BookmarksImporter</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="BookmarksImporter.error" ID="BookmarksImporter.error"></a> +<h4>BookmarksImporter.error</h4> +<b>error</b>(<i></i>) +<p> + Public method to check for an error. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating an error (boolean) +</dd> +</dl><a NAME="BookmarksImporter.errorString" ID="BookmarksImporter.errorString"></a> +<h4>BookmarksImporter.errorString</h4> +<b>errorString</b>(<i></i>) +<p> + Public method to get the error description. +</p><dl> +<dt>Returns:</dt> +<dd> +error description (string) +</dd> +</dl><a NAME="BookmarksImporter.importedBookmarks" ID="BookmarksImporter.importedBookmarks"></a> +<h4>BookmarksImporter.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="BookmarksImporter.open" ID="BookmarksImporter.open"></a> +<h4>BookmarksImporter.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="BookmarksImporter.setPath" ID="BookmarksImporter.setPath"></a> +<h4>BookmarksImporter.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 /> +</body></html> \ No newline at end of file