Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.BookmarksImporter.html
Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksImporters.BookmarksImporter.html
- changeset 1713
- 56fdde8a2441
- child 2367
- 78f6c8193d37
equal
deleted
inserted
replaced
| 1709:62fb6a42cd7c | 1713:56fdde8a2441 |
|---|---|
| 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.BookmarksImporter</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.BookmarksImporter</h1> | |
| 24 <p> | |
| 25 Module implementing a base class for the bookmarks importers. | |
| 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="#BookmarksImporter">BookmarksImporter</a></td> | |
| 35 <td>Class implementing the base class for the bookmarks importers.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="BookmarksImporter" ID="BookmarksImporter"></a> | |
| 44 <h2>BookmarksImporter</h2> | |
| 45 <p> | |
| 46 Class implementing the base class for the bookmarks importers. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QObject | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Class Methods</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 <table> | |
| 60 <tr> | |
| 61 <td><a href="#BookmarksImporter.__init__">BookmarksImporter</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#BookmarksImporter.error">error</a></td> | |
| 65 <td>Public method to check for an error.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#BookmarksImporter.errorString">errorString</a></td> | |
| 68 <td>Public method to get the error description.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#BookmarksImporter.importedBookmarks">importedBookmarks</a></td> | |
| 71 <td>Public method to get the imported bookmarks.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#BookmarksImporter.open">open</a></td> | |
| 74 <td>Public method to open the bookmarks file.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#BookmarksImporter.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="BookmarksImporter.__init__" ID="BookmarksImporter.__init__"></a> | |
| 85 <h4>BookmarksImporter (Constructor)</h4> | |
| 86 <b>BookmarksImporter</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="BookmarksImporter.error" ID="BookmarksImporter.error"></a> | |
| 98 <h4>BookmarksImporter.error</h4> | |
| 99 <b>error</b>(<i></i>) | |
| 100 <p> | |
| 101 Public method to check for an error. | |
| 102 </p><dl> | |
| 103 <dt>Returns:</dt> | |
| 104 <dd> | |
| 105 flag indicating an error (boolean) | |
| 106 </dd> | |
| 107 </dl><a NAME="BookmarksImporter.errorString" ID="BookmarksImporter.errorString"></a> | |
| 108 <h4>BookmarksImporter.errorString</h4> | |
| 109 <b>errorString</b>(<i></i>) | |
| 110 <p> | |
| 111 Public method to get the error description. | |
| 112 </p><dl> | |
| 113 <dt>Returns:</dt> | |
| 114 <dd> | |
| 115 error description (string) | |
| 116 </dd> | |
| 117 </dl><a NAME="BookmarksImporter.importedBookmarks" ID="BookmarksImporter.importedBookmarks"></a> | |
| 118 <h4>BookmarksImporter.importedBookmarks</h4> | |
| 119 <b>importedBookmarks</b>(<i></i>) | |
| 120 <p> | |
| 121 Public method to get the imported bookmarks. | |
| 122 </p><dl> | |
| 123 <dt>Returns:</dt> | |
| 124 <dd> | |
| 125 imported bookmarks (BookmarkNode) | |
| 126 </dd> | |
| 127 </dl><a NAME="BookmarksImporter.open" ID="BookmarksImporter.open"></a> | |
| 128 <h4>BookmarksImporter.open</h4> | |
| 129 <b>open</b>(<i></i>) | |
| 130 <p> | |
| 131 Public method to open the bookmarks file. | |
| 132 </p><dl> | |
| 133 <dt>Returns:</dt> | |
| 134 <dd> | |
| 135 flag indicating success (boolean) | |
| 136 </dd> | |
| 137 </dl><a NAME="BookmarksImporter.setPath" ID="BookmarksImporter.setPath"></a> | |
| 138 <h4>BookmarksImporter.setPath</h4> | |
| 139 <b>setPath</b>(<i>path</i>) | |
| 140 <p> | |
| 141 Public method to set the path of the bookmarks file or directory. | |
| 142 </p><dl> | |
| 143 <dt><i>path</i></dt> | |
| 144 <dd> | |
| 145 bookmarks file or directory (string) | |
| 146 </dd> | |
| 147 </dl> | |
| 148 <div align="right"><a href="#top">Up</a></div> | |
| 149 <hr /> | |
| 150 </body></html> |
