Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImporters.__init__.html
src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImporters.__init__.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.__init__</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.__init__</h1> | |
| 10 | |
| 11 <p> | |
| 12 Package implementing bookmarks importers for various sources. | |
| 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 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#getImporter">getImporter</a></td> | |
| 30 <td>Module function to get an importer for the given source id.</td> | |
| 31 </tr> | |
| 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 <tr> | |
| 37 <td><a href="#getImporters">getImporters</a></td> | |
| 38 <td>Module function to get a list of supported importers.</td> | |
| 39 </tr> | |
| 40 </table> | |
| 41 <hr /> | |
| 42 <hr /> | |
| 43 <a NAME="getImporter" ID="getImporter"></a> | |
| 44 <h2>getImporter</h2> | |
| 45 <b>getImporter</b>(<i>sourceId, parent=None</i>) | |
| 46 | |
| 47 <p> | |
| 48 Module function to get an importer for the given source id. | |
| 49 </p> | |
| 50 <dl> | |
| 51 | |
| 52 <dt><i>sourceId</i></dt> | |
| 53 <dd> | |
| 54 source id to get an importer for (string) | |
| 55 </dd> | |
| 56 <dt><i>parent</i></dt> | |
| 57 <dd> | |
| 58 reference to the parent object (QObject) | |
| 59 </dd> | |
| 60 </dl> | |
| 61 <dl> | |
| 62 <dt>Return:</dt> | |
| 63 <dd> | |
| 64 bookmarks importer (BookmarksImporter) | |
| 65 </dd> | |
| 66 </dl> | |
| 67 <dl> | |
| 68 | |
| 69 <dt>Raises <b>ValueError</b>:</dt> | |
| 70 <dd> | |
| 71 raised to indicate an unsupported importer | |
| 72 </dd> | |
| 73 </dl> | |
| 74 <div align="right"><a href="#top">Up</a></div> | |
| 75 <hr /> | |
| 76 <hr /> | |
| 77 <a NAME="getImporterInfo" ID="getImporterInfo"></a> | |
| 78 <h2>getImporterInfo</h2> | |
| 79 <b>getImporterInfo</b>(<i>sourceId</i>) | |
| 80 | |
| 81 <p> | |
| 82 Module function to get information for the given source id. | |
| 83 </p> | |
| 84 <dl> | |
| 85 | |
| 86 <dt><i>sourceId</i></dt> | |
| 87 <dd> | |
| 88 source id to get info for (string) | |
| 89 </dd> | |
| 90 </dl> | |
| 91 <dl> | |
| 92 <dt>Return:</dt> | |
| 93 <dd> | |
| 94 tuple with an icon (QPixmap), readable name (string), name of | |
| 95 the default bookmarks file (string), an info text (string), | |
| 96 a prompt (string) and the default directory of the bookmarks | |
| 97 file (string) | |
| 98 </dd> | |
| 99 </dl> | |
| 100 <dl> | |
| 101 | |
| 102 <dt>Raises <b>ValueError</b>:</dt> | |
| 103 <dd> | |
| 104 raised to indicate an unsupported importer | |
| 105 </dd> | |
| 106 </dl> | |
| 107 <div align="right"><a href="#top">Up</a></div> | |
| 108 <hr /> | |
| 109 <hr /> | |
| 110 <a NAME="getImporters" ID="getImporters"></a> | |
| 111 <h2>getImporters</h2> | |
| 112 <b>getImporters</b>(<i></i>) | |
| 113 | |
| 114 <p> | |
| 115 Module function to get a list of supported importers. | |
| 116 </p> | |
| 117 <dl> | |
| 118 <dt>Return:</dt> | |
| 119 <dd> | |
| 120 list of tuples with an icon (QIcon), readable name (string) and | |
| 121 internal name (string) | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <div align="right"><a href="#top">Up</a></div> | |
| 125 <hr /> | |
| 126 </body></html> |
