Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImporters.ChromeImporter.html
src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImporters.ChromeImporter.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.ChromeImporter</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.ChromeImporter</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing an importer for Chrome bookmarks. | |
| 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="#ChromeImporter">ChromeImporter</a></td> | |
| 25 <td>Class implementing the Chrome 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 source id.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="ChromeImporter" ID="ChromeImporter"></a> | |
| 40 <h2>ChromeImporter</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing the Chrome 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="#ChromeImporter.__init__">ChromeImporter</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#ChromeImporter.__generateFolderNode">__generateFolderNode</a></td> | |
| 67 <td>Private method to process a bookmarks folder.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#ChromeImporter.__generateUrlNode">__generateUrlNode</a></td> | |
| 71 <td>Private method to process a bookmarks node.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#ChromeImporter.__processRoots">__processRoots</a></td> | |
| 75 <td>Private method to process the bookmark roots.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#ChromeImporter.importedBookmarks">importedBookmarks</a></td> | |
| 79 <td>Public method to get the imported bookmarks.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#ChromeImporter.open">open</a></td> | |
| 83 <td>Public method to open the bookmarks file.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#ChromeImporter.setPath">setPath</a></td> | |
| 87 <td>Public method to set the path of the bookmarks file or directory.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <h3>Static Methods</h3> | |
| 91 | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 | |
| 96 <a NAME="ChromeImporter.__init__" ID="ChromeImporter.__init__"></a> | |
| 97 <h4>ChromeImporter (Constructor)</h4> | |
| 98 <b>ChromeImporter</b>(<i>sourceId="", parent=None</i>) | |
| 99 | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p> | |
| 103 <dl> | |
| 104 | |
| 105 <dt><i>sourceId</i></dt> | |
| 106 <dd> | |
| 107 source ID (string) | |
| 108 </dd> | |
| 109 <dt><i>parent</i></dt> | |
| 110 <dd> | |
| 111 reference to the parent object (QObject) | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <a NAME="ChromeImporter.__generateFolderNode" ID="ChromeImporter.__generateFolderNode"></a> | |
| 115 <h4>ChromeImporter.__generateFolderNode</h4> | |
| 116 <b>__generateFolderNode</b>(<i>data, rootNode</i>) | |
| 117 | |
| 118 <p> | |
| 119 Private method to process a bookmarks folder. | |
| 120 </p> | |
| 121 <dl> | |
| 122 | |
| 123 <dt><i>data</i></dt> | |
| 124 <dd> | |
| 125 dictionary with the bookmarks data (dict) | |
| 126 </dd> | |
| 127 <dt><i>rootNode</i></dt> | |
| 128 <dd> | |
| 129 node to add the bookmarks to (BookmarkNode) | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <a NAME="ChromeImporter.__generateUrlNode" ID="ChromeImporter.__generateUrlNode"></a> | |
| 133 <h4>ChromeImporter.__generateUrlNode</h4> | |
| 134 <b>__generateUrlNode</b>(<i>data, rootNode</i>) | |
| 135 | |
| 136 <p> | |
| 137 Private method to process a bookmarks node. | |
| 138 </p> | |
| 139 <dl> | |
| 140 | |
| 141 <dt><i>data</i></dt> | |
| 142 <dd> | |
| 143 dictionary with the bookmarks data (dict) | |
| 144 </dd> | |
| 145 <dt><i>rootNode</i></dt> | |
| 146 <dd> | |
| 147 node to add the bookmarks to (BookmarkNode) | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <a NAME="ChromeImporter.__processRoots" ID="ChromeImporter.__processRoots"></a> | |
| 151 <h4>ChromeImporter.__processRoots</h4> | |
| 152 <b>__processRoots</b>(<i>data, rootNode</i>) | |
| 153 | |
| 154 <p> | |
| 155 Private method to process the bookmark roots. | |
| 156 </p> | |
| 157 <dl> | |
| 158 | |
| 159 <dt><i>data</i></dt> | |
| 160 <dd> | |
| 161 dictionary with the bookmarks data (dict) | |
| 162 </dd> | |
| 163 <dt><i>rootNode</i></dt> | |
| 164 <dd> | |
| 165 node to add the bookmarks to (BookmarkNode) | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <a NAME="ChromeImporter.importedBookmarks" ID="ChromeImporter.importedBookmarks"></a> | |
| 169 <h4>ChromeImporter.importedBookmarks</h4> | |
| 170 <b>importedBookmarks</b>(<i></i>) | |
| 171 | |
| 172 <p> | |
| 173 Public method to get the imported bookmarks. | |
| 174 </p> | |
| 175 <dl> | |
| 176 <dt>Return:</dt> | |
| 177 <dd> | |
| 178 imported bookmarks (BookmarkNode) | |
| 179 </dd> | |
| 180 </dl> | |
| 181 <a NAME="ChromeImporter.open" ID="ChromeImporter.open"></a> | |
| 182 <h4>ChromeImporter.open</h4> | |
| 183 <b>open</b>(<i></i>) | |
| 184 | |
| 185 <p> | |
| 186 Public method to open the bookmarks file. | |
| 187 </p> | |
| 188 <dl> | |
| 189 <dt>Return:</dt> | |
| 190 <dd> | |
| 191 flag indicating success (boolean) | |
| 192 </dd> | |
| 193 </dl> | |
| 194 <a NAME="ChromeImporter.setPath" ID="ChromeImporter.setPath"></a> | |
| 195 <h4>ChromeImporter.setPath</h4> | |
| 196 <b>setPath</b>(<i>path</i>) | |
| 197 | |
| 198 <p> | |
| 199 Public method to set the path of the bookmarks file or directory. | |
| 200 </p> | |
| 201 <dl> | |
| 202 | |
| 203 <dt><i>path</i></dt> | |
| 204 <dd> | |
| 205 bookmarks file or directory (string) | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <div align="right"><a href="#top">Up</a></div> | |
| 209 <hr /> | |
| 210 <hr /> | |
| 211 <a NAME="getImporterInfo" ID="getImporterInfo"></a> | |
| 212 <h2>getImporterInfo</h2> | |
| 213 <b>getImporterInfo</b>(<i>sourceId</i>) | |
| 214 | |
| 215 <p> | |
| 216 Module function to get information for the given source id. | |
| 217 </p> | |
| 218 <dl> | |
| 219 | |
| 220 <dt><i>sourceId</i></dt> | |
| 221 <dd> | |
| 222 id of the browser ("chrome" or "chromium") | |
| 223 </dd> | |
| 224 </dl> | |
| 225 <dl> | |
| 226 <dt>Return:</dt> | |
| 227 <dd> | |
| 228 tuple with an icon (QPixmap), readable name (string), name of | |
| 229 the default bookmarks file (string), an info text (string), | |
| 230 a prompt (string) and the default directory of the bookmarks file | |
| 231 (string) | |
| 232 </dd> | |
| 233 </dl> | |
| 234 <dl> | |
| 235 | |
| 236 <dt>Raises <b>ValueError</b>:</dt> | |
| 237 <dd> | |
| 238 raised to indicate an invalid browser ID | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <div align="right"><a href="#top">Up</a></div> | |
| 242 <hr /> | |
| 243 </body></html> |
