Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImporters.HtmlImporter.html
src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImporters.HtmlImporter.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9503
- ae9232bf4854
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.Bookmarks.BookmarksImporters.HtmlImporter</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.WebBrowser.Bookmarks.BookmarksImporters.HtmlImporter</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing an importer for HTML bookmark files. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#HtmlImporter">HtmlImporter</a></td> | |
| 25 <td>Class implementing the HTML bookmarks importer.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#getImporterInfo">getImporterInfo</a></td> | |
| 34 <td>Module function to get information for the given HTML source id.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="HtmlImporter" ID="HtmlImporter"></a> | |
| 40 <h2>HtmlImporter</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing the HTML bookmarks importer. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 BookmarksImporter | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#HtmlImporter.__init__">HtmlImporter</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#HtmlImporter.importedBookmarks">importedBookmarks</a></td> | |
| 67 <td>Public method to get the imported bookmarks.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#HtmlImporter.open">open</a></td> | |
| 71 <td>Public method to open the bookmarks file.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#HtmlImporter.setPath">setPath</a></td> | |
| 75 <td>Public method to set the path of the bookmarks file or directory.</td> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <h3>Static Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 | |
| 84 <a NAME="HtmlImporter.__init__" ID="HtmlImporter.__init__"></a> | |
| 85 <h4>HtmlImporter (Constructor)</h4> | |
| 86 <b>HtmlImporter</b>(<i>sourceId="", parent=None</i>) | |
| 87 | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p> | |
| 91 <dl> | |
| 92 | |
| 93 <dt><i>sourceId</i></dt> | |
| 94 <dd> | |
| 95 source ID (string) | |
| 96 </dd> | |
| 97 <dt><i>parent</i></dt> | |
| 98 <dd> | |
| 99 reference to the parent object (QObject) | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <a NAME="HtmlImporter.importedBookmarks" ID="HtmlImporter.importedBookmarks"></a> | |
| 103 <h4>HtmlImporter.importedBookmarks</h4> | |
| 104 <b>importedBookmarks</b>(<i></i>) | |
| 105 | |
| 106 <p> | |
| 107 Public method to get the imported bookmarks. | |
| 108 </p> | |
| 109 <dl> | |
| 110 <dt>Return:</dt> | |
| 111 <dd> | |
| 112 imported bookmarks (BookmarkNode) | |
| 113 </dd> | |
| 114 </dl> | |
| 115 <a NAME="HtmlImporter.open" ID="HtmlImporter.open"></a> | |
| 116 <h4>HtmlImporter.open</h4> | |
| 117 <b>open</b>(<i></i>) | |
| 118 | |
| 119 <p> | |
| 120 Public method to open the bookmarks file. | |
| 121 </p> | |
| 122 <dl> | |
| 123 <dt>Return:</dt> | |
| 124 <dd> | |
| 125 flag indicating success (boolean) | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <a NAME="HtmlImporter.setPath" ID="HtmlImporter.setPath"></a> | |
| 129 <h4>HtmlImporter.setPath</h4> | |
| 130 <b>setPath</b>(<i>path</i>) | |
| 131 | |
| 132 <p> | |
| 133 Public method to set the path of the bookmarks file or directory. | |
| 134 </p> | |
| 135 <dl> | |
| 136 | |
| 137 <dt><i>path</i></dt> | |
| 138 <dd> | |
| 139 bookmarks file or directory (string) | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <div align="right"><a href="#top">Up</a></div> | |
| 143 <hr /> | |
| 144 <hr /> | |
| 145 <a NAME="getImporterInfo" ID="getImporterInfo"></a> | |
| 146 <h2>getImporterInfo</h2> | |
| 147 <b>getImporterInfo</b>(<i>sourceId</i>) | |
| 148 | |
| 149 <p> | |
| 150 Module function to get information for the given HTML source id. | |
| 151 </p> | |
| 152 <dl> | |
| 153 | |
| 154 <dt><i>sourceId</i></dt> | |
| 155 <dd> | |
| 156 id of the browser ("chrome" or "chromium") | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <dl> | |
| 160 <dt>Return:</dt> | |
| 161 <dd> | |
| 162 tuple with an icon (QPixmap), readable name (string), name of | |
| 163 the default bookmarks file (string), an info text (string), | |
| 164 a prompt (string) and the default directory of the bookmarks file | |
| 165 (string) | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <dl> | |
| 169 | |
| 170 <dt>Raises <b>ValueError</b>:</dt> | |
| 171 <dd> | |
| 172 raised to indicate an invalid browser ID | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <div align="right"><a href="#top">Up</a></div> | |
| 176 <hr /> | |
| 177 </body></html> |
