Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.HtmlImporter.html
Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.HtmlImporter.html
- changeset 1713
- 56fdde8a2441
- child 1732
- b140a24e147a
equal
deleted
inserted
replaced
| 1709:62fb6a42cd7c | 1713:56fdde8a2441 |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.Bookmarks.BookmarksImporters.HtmlImporter</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Helpviewer.Bookmarks.BookmarksImporters.HtmlImporter</h1> | |
| 24 <p> | |
| 25 Module implementing an importer for HTML bookmark files. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>extract_js</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#HtmlImporter">HtmlImporter</a></td> | |
| 35 <td>Class implementing the HTML bookmarks importer.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr> | |
| 41 <td><a href="#getImporterInfo">getImporterInfo</a></td> | |
| 42 <td>Module function to get information for the given HTML source id.</td> | |
| 43 </tr> | |
| 44 </table> | |
| 45 <hr /><hr /> | |
| 46 <a NAME="HtmlImporter" ID="HtmlImporter"></a> | |
| 47 <h2>HtmlImporter</h2> | |
| 48 <p> | |
| 49 Class implementing the HTML bookmarks importer. | |
| 50 </p> | |
| 51 <h3>Derived from</h3> | |
| 52 BookmarksImporter | |
| 53 <h3>Class Attributes</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Class Methods</h3> | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 <table> | |
| 63 <tr> | |
| 64 <td><a href="#HtmlImporter.__init__">HtmlImporter</a></td> | |
| 65 <td>Constructor</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#HtmlImporter.importedBookmarks">importedBookmarks</a></td> | |
| 68 <td>Public method to get the imported bookmarks.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#HtmlImporter.open">open</a></td> | |
| 71 <td>Public method to open the bookmarks file.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#HtmlImporter.setPath">setPath</a></td> | |
| 74 <td>Public method to set the path of the bookmarks file or directory.</td> | |
| 75 </tr> | |
| 76 </table> | |
| 77 <h3>Static Methods</h3> | |
| 78 <table> | |
| 79 <tr><td>None</td></tr> | |
| 80 </table> | |
| 81 <a NAME="HtmlImporter.__init__" ID="HtmlImporter.__init__"></a> | |
| 82 <h4>HtmlImporter (Constructor)</h4> | |
| 83 <b>HtmlImporter</b>(<i>id="", parent=None</i>) | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p><dl> | |
| 87 <dt><i>id</i></dt> | |
| 88 <dd> | |
| 89 source ID (string) | |
| 90 </dd><dt><i>parent</i></dt> | |
| 91 <dd> | |
| 92 reference to the parent object (QObject) | |
| 93 </dd> | |
| 94 </dl><a NAME="HtmlImporter.importedBookmarks" ID="HtmlImporter.importedBookmarks"></a> | |
| 95 <h4>HtmlImporter.importedBookmarks</h4> | |
| 96 <b>importedBookmarks</b>(<i></i>) | |
| 97 <p> | |
| 98 Public method to get the imported bookmarks. | |
| 99 </p><dl> | |
| 100 <dt>Returns:</dt> | |
| 101 <dd> | |
| 102 imported bookmarks (BookmarkNode) | |
| 103 </dd> | |
| 104 </dl><a NAME="HtmlImporter.open" ID="HtmlImporter.open"></a> | |
| 105 <h4>HtmlImporter.open</h4> | |
| 106 <b>open</b>(<i></i>) | |
| 107 <p> | |
| 108 Public method to open the bookmarks file. | |
| 109 </p><dl> | |
| 110 <dt>Returns:</dt> | |
| 111 <dd> | |
| 112 flag indicating success (boolean) | |
| 113 </dd> | |
| 114 </dl><a NAME="HtmlImporter.setPath" ID="HtmlImporter.setPath"></a> | |
| 115 <h4>HtmlImporter.setPath</h4> | |
| 116 <b>setPath</b>(<i>path</i>) | |
| 117 <p> | |
| 118 Public method to set the path of the bookmarks file or directory. | |
| 119 </p><dl> | |
| 120 <dt><i>path</i></dt> | |
| 121 <dd> | |
| 122 bookmarks file or directory (string) | |
| 123 </dd> | |
| 124 </dl> | |
| 125 <div align="right"><a href="#top">Up</a></div> | |
| 126 <hr /><hr /> | |
| 127 <a NAME="getImporterInfo" ID="getImporterInfo"></a> | |
| 128 <h2>getImporterInfo</h2> | |
| 129 <b>getImporterInfo</b>(<i>id</i>) | |
| 130 <p> | |
| 131 Module function to get information for the given HTML source id. | |
| 132 </p><dl> | |
| 133 <dt>Returns:</dt> | |
| 134 <dd> | |
| 135 tuple with an icon (QPixmap), readable name (string), name of | |
| 136 the default bookmarks file (string), an info text (string), | |
| 137 a prompt (string) and the default directory of the bookmarks file (string) | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <div align="right"><a href="#top">Up</a></div> | |
| 141 <hr /> | |
| 142 </body></html> |
