Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarksImporters.__init__.html
eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarksImporters.__init__.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.Bookmarks.BookmarksImporters.__init__</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Helpviewer.Bookmarks.BookmarksImporters.__init__</h1> | |
| 23 <p> | |
| 24 Package implementing bookmarks importers for various sources. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Functions</h3> | |
| 35 <table> | |
| 36 <tr> | |
| 37 <td><a href="#getImporter">getImporter</a></td> | |
| 38 <td>Module function to get an importer for the given source id.</td> | |
| 39 </tr><tr> | |
| 40 <td><a href="#getImporterInfo">getImporterInfo</a></td> | |
| 41 <td>Module function to get information for the given source id.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#getImporters">getImporters</a></td> | |
| 44 <td>Module function to get a list of supported importers.</td> | |
| 45 </tr> | |
| 46 </table> | |
| 47 <hr /><hr /> | |
| 48 <a NAME="getImporter" ID="getImporter"></a> | |
| 49 <h2>getImporter</h2> | |
| 50 <b>getImporter</b>(<i>sourceId, parent=None</i>) | |
| 51 <p> | |
| 52 Module function to get an importer for the given source id. | |
| 53 </p><dl> | |
| 54 <dt><i>sourceId</i></dt> | |
| 55 <dd> | |
| 56 source id to get an importer for (string) | |
| 57 </dd><dt><i>parent</i></dt> | |
| 58 <dd> | |
| 59 reference to the parent object (QObject) | |
| 60 </dd> | |
| 61 </dl><dl> | |
| 62 <dt>Returns:</dt> | |
| 63 <dd> | |
| 64 bookmarks importer (BookmarksImporter) | |
| 65 </dd> | |
| 66 </dl><dl> | |
| 67 <dt>Raises <b>ValueError</b>:</dt> | |
| 68 <dd> | |
| 69 raised to indicate an unsupported importer | |
| 70 </dd> | |
| 71 </dl> | |
| 72 <div align="right"><a href="#top">Up</a></div> | |
| 73 <hr /><hr /> | |
| 74 <a NAME="getImporterInfo" ID="getImporterInfo"></a> | |
| 75 <h2>getImporterInfo</h2> | |
| 76 <b>getImporterInfo</b>(<i>sourceId</i>) | |
| 77 <p> | |
| 78 Module function to get information for the given source id. | |
| 79 </p><dl> | |
| 80 <dt><i>sourceId</i></dt> | |
| 81 <dd> | |
| 82 source id to get info for (string) | |
| 83 </dd> | |
| 84 </dl><dl> | |
| 85 <dt>Returns:</dt> | |
| 86 <dd> | |
| 87 tuple with an icon (QPixmap), readable name (string), name of | |
| 88 the default bookmarks file (string), an info text (string), | |
| 89 a prompt (string) and the default directory of the bookmarks | |
| 90 file (string) | |
| 91 </dd> | |
| 92 </dl><dl> | |
| 93 <dt>Raises <b>ValueError</b>:</dt> | |
| 94 <dd> | |
| 95 raised to indicate an unsupported importer | |
| 96 </dd> | |
| 97 </dl> | |
| 98 <div align="right"><a href="#top">Up</a></div> | |
| 99 <hr /><hr /> | |
| 100 <a NAME="getImporters" ID="getImporters"></a> | |
| 101 <h2>getImporters</h2> | |
| 102 <b>getImporters</b>(<i></i>) | |
| 103 <p> | |
| 104 Module function to get a list of supported importers. | |
| 105 </p><dl> | |
| 106 <dt>Returns:</dt> | |
| 107 <dd> | |
| 108 list of tuples with an icon (QIcon), readable name (string) and | |
| 109 internal name (string) | |
| 110 </dd> | |
| 111 </dl> | |
| 112 <div align="right"><a href="#top">Up</a></div> | |
| 113 <hr /> | |
| 114 </body></html> |
