Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarksImporters.BookmarksImporter.html
eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarksImporters.BookmarksImporter.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.BookmarksImporter</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.BookmarksImporter</h1> | |
| 23 <p> | |
| 24 Module implementing a base class for the bookmarks importers. | |
| 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> | |
| 33 <td><a href="#BookmarksImporter">BookmarksImporter</a></td> | |
| 34 <td>Class implementing the base class for the bookmarks importers.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="BookmarksImporter" ID="BookmarksImporter"></a> | |
| 43 <h2>BookmarksImporter</h2> | |
| 44 <p> | |
| 45 Class implementing the base class for the bookmarks importers. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#BookmarksImporter.__init__">BookmarksImporter</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#BookmarksImporter.error">error</a></td> | |
| 64 <td>Public method to check for an error.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#BookmarksImporter.errorString">errorString</a></td> | |
| 67 <td>Public method to get the error description.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#BookmarksImporter.importedBookmarks">importedBookmarks</a></td> | |
| 70 <td>Public method to get the imported bookmarks.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#BookmarksImporter.open">open</a></td> | |
| 73 <td>Public method to open the bookmarks file.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#BookmarksImporter.setPath">setPath</a></td> | |
| 76 <td>Public method to set the path of the bookmarks file or directory.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <h3>Static Methods</h3> | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 <a NAME="BookmarksImporter.__init__" ID="BookmarksImporter.__init__"></a> | |
| 84 <h4>BookmarksImporter (Constructor)</h4> | |
| 85 <b>BookmarksImporter</b>(<i>sourceId="", parent=None</i>) | |
| 86 <p> | |
| 87 Constructor | |
| 88 </p><dl> | |
| 89 <dt><i>sourceId</i></dt> | |
| 90 <dd> | |
| 91 source ID (string) | |
| 92 </dd><dt><i>parent</i></dt> | |
| 93 <dd> | |
| 94 reference to the parent object (QObject) | |
| 95 </dd> | |
| 96 </dl><a NAME="BookmarksImporter.error" ID="BookmarksImporter.error"></a> | |
| 97 <h4>BookmarksImporter.error</h4> | |
| 98 <b>error</b>(<i></i>) | |
| 99 <p> | |
| 100 Public method to check for an error. | |
| 101 </p><dl> | |
| 102 <dt>Returns:</dt> | |
| 103 <dd> | |
| 104 flag indicating an error (boolean) | |
| 105 </dd> | |
| 106 </dl><a NAME="BookmarksImporter.errorString" ID="BookmarksImporter.errorString"></a> | |
| 107 <h4>BookmarksImporter.errorString</h4> | |
| 108 <b>errorString</b>(<i></i>) | |
| 109 <p> | |
| 110 Public method to get the error description. | |
| 111 </p><dl> | |
| 112 <dt>Returns:</dt> | |
| 113 <dd> | |
| 114 error description (string) | |
| 115 </dd> | |
| 116 </dl><a NAME="BookmarksImporter.importedBookmarks" ID="BookmarksImporter.importedBookmarks"></a> | |
| 117 <h4>BookmarksImporter.importedBookmarks</h4> | |
| 118 <b>importedBookmarks</b>(<i></i>) | |
| 119 <p> | |
| 120 Public method to get the imported bookmarks. | |
| 121 </p><p> | |
| 122 It must return the imported bookmarks (BookmarkNode). | |
| 123 </p><dl> | |
| 124 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 125 <dd> | |
| 126 raised to indicate this method must | |
| 127 be implemented by a subclass | |
| 128 </dd> | |
| 129 </dl><a NAME="BookmarksImporter.open" ID="BookmarksImporter.open"></a> | |
| 130 <h4>BookmarksImporter.open</h4> | |
| 131 <b>open</b>(<i></i>) | |
| 132 <p> | |
| 133 Public method to open the bookmarks file. | |
| 134 </p><p> | |
| 135 It must return a flag indicating success (boolean). | |
| 136 </p><dl> | |
| 137 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 138 <dd> | |
| 139 raised to indicate this method must | |
| 140 be implemented by a subclass | |
| 141 </dd> | |
| 142 </dl><a NAME="BookmarksImporter.setPath" ID="BookmarksImporter.setPath"></a> | |
| 143 <h4>BookmarksImporter.setPath</h4> | |
| 144 <b>setPath</b>(<i>path</i>) | |
| 145 <p> | |
| 146 Public method to set the path of the bookmarks file or directory. | |
| 147 </p><dl> | |
| 148 <dt><i>path</i></dt> | |
| 149 <dd> | |
| 150 bookmarks file or directory (string) | |
| 151 </dd> | |
| 152 </dl><dl> | |
| 153 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 154 <dd> | |
| 155 raised to indicate this method must | |
| 156 be implemented by a subclass | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <div align="right"><a href="#top">Up</a></div> | |
| 160 <hr /> | |
| 161 </body></html> |
