Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImporters.BookmarksImporter.html
src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImporters.BookmarksImporter.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10436
- f6881d10e995
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.Bookmarks.BookmarksImporters.BookmarksImporter</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.BookmarksImporter</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a base class for the bookmarks importers. | |
| 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="#BookmarksImporter">BookmarksImporter</a></td> | |
| 25 <td>Class implementing the base class for the bookmarks importers.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="BookmarksImporter" ID="BookmarksImporter"></a> | |
| 36 <h2>BookmarksImporter</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the base class for the bookmarks importers. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QObject | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#BookmarksImporter.__init__">BookmarksImporter</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#BookmarksImporter.error">error</a></td> | |
| 63 <td>Public method to check for an error.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#BookmarksImporter.errorString">errorString</a></td> | |
| 67 <td>Public method to get the error description.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#BookmarksImporter.importedBookmarks">importedBookmarks</a></td> | |
| 71 <td>Public method to get the imported bookmarks.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#BookmarksImporter.open">open</a></td> | |
| 75 <td>Public method to open the bookmarks file.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#BookmarksImporter.setPath">setPath</a></td> | |
| 79 <td>Public method to set the path of the bookmarks file or directory.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 | |
| 84 <table> | |
| 85 <tr><td>None</td></tr> | |
| 86 </table> | |
| 87 | |
| 88 <a NAME="BookmarksImporter.__init__" ID="BookmarksImporter.__init__"></a> | |
| 89 <h4>BookmarksImporter (Constructor)</h4> | |
| 90 <b>BookmarksImporter</b>(<i>sourceId="", parent=None</i>) | |
| 91 | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p> | |
| 95 <dl> | |
| 96 | |
| 97 <dt><i>sourceId</i></dt> | |
| 98 <dd> | |
| 99 source ID (string) | |
| 100 </dd> | |
| 101 <dt><i>parent</i></dt> | |
| 102 <dd> | |
| 103 reference to the parent object (QObject) | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <a NAME="BookmarksImporter.error" ID="BookmarksImporter.error"></a> | |
| 107 <h4>BookmarksImporter.error</h4> | |
| 108 <b>error</b>(<i></i>) | |
| 109 | |
| 110 <p> | |
| 111 Public method to check for an error. | |
| 112 </p> | |
| 113 <dl> | |
| 114 <dt>Return:</dt> | |
| 115 <dd> | |
| 116 flag indicating an error (boolean) | |
| 117 </dd> | |
| 118 </dl> | |
| 119 <a NAME="BookmarksImporter.errorString" ID="BookmarksImporter.errorString"></a> | |
| 120 <h4>BookmarksImporter.errorString</h4> | |
| 121 <b>errorString</b>(<i></i>) | |
| 122 | |
| 123 <p> | |
| 124 Public method to get the error description. | |
| 125 </p> | |
| 126 <dl> | |
| 127 <dt>Return:</dt> | |
| 128 <dd> | |
| 129 error description (string) | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <a NAME="BookmarksImporter.importedBookmarks" ID="BookmarksImporter.importedBookmarks"></a> | |
| 133 <h4>BookmarksImporter.importedBookmarks</h4> | |
| 134 <b>importedBookmarks</b>(<i></i>) | |
| 135 | |
| 136 <p> | |
| 137 Public method to get the imported bookmarks. | |
| 138 </p> | |
| 139 <p> | |
| 140 It must return the imported bookmarks (BookmarkNode). | |
| 141 </p> | |
| 142 <dl> | |
| 143 | |
| 144 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 145 <dd> | |
| 146 raised to indicate this method must | |
| 147 be implemented by a subclass | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <a NAME="BookmarksImporter.open" ID="BookmarksImporter.open"></a> | |
| 151 <h4>BookmarksImporter.open</h4> | |
| 152 <b>open</b>(<i></i>) | |
| 153 | |
| 154 <p> | |
| 155 Public method to open the bookmarks file. | |
| 156 </p> | |
| 157 <p> | |
| 158 It must return a flag indicating success (boolean). | |
| 159 </p> | |
| 160 <dl> | |
| 161 | |
| 162 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 163 <dd> | |
| 164 raised to indicate this method must | |
| 165 be implemented by a subclass | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <a NAME="BookmarksImporter.setPath" ID="BookmarksImporter.setPath"></a> | |
| 169 <h4>BookmarksImporter.setPath</h4> | |
| 170 <b>setPath</b>(<i>path</i>) | |
| 171 | |
| 172 <p> | |
| 173 Public method to set the path of the bookmarks file or directory. | |
| 174 </p> | |
| 175 <dl> | |
| 176 | |
| 177 <dt><i>path</i></dt> | |
| 178 <dd> | |
| 179 bookmarks file or directory (string) | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <dl> | |
| 183 | |
| 184 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 185 <dd> | |
| 186 raised to indicate this method must | |
| 187 be implemented by a subclass | |
| 188 </dd> | |
| 189 </dl> | |
| 190 <div align="right"><a href="#top">Up</a></div> | |
| 191 <hr /> | |
| 192 </body></html> |
