Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.XbelReader.html
src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.XbelReader.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.XbelReader</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.XbelReader</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a class to read XBEL bookmark files. | |
| 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="#XbelReader">XbelReader</a></td> | |
| 25 <td>Class implementing a reader object for XBEL bookmark files.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#XmlEntityResolver">XmlEntityResolver</a></td> | |
| 29 <td>Class implementing an XML entity resolver for bookmark files.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="XbelReader" ID="XbelReader"></a> | |
| 40 <h2>XbelReader</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a reader object for XBEL bookmark files. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 QXmlStreamReader | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#XbelReader.__init__">XbelReader</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#XbelReader.__readBookmarkNode">__readBookmarkNode</a></td> | |
| 67 <td>Private method to read and parse a bookmark subtree.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#XbelReader.__readDescription">__readDescription</a></td> | |
| 71 <td>Private method to read the desc element.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#XbelReader.__readFolder">__readFolder</a></td> | |
| 75 <td>Private method to read and parse a folder subtree.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#XbelReader.__readInfo">__readInfo</a></td> | |
| 79 <td>Private method to read and parse an info subtree.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#XbelReader.__readSeparator">__readSeparator</a></td> | |
| 83 <td>Private method to read a separator element.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#XbelReader.__readTitle">__readTitle</a></td> | |
| 87 <td>Private method to read the title element.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#XbelReader.__readXBEL">__readXBEL</a></td> | |
| 91 <td>Private method to read and parse the XBEL file.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#XbelReader.__skipUnknownElement">__skipUnknownElement</a></td> | |
| 95 <td>Private method to skip over all unknown elements.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#XbelReader.read">read</a></td> | |
| 99 <td>Public method to read an XBEL bookmark file.</td> | |
| 100 </tr> | |
| 101 </table> | |
| 102 <h3>Static Methods</h3> | |
| 103 | |
| 104 <table> | |
| 105 <tr><td>None</td></tr> | |
| 106 </table> | |
| 107 | |
| 108 <a NAME="XbelReader.__init__" ID="XbelReader.__init__"></a> | |
| 109 <h4>XbelReader (Constructor)</h4> | |
| 110 <b>XbelReader</b>(<i></i>) | |
| 111 | |
| 112 <p> | |
| 113 Constructor | |
| 114 </p> | |
| 115 <a NAME="XbelReader.__readBookmarkNode" ID="XbelReader.__readBookmarkNode"></a> | |
| 116 <h4>XbelReader.__readBookmarkNode</h4> | |
| 117 <b>__readBookmarkNode</b>(<i>node</i>) | |
| 118 | |
| 119 <p> | |
| 120 Private method to read and parse a bookmark subtree. | |
| 121 </p> | |
| 122 <dl> | |
| 123 | |
| 124 <dt><i>node</i></dt> | |
| 125 <dd> | |
| 126 reference to the node to attach to (BookmarkNode) | |
| 127 </dd> | |
| 128 </dl> | |
| 129 <a NAME="XbelReader.__readDescription" ID="XbelReader.__readDescription"></a> | |
| 130 <h4>XbelReader.__readDescription</h4> | |
| 131 <b>__readDescription</b>(<i>node</i>) | |
| 132 | |
| 133 <p> | |
| 134 Private method to read the desc element. | |
| 135 </p> | |
| 136 <dl> | |
| 137 | |
| 138 <dt><i>node</i></dt> | |
| 139 <dd> | |
| 140 reference to the bookmark node desc belongs to | |
| 141 (BookmarkNode) | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <a NAME="XbelReader.__readFolder" ID="XbelReader.__readFolder"></a> | |
| 145 <h4>XbelReader.__readFolder</h4> | |
| 146 <b>__readFolder</b>(<i>node</i>) | |
| 147 | |
| 148 <p> | |
| 149 Private method to read and parse a folder subtree. | |
| 150 </p> | |
| 151 <dl> | |
| 152 | |
| 153 <dt><i>node</i></dt> | |
| 154 <dd> | |
| 155 reference to the node to attach to (BookmarkNode) | |
| 156 </dd> | |
| 157 </dl> | |
| 158 <a NAME="XbelReader.__readInfo" ID="XbelReader.__readInfo"></a> | |
| 159 <h4>XbelReader.__readInfo</h4> | |
| 160 <b>__readInfo</b>(<i></i>) | |
| 161 | |
| 162 <p> | |
| 163 Private method to read and parse an info subtree. | |
| 164 </p> | |
| 165 <a NAME="XbelReader.__readSeparator" ID="XbelReader.__readSeparator"></a> | |
| 166 <h4>XbelReader.__readSeparator</h4> | |
| 167 <b>__readSeparator</b>(<i>node</i>) | |
| 168 | |
| 169 <p> | |
| 170 Private method to read a separator element. | |
| 171 </p> | |
| 172 <dl> | |
| 173 | |
| 174 <dt><i>node</i></dt> | |
| 175 <dd> | |
| 176 reference to the bookmark node the separator belongs to | |
| 177 (BookmarkNode) | |
| 178 </dd> | |
| 179 </dl> | |
| 180 <a NAME="XbelReader.__readTitle" ID="XbelReader.__readTitle"></a> | |
| 181 <h4>XbelReader.__readTitle</h4> | |
| 182 <b>__readTitle</b>(<i>node</i>) | |
| 183 | |
| 184 <p> | |
| 185 Private method to read the title element. | |
| 186 </p> | |
| 187 <dl> | |
| 188 | |
| 189 <dt><i>node</i></dt> | |
| 190 <dd> | |
| 191 reference to the bookmark node title belongs to | |
| 192 (BookmarkNode) | |
| 193 </dd> | |
| 194 </dl> | |
| 195 <a NAME="XbelReader.__readXBEL" ID="XbelReader.__readXBEL"></a> | |
| 196 <h4>XbelReader.__readXBEL</h4> | |
| 197 <b>__readXBEL</b>(<i>node</i>) | |
| 198 | |
| 199 <p> | |
| 200 Private method to read and parse the XBEL file. | |
| 201 </p> | |
| 202 <dl> | |
| 203 | |
| 204 <dt><i>node</i></dt> | |
| 205 <dd> | |
| 206 reference to the node to attach to (BookmarkNode) | |
| 207 </dd> | |
| 208 </dl> | |
| 209 <a NAME="XbelReader.__skipUnknownElement" ID="XbelReader.__skipUnknownElement"></a> | |
| 210 <h4>XbelReader.__skipUnknownElement</h4> | |
| 211 <b>__skipUnknownElement</b>(<i></i>) | |
| 212 | |
| 213 <p> | |
| 214 Private method to skip over all unknown elements. | |
| 215 </p> | |
| 216 <a NAME="XbelReader.read" ID="XbelReader.read"></a> | |
| 217 <h4>XbelReader.read</h4> | |
| 218 <b>read</b>(<i>fileNameOrDevice</i>) | |
| 219 | |
| 220 <p> | |
| 221 Public method to read an XBEL bookmark file. | |
| 222 </p> | |
| 223 <dl> | |
| 224 | |
| 225 <dt><i>fileNameOrDevice</i></dt> | |
| 226 <dd> | |
| 227 name of the file to read (string) | |
| 228 or reference to the device to read (QIODevice) | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <dl> | |
| 232 <dt>Return:</dt> | |
| 233 <dd> | |
| 234 reference to the root node (BookmarkNode) | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <div align="right"><a href="#top">Up</a></div> | |
| 238 <hr /> | |
| 239 <hr /> | |
| 240 <a NAME="XmlEntityResolver" ID="XmlEntityResolver"></a> | |
| 241 <h2>XmlEntityResolver</h2> | |
| 242 | |
| 243 <p> | |
| 244 Class implementing an XML entity resolver for bookmark files. | |
| 245 </p> | |
| 246 <h3>Derived from</h3> | |
| 247 QXmlStreamEntityResolver | |
| 248 <h3>Class Attributes</h3> | |
| 249 | |
| 250 <table> | |
| 251 <tr><td>None</td></tr> | |
| 252 </table> | |
| 253 <h3>Class Methods</h3> | |
| 254 | |
| 255 <table> | |
| 256 <tr><td>None</td></tr> | |
| 257 </table> | |
| 258 <h3>Methods</h3> | |
| 259 | |
| 260 <table> | |
| 261 | |
| 262 <tr> | |
| 263 <td><a href="#XmlEntityResolver.resolveUndeclaredEntity">resolveUndeclaredEntity</a></td> | |
| 264 <td>Public method to resolve undeclared entities.</td> | |
| 265 </tr> | |
| 266 </table> | |
| 267 <h3>Static Methods</h3> | |
| 268 | |
| 269 <table> | |
| 270 <tr><td>None</td></tr> | |
| 271 </table> | |
| 272 | |
| 273 <a NAME="XmlEntityResolver.resolveUndeclaredEntity" ID="XmlEntityResolver.resolveUndeclaredEntity"></a> | |
| 274 <h4>XmlEntityResolver.resolveUndeclaredEntity</h4> | |
| 275 <b>resolveUndeclaredEntity</b>(<i>entity</i>) | |
| 276 | |
| 277 <p> | |
| 278 Public method to resolve undeclared entities. | |
| 279 </p> | |
| 280 <dl> | |
| 281 | |
| 282 <dt><i>entity</i></dt> | |
| 283 <dd> | |
| 284 entity to be resolved (string) | |
| 285 </dd> | |
| 286 </dl> | |
| 287 <dl> | |
| 288 <dt>Return:</dt> | |
| 289 <dd> | |
| 290 resolved entity (string) | |
| 291 </dd> | |
| 292 </dl> | |
| 293 <div align="right"><a href="#top">Up</a></div> | |
| 294 <hr /> | |
| 295 </body></html> |
