Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.SafariImporter.html
Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.SafariImporter.html
- changeset 1720
- 201622cf8a01
- child 2367
- 78f6c8193d37
equal
deleted
inserted
replaced
| 1719:c65aefefa2ff | 1720:201622cf8a01 |
|---|---|
| 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.SafariImporter</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.SafariImporter</h1> | |
| 24 <p> | |
| 25 Module implementing an importer for Apple Safari bookmarks. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#SafariImporter">SafariImporter</a></td> | |
| 35 <td>Class implementing the Apple Safari 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 source id.</td> | |
| 43 </tr> | |
| 44 </table> | |
| 45 <hr /><hr /> | |
| 46 <a NAME="SafariImporter" ID="SafariImporter"></a> | |
| 47 <h2>SafariImporter</h2> | |
| 48 <p> | |
| 49 Class implementing the Apple Safari 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="#SafariImporter.__init__">SafariImporter</a></td> | |
| 65 <td>Constructor</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#SafariImporter.__processChildren">__processChildren</a></td> | |
| 68 <td>Private method to process the list of children.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#SafariImporter.importedBookmarks">importedBookmarks</a></td> | |
| 71 <td>Public method to get the imported bookmarks.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#SafariImporter.open">open</a></td> | |
| 74 <td>Public method to open the bookmarks file.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#SafariImporter.setPath">setPath</a></td> | |
| 77 <td>Public method to set the path of the bookmarks file or directory.</td> | |
| 78 </tr> | |
| 79 </table> | |
| 80 <h3>Static Methods</h3> | |
| 81 <table> | |
| 82 <tr><td>None</td></tr> | |
| 83 </table> | |
| 84 <a NAME="SafariImporter.__init__" ID="SafariImporter.__init__"></a> | |
| 85 <h4>SafariImporter (Constructor)</h4> | |
| 86 <b>SafariImporter</b>(<i>id="", parent=None</i>) | |
| 87 <p> | |
| 88 Constructor | |
| 89 </p><dl> | |
| 90 <dt><i>id</i></dt> | |
| 91 <dd> | |
| 92 source ID (string) | |
| 93 </dd><dt><i>parent</i></dt> | |
| 94 <dd> | |
| 95 reference to the parent object (QObject) | |
| 96 </dd> | |
| 97 </dl><a NAME="SafariImporter.__processChildren" ID="SafariImporter.__processChildren"></a> | |
| 98 <h4>SafariImporter.__processChildren</h4> | |
| 99 <b>__processChildren</b>(<i>children, rootNode</i>) | |
| 100 <p> | |
| 101 Private method to process the list of children. | |
| 102 </p><dl> | |
| 103 <dt><i>children</i></dt> | |
| 104 <dd> | |
| 105 list of child nodes to be processed (list of dict) | |
| 106 </dd><dt><i>rootNode</i></dt> | |
| 107 <dd> | |
| 108 node to add the bookmarks to (BookmarkNode) | |
| 109 </dd> | |
| 110 </dl><a NAME="SafariImporter.importedBookmarks" ID="SafariImporter.importedBookmarks"></a> | |
| 111 <h4>SafariImporter.importedBookmarks</h4> | |
| 112 <b>importedBookmarks</b>(<i></i>) | |
| 113 <p> | |
| 114 Public method to get the imported bookmarks. | |
| 115 </p><dl> | |
| 116 <dt>Returns:</dt> | |
| 117 <dd> | |
| 118 imported bookmarks (BookmarkNode) | |
| 119 </dd> | |
| 120 </dl><a NAME="SafariImporter.open" ID="SafariImporter.open"></a> | |
| 121 <h4>SafariImporter.open</h4> | |
| 122 <b>open</b>(<i></i>) | |
| 123 <p> | |
| 124 Public method to open the bookmarks file. | |
| 125 </p><dl> | |
| 126 <dt>Returns:</dt> | |
| 127 <dd> | |
| 128 flag indicating success (boolean) | |
| 129 </dd> | |
| 130 </dl><a NAME="SafariImporter.setPath" ID="SafariImporter.setPath"></a> | |
| 131 <h4>SafariImporter.setPath</h4> | |
| 132 <b>setPath</b>(<i>path</i>) | |
| 133 <p> | |
| 134 Public method to set the path of the bookmarks file or directory. | |
| 135 </p><dl> | |
| 136 <dt><i>path</i></dt> | |
| 137 <dd> | |
| 138 bookmarks file or directory (string) | |
| 139 </dd> | |
| 140 </dl> | |
| 141 <div align="right"><a href="#top">Up</a></div> | |
| 142 <hr /><hr /> | |
| 143 <a NAME="getImporterInfo" ID="getImporterInfo"></a> | |
| 144 <h2>getImporterInfo</h2> | |
| 145 <b>getImporterInfo</b>(<i>id</i>) | |
| 146 <p> | |
| 147 Module function to get information for the given source id. | |
| 148 </p><dl> | |
| 149 <dt>Returns:</dt> | |
| 150 <dd> | |
| 151 tuple with an icon (QPixmap), readable name (string), name of | |
| 152 the default bookmarks file (string), an info text (string), | |
| 153 a prompt (string) and the default directory of the bookmarks file (string) | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <div align="right"><a href="#top">Up</a></div> | |
| 157 <hr /> | |
| 158 </body></html> |
